メインコンテンツへスキップ

​
認証

すべての API リクエストは、サポートされているメソッドを使用して認証する必要があります。これにより、アカウントデータの安全なアクセスが確保され、許可されていない使用が防止されます。

​
認証メソッド

​
API キーの認証

最も簡単な方法は、API キーを使用することです。リクエストヘッダーに API キーを含めます： 
Authorization: Bearer YOUR_API_KEY
例： 
GET /api/users
Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc

​
OAuth 2.0

より高度な統合のために、OAuth 2.0 を使用します：
  1. アクセストークンを取得：OAuth フローを使用してアクセストークンを取得します
  2. リクエストに含める：Authorization ヘッダーにトークンを追加します
  3. トークンを更新：必要に応じてトークン有効期限を処理します
例： 
POST /oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

​
基本認証

テスト目的で基本認証がサポートされます： 
Authorization: Basic BASE64_ENCODED_CREDENTIALS
ここで BASE64_ENCODED_CREDENTIALS は username:password の base64 エンコーディングです。

​
セキュリティのベストプラクティス

  • キーを安全に保存：API キーをクライアント側コードで公開したりログに記録したりしないでください
  • HTTPS を使用：常に HTTPS を介してリクエストを行います
  • キーを定期的にローテーション：セキュリティのために API キーを定期的に変更します
  • 使用状況を監視：API キーの使用状況を追跡し、異常なアクティビティの警告を設定します

​
エラーレスポンス

認証が失敗した場合、API は以下を返します： 
{
  "error": "unauthorized",
  "message": "Invalid API key provided"
}