メインコンテンツまでスキップ

認証 (API キー)

公開 REST API へのリクエストには、API キーによる認証が必須です。API キーは HTTP リクエストヘッダ X-API-Key で渡します。

X-API-Key: <your-api-key>
Content-Type: application/json

ヘッダ名は大文字小文字を区別しません(サーバー側は小文字の x-api-key として読み取ります)。

リクエスト例

curl -H "X-API-Key: <your-api-key>" \
"https://<base-url>/v1/call-logs?projectId=<project-uuid>"

<base-url> は実際に払い出された API のドメインに置き換えてください。<project-uuid> は対象プロジェクトの ID です。

警告

API キーは認証情報です。リポジトリやクライアントサイドのコードに直接埋め込まず、環境変数やシークレットマネージャ等で安全に管理してください。

API キーの発行・管理

API キーは Recho ダッシュボードの API キー管理画面から発行します。発行・ローテーション・削除はダッシュボードで行えます。発行時に、その API キーへ割り当てる権限を指定します。

  • 発行: ダッシュボードで新しい API キーを作成し、付与する権限を選択
  • ローテーション: 漏洩や定期更新の際は、新しいキーを発行して切り替える
  • 削除: 不要になったキーは削除して無効化する