APIキーの取得
UTAGE管理画面からAPIキーを発行します。
- UTAGE管理画面にログイン
- 右上メニューの API設定 を開く
- 「追加する」をクリック
- 管理名称を入力し、利用ポリシーに同意して「保存」
- 表示されたAPIキーをコピーして安全な場所に保存
APIキーは発行時に一度だけ表示されます。紛失した場合は新しいキーを発行してください。
認証方法
全てのAPIリクエストに Authorization ヘッダーでAPIキーを送信します。
Authorization: Bearer {api_key}
curlでのテスト
curl -X GET "https://api.utage-system.com/v1/funnels" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
401 Unauthorized エラーが返ります。
{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}
セキュリティ
- APIキーはハッシュ化して保存されます。平文では保存されません
- 全てのAPIリクエストはログに記録されます
- 不要になったAPIキーは管理画面から無効化してください
レート制限
APIにはレート制限があります。
| 分間リクエスト数 | 日間リクエスト数 |
|---|
| 60回/分 | 10,000回/日 |
レスポンスヘッダー
全てのAPIレスポンスに、現在のレート制限状況を示すヘッダーが含まれます。
| ヘッダー | 説明 |
|---|
X-RateLimit-Limit | 分間の最大リクエスト数 |
X-RateLimit-Remaining | 残りのリクエスト数 |
X-RateLimit-Reset | 制限がリセットされるUNIXタイムスタンプ |
制限超過時
レート制限を超過すると 429 Too Many Requests が返ります。
{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}
X-RateLimit-Reset ヘッダーの時刻まで待ってからリトライしてください。