認証
Account Scope は通常不要
Signal Foundry API は通常 API キーだけで利用できます。account scope を送るのは例外的な場合だけです。
このページの内容4項目
通常の利用では、x-api-key または Authorization: Bearer だけで十分です。
Signal Foundry の API キーは account 単位で発行されるため、サーバー側は API キーから account_id を自動で解決します。通常は、リクエスト側で account_id を追加で送る必要はありません。
まず覚えること
- 通常は API キーだけで使う
account_idは省略してよいaccount scopeを送るのは、明示的に scope を残したいときだけ
例
通常の呼び出し:
curl -H 'x-api-key: <SIGNAL_FOUNDRY_API_KEY>' \ 'https://signal-foundry.app/api/signal-foundry/companies?q=7203&limit=3'
必要な場合だけ、次のどちらかで account scope を明示できます。
x-account-idヘッダーaccount_idクエリパラメータ
送る場合のルール
x-account-idとaccount_idを両方送る場合は一致している必要がある- 送った
account scopeは、その API キーに紐づくaccount_idと一致している必要がある
失敗パターン
x-account-idとaccount_idが不一致- API キーの
account_idと、送った scope が不一致
どちらも 400 account_scope_conflict になります。
複数アカウントをまたぐ運用や、ログ上で scope を明示したいケースだけ付与してください。それ以外では、API キーだけにしておくのが最も分かりやすく安全です。
通常の導入や agent 接続では、このページの内容を使わなくても問題ありません。まずは API キーだけで接続し、scope 明示が本当に必要になったときだけ戻ってください。