コンテンツにスキップ

APIキー

APIキーにより、サーバーがDailyPlay APIで認証できます。キーはダッシュボードから作成し、API呼び出し時にx-api-keyヘッダーで使用します。

  1. DailyPlayダッシュボードにログイン
  2. サイドバーのConnect → APIキーに移動
  3. APIキーを作成をクリック
  4. 名前(例:「本番CRM」)と任意の説明を入力
  5. 任意で有効期限を設定
  6. 作成をクリック

:::caution 生成されたキーは即座にコピーしてください — 一度しか表示されず、後から取得することはできません。:::

キーの形式はdpk_<40桁の16進文字>です。例:

dpk_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0

APIキーはアクセスできるリソースを制限するようにスコープ設定できます:

スコープ説明
すべてのゲーム&ストリームデフォルト — 組織内のすべてのリソースにセッション作成可能
特定のゲームゲームIDのリストに制限
特定のストリームストリームIDのリストに制限

キーのスコープ外のリソースにセッションを作成しようとすると、403 Forbiddenエラーが返されます。

各APIキーには設定可能なレート制限があります:

制限デフォルト説明
毎分60毎分の最大リクエスト数
毎日10,000毎日の最大リクエスト数

レート制限を超えると、APIは429 Too Many Requestsレスポンスを返します。

ダッシュボードからいつでもAPIキーを取り消せます:

  1. Connect → APIキーに移動
  2. リストでキーを見つける(dpk_****プレフィックスと名前で識別)
  3. 取り消しアクションをクリック

取り消しの効果:

  • そのキーを使用するすべてのAPI呼び出しを即座にブロック
  • そのキーで既に作成されたセッショントークンは無効化されない
  • 監査証跡を保持 — キーレコードは保持されるが非アクティブとしてマーク
  • 必要に応じて再アクティブ化可能
  • キーは保存前にSHA-256でハッシュ化 — データベースから生のキーは復元不可
  • 識別用に最初の8文字(dpk_xxxx)のみプレーンテキストで保存
  • キーは特定の日付で自動的に期限切れに設定可能
  • すべてのキー使用は監査目的でログに記録

認証済みリクエスト(Clerkベアラートークン)を使用して、プログラム的にAPIキーを管理することもできます:

メソッドエンドポイント説明
GET/api/org-api-keys?org_id=<id>組織のすべてのAPIキーを一覧
POST/api/org-api-keys新しいAPIキーを作成
PATCH/api/org-api-keysAPIキーを更新または取り消し
DELETE/api/org-api-keys?id=<id>&org_id=<id>APIキーを完全に削除
Terminal window
curl -X POST https://app.dailyplay.ai/api/org-api-keys \
-H "Authorization: Bearer <clerk_token>" \
-H "Content-Type: application/json" \
-d '{
"org_id": 1,
"name": "本番CRM",
"description": "CRMがゲームリンクを発行するために使用",
"allowed_game_ids": [42, 43],
"rate_limit_per_minute": 60,
"rate_limit_per_day": 10000,
"expires_at": "2027-01-01T00:00:00Z"
}'

レスポンスには生のキーが含まれます(一度だけ表示):

{
"success": true,
"data": {
"id": 1,
"name": "本番CRM",
"key_prefix": "dpk_a1b2",
"key": "dpk_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0"
}
}