LinklyのリンクショートニングAPI
LinklyのリンクショートニングAPIを使用して、プログラムでリンクを作成、更新、管理できます。
始める前に
Linklyはインターフェース内でAPIリクエストを生成し、アプリケーションにコピー&ペーストできます。
これはリンク作成とリンク更新で機能します。
時間を節約して、私たちに難しい作業を任せましょう:
- 1リンク作成APIリクエストについては以下を参照してください。
- 2リクエスト全体をコピーします。動作することを確認できます。
- 3ChatGPTまたは同等のツールに、これらのリクエストをアプリケーション用のソースコードに変換するよう依頼します。複雑な統合に時間を費やす必要はありません。当社のAPIは完全に機械で処理可能です。
OpenAPI 3.0仕様
Linklyユーザーインターフェースから直接APIリクエストを生成できます。
LinklyのリンクショートニングAPIビルダー
LinklyのリンクショートニングAPIは、フォームの内容に基づいて自動的にAPIリクエストを構築します。 ここで提供されたテキストをLLMに貼り付けることで、アプリケーション用のコードを自動生成できます。
LinklyのAPIはOpenAPI標準を使用して文書化されており、以下に示す内容以上のものを提供しています。
認証
以下が必要です:
- APIキー
- ワークスペースID
これらの詳細はLinkly内から取得できます。
- 1Linklyにログインします。
- 2設定をクリックします。
- 3APIキーをクリックします。
リンクの作成または更新
リンクを作成するには、以下にPOSTリクエストを送信するだけです:
https://app.linklyhq.com/api/v1/link
ボディに以下のフィールドを含めます。
エンコーディングタイプはx-www-form-urlencodedまたはapplication/jsonです。
Rulesフィールドを送信する場合は、application/jsonを使用する必要があります。
Open API仕様でJSONを使用することをお勧めします。
| ラベル | キー | タイプ | 備考 |
|---|---|---|---|
| アカウントAPIキー | api_key | String | 必須 |
| ワークスペースID | workspace_id | Integer | 必須 |
| リンクID | id | Integer | 既存リンクを更新する場合は必須 |
| 遷移先 | url | String | 必須 |
| ニックネーム | name | String | |
| メモ | note | String | |
| リターゲティングタグ(head領域) | head_tags | String | リターゲティングピクセル用 |
| リターゲティングタグ(body領域) | body_tags | String | リターゲティングピクセル用 |
| パラメータ転送 | forward_params | Boolean | |
| 公開ステータス | enabled | Boolean | |
| UTMソース | utm_source | String | UTMトラッキング用 |
| UTMメディア | utm_medium | String | UTMトラッキング用 |
| UTMキャンペーン | utm_campaign | String | UTMトラッキング用 |
| UTMターム | utm_term | String | UTMトラッキング用 |
| UTMコンテンツ | utm_content | String | UTMトラッキング用 |
| カスタムドメイン | domain | String | slugが提供される場合は必須。カスタムドメインを参照 |
| カスタムドメインサフィックス | slug | String | domainが提供されてslugがnullの場合、自動生成されます |
| Open Graphタイトル | og_title | String | ソーシャルメディアプレビュー用 |
| Open Graph説明 | og_description | String | ソーシャルメディアプレビュー用 |
| Open Graph画像URL | og_image | String | ソーシャルメディアプレビュー用 |
| Meta Pixel ID | fb_pixel_id | String | Meta Pixel用 |
| Google Analytics 4 ID | ga4_tag_id | String | |
| Google Tag Managerコンテナ | gtm_id | String | |
| 有効期限日時 | expiry_datetime | ISO8601 DateTime String | 有効期限付きリンク用 |
| 有効期限切れ時の遷移先 | expiry_destination | String | 有効期限付きリンク用 |
| ルール | rules | JSON array | ローテーター、地域別リダイレクト、デバイスリダイレクト用 |
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'
成功したレスポンスは、リンクIDと共に、リンクを表すJSONオブジェクトを返します。
{
"id": 9512,
"alias": null,
"url": "https://www.wikijob.co.uk",
"name": "Test Link",
"note": null,
"head_tags": null,
"body_tags": null,
"linkify_words": null,
"enabled": true,
"cloaking": false,
"replacements": 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,
"full_url": "https://l.linklyhq.com/l/2TQ",
"block_bots": false,
"rules": [],
"workspace_id": 1448,
"referer_mode": null,
"custom_referer": null,
"click_fraud_mode": null,
"deleted": false
}
リンクの更新
リンクを更新するには、リンクを作成するために使用するのと同じリクエストを送信しますが、更新したいリンクのidフィールドと、変更内容を含めます。
API経由でのローテーターの作成
ローテーターを作成するには、上記のリンクペイロードと共に、JSON配列としてrulesというフィールドを送信します。JSON配列を送信するにはapplication/jsonを使用する必要があります。
例:
[
{"what": "rotator", "url": "https://www.microsoft.com", "percentage": "50"},
{"what": "rotator", "url": "https://www.apple.com", "percentage": "50"}
]
API経由での地域別リダイレクトの作成
国別にリダイレクトするには、上記のリンクペイロードと共に、JSON配列としてrulesというフィールドを送信します。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経由でのデバイスリダイレクトの作成
デバイス別にリダイレクトするには、上記のリンクペイロードと共に、JSON配列としてrulesというフィールドを送信します。
例:
[
{"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個のリンクをアップロードできます。