Windsurf API は、Enterprise のお客様がチームの詳細な利用状況 Analytics にプログラムからアクセスし、利用設定を管理できるようにします。
この API は Enterprise プラン専用です
すべての API リクエストは次の URL に送信してください:
https://server.codeium.com/api/v1/
Windsurf API は認証にサービスキーを使用します。すべての API 呼び出しでは、サービスキーをリクエストボディに含める必要があります。
- チーム設定ページに移動します
- 「サービス キー」セクションを開きます
- 適切な権限で新しいサービスキーを作成します
- 生成されたサービスキーをコピーし、API リクエストで使用します
API エンドポイントごとに必要な権限は異なります。各エンドポイントに必要な権限の詳細は、それぞれのエンドポイントのドキュメントを参照してください。
| Endpoint | 必要な権限 |
|---|
カスタム Analytics (/Analytics) | Analytics Read |
ユーザーページ Analytics (/UserPageAnalytics) | Teams Read-Only |
Cascade Analytics (/CascadeAnalytics) | Teams Read-Only |
利用状況設定の変更 (/UsageConfig) | Billing Write |
利用状況設定の取得 (/GetUsageConfig) | Billing Read |
すべての API 呼び出しで、リクエストボディにサービスキーを含めてください。
{
"service_key": "your_service_key_here",
// ... その他のパラメータ
}
サービスキーは厳重に管理し、クライアントサイドのコードや公開リポジトリで決して露出させないでください
API リクエストには、サービスの安定性を確保するためにレート制限が適用されます。レート制限を超えた場合、429 Too Many Requests レスポンスが返されます。
API に関するサポートやご質問は、Windsurf Support までお問い合わせください。