Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

概要

Agent が迷わず使える順に整理しています。

はじめに
sf CLI をインストールクイックスタート会社IDの見方データの出所カバレッジとタグ
認証
認証設定APIキーのライフサイクル利用状況の見方APIキー認証アカウントスコープは通常不要レート制限とエラー
請求
利用プラン利用量の計測クレジット表
CLI
CLI 概要CLI 認証基本コマンド会社検索求人検索会社・事例・観測・開示建設業許可検索ヘルプとエラーコマンドとフラグCLI 更新
トラブルシュート
会社が見つからないとき認証・接続・制限エラー低ヒット検索の見直し方プレビューURLの注意クレジットと maxCredits の失敗
認証

APIキー認証

Signal Foundry API の認証ヘッダーと基本的な呼び出し方を説明します。

このページの内容2項目
例動作

Signal Foundry API は、WorkOS/AuthKit の OAuth bearer token か service 認証情報の API key で認証できます。CLI の推奨導線は sf login です。API key は、プロダクト組み込み、backend job、.env / secret store から直接 HTTP API を呼ぶ用途に限定します。

直接 API連携で API key を使う場合は、次のどちらかで送ります。

  • x-api-key: <API_KEY>
  • Authorization: Bearer <API_KEY>

x-api-key と Authorization: Bearer <JWT> を同時に送ると拒否されます。認証情報は 1 つだけ送ってください。

例

curl \
  -H 'x-api-key: <SIGNAL_FOUNDRY_API_KEY>' \
  'https://signal-foundry.app/api/signal-foundry/companies?q=7203&limit=3'
curl \
  -H 'Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>' \
  'https://signal-foundry.app/api/signal-foundry/companies/7203/profile'

動作

  • 正しいキーなら auth_mode=api_key で記録される
  • 無効なキーなら 401 invalid_api_key
  • revoke 済みなら 401 api_key_revoked
  • rotate 済みなら 401 api_key_rotated
  • 期限切れなら 401 api_key_expired
  • minute/day 上限を超えると 429 rate_limit_exceeded

正規接続先には https://signal-foundry.app を使ってください。

このページは 現在の読み取り API の認証方法だけを扱います。ブラウザセッションを primary auth とする設計や、書き込み系 API の将来仕様までは含みません。

このページの内容

例動作