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ビルダー

Linklyのリンク短縮APIは、フォームの内容に基づいてAPIリクエストを自動的に構築します。 ここで指定されたテキストをいずれかのLLMに貼り付けて、アプリケーション用のコードを自動的に生成できます。

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

OpenAPI仕様を表示

Postmanで実行

認証

次が必要です:

  • APIキー
  • Workspace 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を使用することをお勧めします。

ラベルキータイプ注釈
アカウントAPIキーapi_key文字列必須
Workspace IDworkspace_id整数必須
Link IDid整数既存リンクを更新する場合は必須
宛先url文字列必須
ニックネームname文字列
メモnote文字列
メタデータmetadataオブジェクト自分のシステムのIDなど、独自のキーと値のデータ。メタデータを参照
リターゲティングタグ(頭部領域)head_tags文字列リターゲティングピクセル用
リターゲティングタグ(本体領域)body_tags文字列リターゲティングピクセル用
フォワードパラメータforward_paramsブール値
リファラーを非表示hide_referrerブール値referrer-policy: no-referrerを送信して、宛先がリファラーヘッダーのLinklyを見ないようにします
クローキングcloakingブール値フレームの背後にある宛先URLをマスクします
ボットをブロックblock_botsブール値既知のボット/クローラーをブロックします
ソーシャルクローラーの追跡をスキップskip_social_crawler_trackingブール値block_botsがオンの場合、OGプレビューが機能するようにソーシャルクローラーを通す
公開分析public_analyticsブール値このリンクの公開/abc123.statsページを有効にします
パスワードpassword文字列訪問者はリダイレクト前にこのパスワードを入力する必要があります
公開ステータスenabledブール値
UTMソースutm_source文字列UTM追跡用
UTMメディアutm_medium文字列UTM追跡用
UTMキャンペーンutm_campaign文字列UTM追跡用
UTMタームutm_term文字列UTM追跡用
UTMコンテンツutm_content文字列UTM追跡用
カスタムドメインdomain文字列スラッグが提供されている場合は必須。カスタムドメインを参照
カスタムドメインサフィックスslug文字列ドメインが提供されており、スラッグがnullの場合、自動生成されます
Open Graphタイトルog_title文字列ソーシャルメディアプレビュー用
Open Graphの説明og_description文字列ソーシャルメディアプレビュー用
Open GraphイメージURLog_image文字列ソーシャルメディアプレビュー用
MetaピクセルIDfb_pixel_id文字列MetaPixel用
TikTokピクセルIDtiktok_pixel_id文字列
Google Analytics 4 IDga4_tag_id文字列
Google Tag Managerコンテナgtm_id文字列
単語をリンク化linkify_words文字列ランディングページで自動短縮される改行区切りのフレーズ
置換replacements文字列宛先ページに適用されるテキスト置換ルール
有効期限の日時expiry_datetimeISO8601 DateTime Stringリンクの有効期限用
有効期限の宛先expiry_destination文字列(URL)リンクの有効期限用。httpで始まる必要があります。
有効期限クリック数expiry_clicks整数このクリック数後にリンクを期限切れにする
Webhookwebhooks文字列の配列リンクごとのwebhook URL。webhookを参照。
ユーザーIDに通知notify_user_ids整数の配列各クリックで通知するワークスペースユーザーID
QRコードスタイルqr_stylesJSONオブジェクトQRコードスタイル用。キー:fgColor、bgColor、qrStyle、eyeStyle、eyeColorInner、eyeColorOuter、logoImage、logoWidth、logoHeight、logoPadding、logoStyle、quietZone
ルールrulesJSON配列ロータ、ジオリダイレクト、およびデバイスリダイレクト用

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,
    "metadata": {},
    "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フィールドと変更を含めます。

リンクに独自のデータを添付する(メタデータ)

メタデータを使用して、独自の識別子(注文ID、CRM連絡先ID、または独自のシステムのキャンペーン参照など)をリンクに対して格納します。これはキーと値のペアのセットで、リンクを取得するたびに戻ってきて、すべてのwebhookペイロード(クリックおよびリンクイベント)に含まれるため、クリックをそれが属するレコードに一致させることができます。

JSON要求本体でオブジェクトとして送信します:

curl -X POST https://app.linklyhq.com/api/v1/link
-H 'Content-Type: application/json'
-d '{"api_key": "your_secret_key", "workspace_id": 1, "url": "https://example.com", "metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}}'

レスポンス内のリンクには"metadata": {"order_id": "A-10293", "crm_contact_id": "3f2b8c1e-9a47-4d0e-b6a5-1c2d3e4f5a6b"}が含まれます。

その仕組み:

  • **更新はマージされます。**リンクを更新する場合、送信するキーはリンクの既存メタデータに追加され、言及しないキーはそのままになります。キーを削除するには、nullに設定します(たとえば{"metadata": {"order_id": null}})。
  • **値は文字列です。**数値とブール値はテキストとして保存されるため、42は"42"として戻ります。ネストされたオブジェクトと配列は許可されません。
  • **制限。**リンクあたり最大20キー、キーは最大40文字、値は最大500文字で、UUIDに十分です。
  • **あなた専用。**メタデータは、リンクをクリックした人には表示されることはなく、リダイレクトの構築に使用されず、宛先URLに追加されることもありません。
  • アプリ内。メタデータは、リンクのオートメーション設定(メタデータの下)で表示および編集することもできます。

メタデータ、メモ、およびUTMパラメータ

メタデータ、メモフィールド、およびUTMパラメータはすべてリンクを説明していますが、異なる役割を果たします:

  • メタデータは独自のシステムのための構造化されたキーと値のデータです。APIによって返され、webhookで送信されるため、ソフトウェアはそれを読むことができます。
  • メモは、アプリ内で人が読むための単一の自由テキストフィールドです。
  • UTMパラメータは宛先URLに追加されるため、訪問者を送るページとその分析はそれらを見ることができます。メタデータは決してそうではありません。値を宛先ページに渡すには、UTMパラメータを使用するか、パラメータ転送をオンにして、短いリンク上のクエリパラメータが通過するようにします。

メタデータと分析

メタデータはクリック分析またはクリックエクスポートに含まれておらず、クリックをグループ化またはフィルタリングしたり、メタデータでリンクを検索したりすることはできません。クリックを独自のレコードに関連付けるには、リンクのidを使用します。これはwebhookペイロード、リンク別に分割された分析、およびリンク応答に表示されます。リンク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は、リクエストごとに最大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は、1秒あたり20リクエストに制限されています。最大200リクエスト/秒がリクエストに応じて利用可能です。1つのリクエストで最大1000個のリンクをアップロードできます。

関連

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

対応プラン

すべてのプランに含まれます

プランを比較 →

毎月500クリックを無料で追跡できます。