Linklyのリンク短縮API

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

関連: 分析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仕様で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"}
]

国は**ISO 3166 alpha-2国コード**です。

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/links?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/links?api_key=API_KEY'

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

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

レート制限

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

関連

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