API認証
SilentShieldへのすべてのAPIリクエストには認証が必要です。エンドポイントに応じて2つの認証方法があります。
APIキー認証
ほとんどのエンドポイントでは、X-Api-Keyヘッダーを使用したAPIキー認証を使用します。APIキーはダッシュボードのAPIキーセクションで確認できます。
X-Api-Key: your-api-key-hereこの方法の使用対象:ウィジェットエンドポイント、Nonce検証、公開APIコール。
JWT認証
ダッシュボードおよび管理エンドポイントでは、JWT(JSON Web Token)認証を使用します。認証エンドポイント経由でログインしてトークンを取得してください。
POST /api/v1/auth/loginRequest Body:
{"email": "[email protected]", "password": "your-password"}Response:
{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}Authorization: Bearer eyJhbGciOiJIUzI1NiIs...この方法の使用対象:管理エンドポイント、アナリティクスクエリ、チーム管理、アカウント設定。
認証エラー
| Status | Error | Solution |
|---|---|---|
401 | missing credentials | X-Api-KeyまたはAuthorizationヘッダーを追加してください。 |
401 | invalid_api_key | APIキーが正しく、有効であることを確認してください。 |
401 | token_expired | JWTの有効期限が切れています。/api/v1/auth/loginから新しいトークンをリクエストしてください。 |
403 | insufficient_permissions | お使いのロールにはこのエンドポイントへのアクセス権限がありません。 |
レート制限
APIリクエストはIPアドレスごとにレート制限されています。デフォルトの制限は管理エンドポイントで毎分60リクエスト、ウィジェットエンドポイントで毎分1000リクエストです。レート制限ヘッダーはすべてのレスポンスに含まれます。
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetRetry-After(429の場合のみ)