認証方式
RouteAPI は Bearer Token 認証を使用します。すべての API リクエストでは、Authorization リクエストヘッダーに有効な Token を含める必要があります。
リクエストヘッダー形式
Section titled “リクエストヘッダー形式”Authorization: Bearer sk-your-routeapi-token例:
curl https://www.routeapi.ai/v1/models \ -H "Authorization: Bearer $ROUTEAPI_KEY"API Token を作成する
Section titled “API Token を作成する”- RouteAPI コンソールにログインします。
- API Keys ページを開きます。
- 新しい Token を作成します。
- 必要に応じて名前、クォータ、アクセス権限、有効期限を設定します。
- Token を保存し、サーバー側または安全な環境でのみ使用します。
Token と権限
Section titled “Token と権限”Token は通常、以下の設定の影響を受けます。
| 設定 | 影響 |
|---|---|
| ユーザー残高 | 残高不足時、リクエストは 402 を返す場合があります |
| Token クォータ | 単一 Token に独立したクォータまたは有効期限を設定できます |
| レート制限 | 発動後は 429 を返します |
セキュリティ推奨事項
Section titled “セキュリティ推奨事項”- Token をフロントエンドコード、公開リポジトリ、モバイルアプリの平文設定に公開しないでください。
- サーバー側コードから呼び出す場合は、環境変数の利用を優先してください。
- Token が漏えいした場合は、すぐに無効化または削除し、新しい Token を生成してください。
- アプリケーションごとに異なる Token を作成すると、監査と制限がしやすくなります。
- 一時的なテスト Token には低いクォータと短い有効期限を設定してください。
よくある認証エラー
Section titled “よくある認証エラー”| ステータスコード | よくある原因 | 対処方法 |
|---|---|---|
| 401 | Token の欠落、Token の入力ミス、Token が削除済み | Authorization ヘッダーを確認します |
| 402 | 残高不足またはクォータ消費済み | チャージ、クォータ引き上げ、または別 Token の利用を行います |
| 429 | レート制限に到達 | 同時実行数を下げ、ユーザーまたは Token のレート制限を確認します |