API Keys

APIキーを作成

POST /api/v1/api-keys

認証されたユーザーの新しいAPIキーを作成します。

リクエストボディ

{
  "name": "My integration"
}

フィールド	必須	説明
name	はい	キーの表示名 (1～100文字)

レスポンス

{
  "data": {
    "id": "key_uuid",
    "name": "My integration",
    "prefix": "rm_abc123",
    "key": "rm_abc123def456...",
    "created_at": "2025-09-19T15:00:00.000Z"
  }
}

注意

keyフィールドは、作成時に一度だけ返されます。安全に保管してください。再度取得することはできません。以降のリクエストではprefix (最初の8文字) のみが表示されます。

---

APIキーをリスト

GET /api/v1/api-keys

認証されたユーザーのすべてのAPIキーを返します。完全なキー値は、作成後には返されません。

レスポンス

{
  "data": [
    {
      "id": "key_uuid",
      "name": "My integration",
      "prefix": "rm_abc123",
      "created_at": "2025-09-19T15:00:00.000Z",
      "last_used_at": "2025-09-20T10:30:00.000Z",
      "is_revoked": false
    }
  ]
}

---

APIキーを失効

DELETE /api/v1/api-keys/:id

APIキーを永久的に失効させます。このキーを使用したリクエストは、直ちにINVALID_API_KEYで失敗します。

レスポンス

{
  "data": { "success": true }
}

エラーコード

コード	HTTPステータス	意味
API_KEY_NOT_FOUND	404	キーが存在しないか、別のユーザーに属している
ALREADY_REVOKED	400	キーは既に失効済み