認証、スコープ & プラン
API キー
キーは 3 通りの方法で送れ、すべての REST エンドポイントと WebSocket で同じように受け付けます：Authorization: Bearer xsf_…、X-API-Key ヘッダー、または URL の ?api_key=（WebSocket のハンドシェイクでヘッダーを設定できないブラウザ向け）。複数送った場合は Authorization、次に X-API-Key、最後に api_key が使われます。存在しないキーと失効したキーは区別されます：invalid_api_key は入力ミスか古いシークレットを、key_revoked は発行者への確認を意味します。
スコープ
キーはスコープを持ちます。スコープ外の呼び出しは 403 と、不足しているスコープを示す {"error":{"code":"scope_required"}} を返します。GET /v1/account で自分のスコープを、GET /v1/meta/scopes で全スコープを一覧できます。
| スコープ | 許可される操作 |
|---|---|
| targets:read | このキーが監視するアカウントを一覧する |
| targets:write | 監視対象アカウントの追加・変更・削除 (単体またはバッチ) |
| keywords:read | キーワードを一覧し、search.match イベントを受信する |
| keywords:write | キーワードの追加と削除 |
| stream | WebSocket を開く |
| replay | last_id と GET /v1/events を使う |
| webhook | Webhook 配信を設定する |
| reads | プロフィール・投稿・フォロワー・フォロー中のオンデマンド REST 読み取り。クレジットを消費 |
管理用スコープは当社のオペレーター向けに存在し、別の非公開インターフェースで提供されます。お客様のキーがこれを持つことはありません。
プラン
プランはスコープと上限のプリセットで、どのキーも個別に調整できます。最新のマトリクスは GET /v1/meta/plans にあります。価格はここには掲載していません。
| プラン | 監視対象 | キーワード | 接続数 | リクエスト / 分 | スコープ |
|---|---|---|---|---|---|
| starter | 50 | 0 | 2 | 300 | targets:read, targets:write, stream, replay, reads, webhook |
| pro | 200 | 20 | 5 | 600 | targets:read, targets:write, stream, replay, reads, webhook, keywords:read, keywords:write |
| scale | 1000 | 100 | 10 | 900 | targets:read, targets:write, keywords:read, keywords:write, stream, replay, webhook, reads |
| ultra | 2000 | 300 | 20 | 1200 | targets:read, targets:write, keywords:read, keywords:write, stream, replay, webhook, reads |