Linklyのリンク短縮API

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

関連: Analytics API | Webhooks

始める前に

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

これはリンク作成とリンク更新で機能します。

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

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 specで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"}
]

国は**alpha-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は1秒あたり20リクエストに制限されています。最大200リクエスト/秒がリクエストに応じて利用可能です。1つのリクエストで最大1000個のリンクをアップロードできます。

関連

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