proteger APIは、プライベートAPIキーを使用して、ヘッダー「X-Proteger-Auth-Token」内のリクエストを認証します。 管理画面の[設定]からAPIキーを表示および管理できます。
APIキーには多くの権限が含まれているため、安全に保管してください。 GitHub、クライアント側コードなど、公的にアクセス可能な領域でAPIキーを共有しないでください。
すべてのAPIリクエストはHTTPS経由で行う必要があります。適切な認証なしのAPIリクエストと同様に、プレーンHTTPを介して行われた呼び出しは失敗します。
Example) サンドボックス環境
curl -X GET \
https://demo-api.helloproteger.com/v1/products/123 \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Proteger-Access-Token: サンドボックス環境トークン'
Example) プロダクション環境
curl -X GET \
https://api.helloproteger.com/v1/products/123 \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Proteger-Access-Token: プロダクション環境トークン'
| Security Scheme Type | API Key |
|---|---|
| Header parameter name | X-Proteger-Access-Token |