認証
API Key Settings
API キー設定画面で何ができるかと、初回ユーザーが API キー発行後にすぐやるべきことをまとめます。
このページの内容5項目
API キーは、Signal Foundry workspace の API キー設定画面から管理します。公開利用では、通常 team workspace のキーを使います。
- チームアカウント:
/home/<team-slug>/settings/api-keys
個人アカウントの設定画面は既存ユーザーや内部検証のために残る場合がありますが、billing、credit、共有 List を運用する正面入口は team workspace です。
できること
- 名前付きで API キーを発行する
- 任意で有効期限を付ける
- 既存キーを revoke する
- 既存キーを rotate する
- 直近 30 日の利用量を確認する
初回ユーザーが発行後にやること
- team workspace の API キー設定画面を開く
- 平文キーをその場で保存する
- 画面に出る
sf auth setup --no-openコマンドをターミナル側で実行する sf auth show --jsonでeffectiveBaseUrlとeffectiveApiKeyPreviewを確認するsf companies search 7203 --jsonで最初の疎通確認をする
運用ルール
- 用途ごとにキーを分ける
- 長期利用しないキーは revoke する
- 共有キーは rotate 前提で配る
sf_live_で始まる平文キーは初回表示時にだけ控える- Preview URL を接続先にしない
権限
チームアカウントでは settings.manage 権限を持つメンバーが管理します。1 人で使う場合も、自分が owner の team workspace でキーを作ります。
利用量画面で見えるもの
- request 数
- 利用 endpoint 数
- response bytes
- 最終利用時刻
- endpoint 別の内訳
- キーごとの利用状況と状態
詳しい運用は次の 2 ページを参照してください。