Zum Hauptinhalt springen

​
Übersicht

Die Windsurf API ermöglicht Enterprise-Kunden den programmgesteuerten Zugriff auf detaillierte Nutzungs-Analytics und die Verwaltung von Nutzungskonfigurationen für ihre Teams.
Die API ist nur für Enterprise‑Pläne verfügbar

​
Basis-URL

Alle API-Anfragen sollten an Folgendes gesendet werden: 
https://server.codeium.com/api/v1/

​
Authentifizierung

Die Windsurf API verwendet Service Keys (Service-Schlüssel) für die Authentifizierung. Service Keys müssen im Request-Body jeder API-Anfrage enthalten sein.

​
Erstellen eines Service-Schlüssels

  1. Öffnen Sie Ihre Team-Einstellungen
  2. Wechseln Sie zum Abschnitt „Service-Schlüssel“
  3. Erstellen Sie einen neuen Service-Schlüssel mit passenden Berechtigungen
  4. Kopieren Sie den generierten Service-Schlüssel zur Verwendung in API-Anfragen

​
Erforderliche Berechtigungen

Verschiedene API-Endpunkte erfordern unterschiedliche Berechtigungen. Siehe die Dokumentation der einzelnen Endpunkte für die jeweils erforderliche Berechtigung:
EndpunktErforderliche Berechtigung
Custom Analytics (/Analytics)Analytics Read
User Page Analytics (/UserPageAnalytics)Teams Nur-Lesen
Cascade Analytics (/CascadeAnalytics)Teams Nur-Lesen
Set Usage Configuration (/UsageConfig)Billing Write
Get Usage Configuration (/GetUsageConfig)Billing Read

​
Verwendung von Service-Schlüsseln

Fügen Sie Ihren Service Key in den Rumpf jeder API-Anfrage ein: 
{
  "service_key": "your_service_key_here",
  // ... weitere Parameter
}
Bewahren Sie Ihre Service Keys sicher auf und geben Sie sie niemals in clientseitigem Code oder in öffentlichen Repositories preis

​
Rate Limits

API-Anfragen unterliegen einem Rate Limit, um die Stabilität des Dienstes sicherzustellen. Wenn Sie das Rate Limit überschreiten, erhalten Sie eine Antwort mit dem Statuscode 429 Too Many Requests.

​
Support

Bei API-Fragen und -Support wenden Sie sich bitte an den Windsurf Support.