API ドキュメント

概要

TestCrew APIは、RESTful APIとして設計されており、JSON形式でデータをやり取りします。アプリ掲載の管理、テスト状況の確認、ユーザー情報の取得などを外部から自動化できます。

ベースURL

https://testcrew-api.eerf0309.workers.dev/api

レスポンス形式

すべてのAPIレスポンスは以下の形式で返されます：

{
  "success": true,
  "data": {
    // レスポンスデータ
  }
}

エラー時のレスポンス：

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "エラーメッセージ"
  }
}

認証

TestCrew APIでは、2種類の認証方法をサポートしています：

1. APIキー認証（推奨）

外部からのAPI呼び出しには、APIキー認証を使用することを推奨します。リクエストヘッダーに X-API-Key を含めてください。

curl -X GET "https://testcrew-api.eerf0309.workers.dev/api/users/me" \
  -H "X-API-Key: tc_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

2. JWT認証

アプリ内からのAPI呼び出しでは、ログイン時に取得したJWTトークンを使用します。リクエストヘッダーに Authorization を含めてください。

curl -X GET "https://testcrew-api.eerf0309.workers.dev/api/users/me" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

APIキーの取得

APIキーは、TestCrewアプリ内の設定画面から作成できます。

APIキー作成手順

1. TestCrewアプリを開き、プロフィール画面に移動します
2. 「API管理」セクションをタップします
3. 「新しいAPIキーを作成」をタップします
4. キーの名前（用途など）を入力し、作成します
5. 表示されたAPIキーを安全な場所に保存してください

エンドポイント一覧

ユーザー

{
  "success": true,
  "data": {
    "id": "uuid",
    "email": "user@example.com",
    "name": "ユーザー名",
    "avatar": "https://...",
    "credits": 24,
    "isPremium": false,
    "premiumExpiresAt": null,
    "discordId": "123456789",
    "createdAt": "2026-01-01T00:00:00.000Z"
  }
}

アプリ掲載

テスト

APIキー管理

{
  "success": true,
  "data": {
    "message": "API key created successfully",
    "apiKey": {
      "id": "uuid",
      "name": "My API Key",
      "key": "tc_api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "createdAt": "2026-01-25T00:00:00.000Z"
    },
    "warning": "This is the only time the API key will be shown."
  }
}

エラーハンドリング

APIはHTTPステータスコードとエラーコードを組み合わせてエラーを返します。

主なHTTPステータスコード

主なエラーコード

レート制限

APIの安定性を保つため、以下のレート制限が適用されます：

• 1分あたり60リクエストまで
• レート制限を超過すると、429 Too Many Requests が返されます