クライアントへのAPIの提供

あなたのクライアントも、あなたがパートナーアカウントを自動化するのと同じように、自分のリンク を自動化できます。このページは、APIをあなたの製品の機能に変えるための手引きです。自分の 開発者向けドキュメントに合わせて流用できる文面も含めています。

仕組み

• クライアントは自分でキーを作ります。 APIアクセスを含むプランのワークスペースには、 ブランド適用済みのダッシュボードに設定 → APIキーがあります。キーはワークスペースに 属します。あなたのパートナーキーが関わることはなく、クライアントは自分のデータにしか到達 できません。
• ホストは共有です。 すべてのリクエストはhttps://api.linkprofit.com/v1へ向かいます。 v1ではパートナーごとの独自APIドメインを提供していないので、このホストはあなたのサービスの 技術的なエンドポイントとして案内してください。レスポンスにLinkProfitのブランドは載りません。 ペイロードに含まれるドメイン、リンク、分析は、すべてクライアント自身のものです。
• 誰に提供するかはあなたが決めます。 APIアクセスは、あなたが販売するプランの api_accessフラグです。このフラグのないプランのクライアントには403 plan_restrictedが 返ります。きれいなアップセルの機会です。レート制限はキーに従うので、上位のプランをより高い 上限で提供できます。

自分のドキュメントに載せるべきこと

クライアント向けの最小限の開発者ページには、4つのことが必要です。

1. キーの置き場所 — 「ダッシュボードの設定 → APIキー。キーは一度だけ表示されます」。
2. ベースURL — https://api.linkprofit.com/v1と、 Authorization: Bearer <key>による認証。
3. クイックスタート — クイックスタートをコピーして、例の ドメインを自分のものに置き換えます。
4. リファレンス — 対話的なリファレンスへリンクするか、OpenAPIの ファイル（https://linkprofit.com/openapi.json）を自分のドキュメントツールでホストして ください。Scalar、Swagger UI、Redoc、Postmanでそのまま描画されます。

クライアント向けのWebhook

クライアントのワークスペースは、リンク、ドメイン、クリック上限のイベント用に、自分の Webhookエンドポイントを登録します。パートナーのレベルのイベント—— サブスクリプション、決済——はあなたのパートナー用エンドポイントに留まり、クライアントへ配信 されることはありません。

触れておく価値のある制限

• キーはワークスペース単位です。複数のワークスペースを管理する代理店のクライアントは、 それぞれでキーを作成します。
• 監査証跡はAPIによる変更をキーに紐づけて記録し、クライアントは自分のダッシュボードでそれを 見られます。サポートのやり取りが事実から始まります。
• APIが書き込むものはすべて、ダッシュボードと同じプランの割り当てに従います。あなたが販売 したリンク数の上限を、クライアントがスクリプトで回避することはできません。