Benzinga API では、リクエストの認証に API Key を使用します。API Key は一意の識別子であり、サブスクリプションに基づいて特定のデータや機能へのアクセス権を付与します。
API Key は安全に保管してください。 GitHub、クライアントサイドのコード、保護されていない通信など、一般にアクセス可能な場所で共有しないでください。キーが漏えいしたと思われる場合は、直ちにサポートまでご連絡ください。
API Key は、Benzinga Developer Console で表示および管理できます。
Benzinga API は 2 種類の認証方法をサポートしています。運用環境のアプリケーションでは、より安全で API キーが URL のログに残るのを防げるため、HTTP ヘッダーによる方法を強く推奨します。
ヘッダー認証を行うには、値を token <YOUR_API_KEY> とした Authorization ヘッダーを追加してください。
Authorization: token <YOUR_API_KEY>
簡易的なテストやヘッダーを変更できない場合は、token という名前のクエリパラメータとしてキーを渡すことができます。
https://api.benzinga.com/api/v2/news?token=<YOUR_API_KEY>
代表的なプログラミング言語で Benzinga API に接続するための、本番環境でそのまま利用できるサンプルです。
# 推奨: ヘッダー認証
curl -L 'https://api.benzinga.com/api/v2/news?pageSize=1' \
-H 'Authorization: token YOUR_API_KEY' \
-H 'Accept: application/json'
# 別案: クエリパラメータ
curl -L 'https://api.benzinga.com/api/v2/news?pageSize=1&token=YOUR_API_KEY'
一般的な認証エラーとその解決方法です。
| ステータスコード | メッセージ | 想定される原因 | 解決方法 |
|---|
| 401 | Unauthorized | 無効な API キー | API キーが正しく、再生成されていないことを確認してください。余分なスペースが含まれていないことも確認してください。 |
| 401 | Unauthorized | API キーが指定されていない | Authorization ヘッダーが token <KEY> として正しくフォーマットされているか、または token パラメータが存在するかを確認してください。 |
| 403 | Forbidden | 権限不足 | API キーは有効ですが、ご利用中のプランにはリクエストされたエンドポイントへのアクセス権が含まれていません。プランのアップグレードについて営業またはサポートにお問い合わせください。 |