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 です。

ルール フィールドを送信する場合は、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アルファ-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/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のリンクをアップロードできます。

関連

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