Linklyのリンク短縮API

Linklyのリンク短縮APIを使用して、プログラムでリンクを作成、更新、管理します。

関連: Analytics API | Webhooks

開始する前に

Linklyはインターフェース内でAPIリクエストを生成し、アプリケーションにコピー&ペーストできるようにします。

これはリンク作成とリンク更新に対応しています。

時間を節約し、難しい作業はLinklyに任せてください：

1. 1
   リンク作成のAPIリクエストについては、以下を参照してください。
2. 2
   リクエスト全体をコピーします。それらがあなたのために機能することを確認できます。
3. 3
   ChatGPTまたは同等のものに依頼して、これらのリクエストをアプリケーションのソースコードに適応させてください。複雑な統合に時間を費やす必要はありません。当社のAPIは完全にマシンで読み取り可能です。

---

OpenAPI 3.0仕様

Linklyユーザーインターフェース内から直接APIリクエストを生成できます。

LinklyのAPIはOpenAPI標準を使用して文書化されており、以下で提供されているものを超えています。同じエンドポイントはワンクリックPostmanコレクションとしても利用可能です。

OpenAPI仕様を表示

Postmanで実行

認可

以下が必要です：

• APIキー
• ワークスペースID

これらの詳細はLinkly内から取得できます。

1. 1
   Linklyにログインします。
2. 2
   設定をクリックします。
3. 3
   APIキーをクリックします。

リンクの作成または更新

リンクを作成するには、以下のアドレスにPOSTリクエストを送信するだけです：

https://app.linklyhq.com/api/v1/link

本文に以下のフィールドを含めてください。

エンコーディングタイプはx-www-form-urlencodedまたはapplication/jsonです。

Rulesフィールドを送信する場合は、application/jsonを使用する必要があります。

Open API仕様でJSONを使用することをお勧めします。

curlを使用したリクエストの例

以下のコードは、リンクを作成するためのAPIリクエストを行う方法を示しています。

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'cache-control: no-cache'
-d 'api_key=your_secret_key&workspace_id=1&url=http%3A%2F%2Fwww.wikijob.co.uk&name=Test%20Link'

成功したレスポンスは、リンクを表すJSONオブジェクトとリンクIDを返します。

{
    "id": 9512,
    "url": "https://www.wikijob.co.uk",
    "name": "Test Link",
    "note": null,
    "head_tags": null,
    "body_tags": null,
    "linkify_words": null,
    "replacements": null,
    "enabled": true,
    "cloaking": false,
    "forward_params": false,
    "hide_referrer": false,
    "block_bots": false,
    "skip_social_crawler_tracking": false,
    "public_analytics": false,
    "password": null,
    "domain": null,
    "slug": null,
    "utm_source": null,
    "utm_medium": null,
    "utm_campaign": null,
    "utm_term": null,
    "utm_content": null,
    "og_title": null,
    "og_description": null,
    "og_image": null,
    "fb_pixel_id": null,
    "tiktok_pixel_id": null,
    "ga4_tag_id": null,
    "gtm_id": null,
    "full_url": "https://l.linklyhq.com/l/2TQ",
    "rules": [],
    "expiry_datetime": null,
    "expiry_destination": null,
    "expiry_clicks": null,
    "qr_styles": null,
    "webhooks": [],
    "notify_user_ids": [],
    "workspace_id": 1448,
    "deleted": false
}

リンクの更新

リンクを更新するには、リンクを作成する際に使用するのと同じリクエストを送信しますが、更新するリンクのidフィールドと変更内容を含めてください。

APIによるロータイターの作成

ロータイターを作成するには、上記のリンクペイロードとともに、rulesという名前のフィールドをJSON配列として送信します。JSON配列を送信するにはapplication/jsonを使用する必要があります。

例えば：

[
  {"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
  {"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]

APIによる地理的リダイレクトの作成

国別にリダイレクトするには、上記のリンクペイロードとともに、rulesという名前のフィールドをJSON配列として送信します。JSON配列を送信するにはapplication/jsonエンコーディングを使用する必要があります。

例えば：

[
  {"what": "country", "url": "https://www.microsoft.com", "matches": "UK"},
  {"what": "country", "url": "https://www.apple.com", "matches": "US"}
]

国は**2文字のISO 3166国コード**です。

APIによるデバイスリダイレクトの作成

デバイス別にリダイレクトするには、上記のリンクペイロードとともに、rulesという名前のフィールドをJSON配列として送信します。

例えば：

[
  {"what": "platform", "url": "https://www.google.com", "matches": "windows"},
  {"what": "platform", "url": "https://www.apple.com", "matches": "ios"}
]

ここでmatchesフィールドは以下のいずれかです：

• ios
• android
• windows
• linux
• mac

1つのリクエストで複数のリンクを作成または更新

Linklyは1つのリクエストで最大1000個のリンクの作成/更新をサポートしています。

そうするには、次のようにリクエストの一部としてAPIキーを送信します：

https://app.linklyhq.com/api/v1/link?api_key=XXXXXXXXXXX

次に、個別のリンク場合と同じスキーマを使用しますが、リクエストを次の形式の配列にラップします：

[{link}, {link}]

2つのリンクを更新する完全なリクエストは次のとおりです：

wget --no-check-certificate \
  --method POST \
  --timeout=0 \
  --header 'Content-Type: application/json' \
  --body-data '[
    {
        "workspace_id": "WORKSPACE_ID",
        "url": "https://nature.com",
        "name": "Test",
        "id": LINK_ID
    },
    {
        "workspace_id": "WORKSPACE_ID",
        "url": "https://science.com",
        "id": LINK_ID
    }
]' \
   'https://app.linklyhq.com/api/v1/workspace/WORKSPACE_ID/links?api_key=API_KEY'

これは作成と更新の両方のアクションに機能します。

大きなリクエストは最大60秒かかることがあることに注意してください。リクエストがこれより長くかかった場合は失敗し、ワークロードをより小さなチャンクに分割することを検討してください。

レート制限

リンク短縮APIは20リクエスト/秒に制限されています。リクエスト時にアップ200/秒が利用可能です。1つのリクエストで最大1000個のリンクをアップロードできます。

関連

• Analytics API - クリックデータおよびトラフィックレポートのエクスポート
• Webhooks - リアルタイムクリック通知
• Zapier統合 - ノーコード統合