概要

認証

TokSpan API へのすべてのリクエストは、Bearer トークン（API キー）を使用して認証されます。このページでは、キーの作成、使用方法、セキュリティのベストプラクティスについて説明します。

Bearerトークン認証

すべてのリクエストのAuthorizationヘッダーにAPIキーを含めてください：

http
Authorization: Bearer sk-your-api-key-here

APIキーの作成

  1. TokSpanダッシュボードにログインします
  2. サイドバーのAPIキーに移動します
  3. + 新規キーをクリックします
  4. キーにわかりやすい名前を付けます（例：「production-backend」「dev-testing」）
  5. オプションで月間利用上限と許可モデルを設定します
  6. キーをすぐにコピーします。再度表示されることはありません
APIキーは一度だけ表示されます。安全に保管してください。キーを復元することはできません。紛失した場合は、新しいキーを生成し、古いキーを無効化してください。

キーの制限と権限

各APIキーは特定の権限に制限できます：

  • モデル：キーがアクセスできるモデルを制限します
  • 月間予算：キーを自動無効化するハードな利用上限を設定します
  • IPホワイトリスト：特定のIP範囲からのリクエストのみを許可します
  • レート制限：キーごとのカスタムRPM/TPM制限を設定します

環境変数の使用

本番環境では常に環境変数を使用してください。キーをハードコードしないでください：

python
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["TOKSPAN_API_KEY"],
    base_url="https://api.tokspan.com/v1",
)

キーの無効化とローテーション

ダッシュボードから任意のAPIキーを即座に無効化できます。90日ごとのキーローテーションと、侵害が疑われるキーの即時無効化を推奨します。