API連携機能を使用する¶
API連携機能を使用することで商品や、利用者毎の契約状況等の情報をAPIにて取得・操作することが可能になります。
APIトークンの管理¶
APIトークンを生成する¶
サイドメニューの「API設定」をクリックすることで「API設定画面」を開きます。
「API設定画面」にて「APIトークン生成ボタン」をクリックすることでAPIトークンを生成する事ができます。
APIトークンの取り扱い
APIトークンは生成時に一度だけ表示されます。必ずコピーして安全な場所に保存してください。 トークンを紛失した場合は、既存のトークンを削除して新しいトークンを生成してください。
APIトークンの削除¶
不要になったAPIトークンは、API設定画面から削除することができます。削除したトークンは即座に無効化されます。
API認証方法¶
すべてのAPIリクエストには、HTTPヘッダーにBearerトークンを含める必要があります。
Authorization: Bearer {あなたのAPIトークン}
レート制限¶
サブスクライトのAPIは1分あたり60リクエストのレート制限を設けています。
| 項目 | 値 |
|---|---|
| 制限値 | 60リクエスト / 分 |
| カウント単位 | APIトークン（テナント）単位 |
| 対象 | /api/* 全エンドポイント（基本API・外部連携API・収益分析APIを合算） |
| 超過時 | HTTP 429 Too Many Requests（Retry-After ヘッダ付き） |
60リクエスト / 分 = 最大3,600リクエスト / 時間
一般的なサービスでは上限に達することは稀です。ただし以下のようなケースでは注意してください。
- 一括インポート等で短時間に大量のユーザー登録を行う場合
- プラン一覧画面・契約状況確認画面等の表示のたびにAPIを呼ぶ設計にしている場合
- 複数種類のAPIを同時に頻繁に呼ぶ場合（合算されるため）
推奨される実装¶
- Webhook駆動: 外部システム連携ガイドのWebhook通知を活用し、状態変化時のみ自社キャッシュを更新する
- 429ハンドリング:
Retry-Afterヘッダに従って再試行する - バルク処理時の流量制御: 1秒1件ペースにスリープ挿入するか、キューで分散する
詳細なレート制限の仕様と実装例は 外部システム連携ガイド をご覧ください。
基本API（テナントデータ取得）¶
生成したAPIトークンを使用してアクセスすることで下記の情報の取得がAPIから行えるようになります。
| エンドポイント | メソッド | 説明 |
|---|---|---|
/api/get_users |
GET | 利用者一覧の取得 |
/api/get_user |
GET | 利用者情報の取得 |
/api/get_products |
GET | 商品一覧の取得 |
/api/get_product |
GET | 商品情報の取得 |
/api/get_user_product |
GET | 利用者の商品情報の取得 |
/api/get_destination |
GET | 送付先情報の取得 |
/api/get_introducers |
GET | 代理店一覧の取得 |
/api/get_introducer |
GET | 代理店情報の取得 |
外部連携API¶
外部システムとの連携のための拡張APIです。ユーザーの作成・更新や契約管理をAPIから行うことができます。
| エンドポイント | メソッド | 説明 |
|---|---|---|
/api/v1/external/users |
POST | 利用者の新規作成 |
/api/v1/external/users |
PUT | 利用者情報の更新 |
/api/v1/external/customer-status |
GET | 利用者の契約状態確認 |
/api/v1/external/subscriptions/cancel |
POST | サブスクリプションの解約 |
/api/v1/external/users/withdraw |
POST | 利用者の退会処理 |
/api/v1/external/active-subscribers |
GET | アクティブ契約者一覧の取得（決済失敗者を含む） |
収益分析API¶
収益データの取得・分析のためのAPIです。
| エンドポイント | メソッド | 説明 |
|---|---|---|
/api/v1/revenue-analytics/users |
GET | ユーザー別収益データの取得 |
/api/v1/revenue-analytics/users/{userId} |
GET | 特定ユーザーの収益詳細 |
/api/v1/revenue-analytics/monthly |
GET | 月次トレンドデータの取得 |
/api/v1/revenue-analytics/products |
GET | 商品別パフォーマンスデータの取得 |
各種API仕様について¶
詳しくは下記のAPIマニュアルをご確認ください。 取得可能な情報例、各種パラメータ等の定義がご確認いただけます。 APIマニュアル