認証
Ecommerce Data API の認証ヘッダー、API キーの安全な管理、アクセス拒否時の確認方法を説明します。
データを取得するエンドポイントには、有効な API キーとアカウントのアクセス権限が必要です。設定の API キー一覧から管理するか、新しい API キーを作成してください。
認証ヘッダー
推奨する方法は、X-API-Key ヘッダーでキーを送信する方法です。
X-API-Key: ecom_live_your_keyBearer 認証も利用できます。
Authorization: Bearer ecom_live_your_key1 回のリクエストには、どちらか一方だけを指定してください。ecom_live_your_key は説明用の値です。実際のキーをソースコードへ直接書き込まないでください。
認証付きリクエストの例
サーバーのシークレットまたは環境変数に ECOMMERCE_DATA_API_KEY を設定してから実行します。
curl --request POST \
--url https://ecommercedataapi.com/v1/amazon/asin/detail \
--header "Content-Type: application/json" \
--header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
--data '{"marketplace":"US","asin":"B08CK5Z5Q1"}'環境変数はリクエストを実行する環境に設定してください。変数を展開しない HTTP クライアントから、${ECOMMERCE_DATA_API_KEY} という文字列をそのまま送っても認証できません。
キーの保管と失効
- キーはサーバー側のシークレットまたは環境変数に保存します。
- ブラウザーの JavaScript、配布するモバイルアプリ、公開リポジトリには含めません。
- 開発、検証、本番で別々のキーを使います。
- 漏えいの可能性がある場合は失効させ、新しいキーを作成し、利用中のサービスの設定を更新します。
- 実際のキーをエージェントとの会話、画面のキャプチャー、ログ、ドキュメントの例に貼り付けないでください。
キーは発行元のアカウントに紐づき、そのアクセス権限と利用上限を共有します。キーを追加しても、アカウントのクレジット、毎分のリクエスト上限、同時実行数は増えません。
アクセスできない場合
| ステータス | 確認する内容 |
|---|---|
401 | キーが未指定、不明、有効期限切れ、または失効済みです。ヘッダーと環境変数を確認してください。 |
402 | クレジットが不足しています。残高と付与ごとの有効期限を確認してください。 |
403 | アカウントまたはプランに、指定したエンドポイントの有効なアクセス権限がありません。 |
429 | 利用上限に達しています。Retry-After に従って待機してください。 |
問い合わせや利用履歴の確認には request_id を使用します。認証ヘッダーをログに残す必要はありません。レスポンス形式はエラーと利用制限を参照してください。
外部クライアントと API マーケットプレイス
RapidAPI 経由で利用する場合は、その API 掲載ページのコード生成機能に表示されるヘッダーを使用してください。このサイトへ直接送信するアカウントの API キーとは認証方法が異なるため、クライアント間で認証情報を混在させないでください。
エージェントの接続方法は Launcher ガイドまたは MCP ドキュメント、HTTP による連携は API カタログを参照してください。