API概要

ダッシュボードでできることは、APIでもすべてできます。ターゲティングやABテストの分割を 含むリンクの作成、分析の取得、ドメインの接続、クライアントとプランの管理です。APIは一級 の製品面です。ダッシュボードとAPIは同じコードを動かし、同じ上限を適用します。

ベースURL

https://api.linkprofit.com/v1

すべてのリクエストはHTTPSとJSONを使います。レスポンスは、QRの画像とCSVエクスポートを除い てJSONです。常に最新の対話的なリファレンスは /docs/api/referenceにあり、すべてのリクエストを検証しているのと 同じスキーマから生成されています。

2種類のキー

| キーの接頭辞 | スコープ | 作成場所 | 使える範囲 | |---|---|---|---| | lp_live_… | ワークスペース | ワークスペース設定 → APIキー | /links、/analytics、/domains、/workspace、/events、/webhooks | | lpp_live_… | パートナー | パートナー設定 → APIキー | /partner/*と/webhooks |

ワークスペースキーは1つのクライアントワークスペースの中で動きます。パートナーキーは パートナーアカウント——クライアント、プラン、ドメイン、決済——を管理します。キーには、 そのキーができることを制限するスコープが付きます。

バージョニング

v1は凍結されています。フィールドは追加されるだけで、名前が変わることも削除されることも ありません。互換性を壊す変更は/v2として出します。ドキュメントに記載されたフィールドを 前提に実装し、知らないフィールドは無視してください。

ホワイトラベル——クライアントにAPIを提供する

ホワイトラベルのリンクサービスを運営しているなら、APIも再販するものの一部です。

• キーはあなたが配るものです。 各クライアントは、自分のブランドのダッシュボード （設定 → APIキー）でワークスペースキーを作成します。パートナーキーを共有することはありません。
• ホストは共有のままです。 v1では、APIのトラフィックはすべて api.linkprofit.comへ向かいます。パートナーごとの独自APIドメインはまだ提供していません。 ベースURLは「あなたのサービスのAPIホスト」として案内してください。レスポンスに LinkProfitのブランドは載りません。
• 上限はあなたのプランに従います。 APIアクセスは、あなたが販売するプランの機能フラグ （api_access）であり、各キーのレート制限はプランから決まります。APIアクセスのない プランのクライアントには403 plan_restrictedが返ります。

自分の開発者向けドキュメントに合わせて流用できるページは、ホワイトラベルのガイドを ご覧ください。

早見リンク

• クイックスタート — 2分でリンクを作成する。
• 認証方式 — キー、スコープ、キーのローテーション。
• ページネーション — すべての一覧エンドポイントでのカーソル。
• エラー — 単一のエラー形式とすべてのコード。
• レート制限 — スライディングウィンドウ、ヘッダー、再試行。
• Webhook — 再試行付きの署名済みイベント配信。