パートナー API
パートナー API
パートナー向けサーバー API：独自サイトやボットから顧客を作成し、プランの付与とサブスクリプションの管理を行えます。
パートナー API を使うと、CreateYourVPN 上に独自のサイト、顧客ポータル、ボットを構築できます。公開されるのは顧客、プラン、サブスクリプションだけです。サーバー、ノード、管理パネル、インフラの認証情報がレスポンスに含まれることはありません。
キーはサーバー間通信専用です。 JavaScript やモバイルアプリには絶対に含めないでください。ブラウザーから送信されたように見えるリクエストは 403 browser_forbidden で拒否されます。
はじめに
- ダッシュボードで 設定 → API と連携 を開きます。
- 必要最小限の権限でキーを作成し、secret をコピーします。表示は一度だけです。
Authorization: Bearer cyv_live_…またはX-API-Keyとして送信します。
curl https://api.createyourvpn.com/api/v1/partner-api/me \
-H "Authorization: Bearer cyv_live_<key_id>_<secret>"権限：設定とロケーション用の config:read、顧客参照用の users:read、顧客作成とサブスクリプション管理用の users:write。
公開コントラクト
公開 Postman コレクションには、すべてのエンドポイント、パラメーター、ボディ、例、権限、エラーコードが含まれます。バックエンドのコントラクトから生成されるため、唯一の技術リファレンスです。
制限：キーごとに毎分 120 リクエスト、GET /users は毎分 10 リクエストです。grant、rotate、DELETE には Idempotency-Key が必要です。同じイベントの再試行では 24 時間同じ値を使用してください。