Zum Hauptinhalt springen

​
Überblick

Die Windsurf-API ermöglicht Enterprise-Kunden den programmgesteuerten Zugriff auf detaillierte Nutzungs-Analytics sowie 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 folgende Adresse gesendet werden: 
https://server.codeium.com/api/v1/

​
Authentifizierung

Die Windsurf-API verwendet Service Keys zur Authentifizierung. Service Keys müssen im Request-Body aller API-Aufrufe enthalten sein.

​
Einen Service-Schlüssel erstellen

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

​
Erforderliche Berechtigungen

Verschiedene API-Endpunkte erfordern unterschiedliche Berechtigungen. Weitere Informationen zu den jeweils benötigten Berechtigungen finden Sie in der Dokumentation der einzelnen Endpunkte:
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 Anfragetext (Request Body) aller API-Aufrufe ein: 
{
  "service_key": "your_service_key_here",
  // ... weitere Parameter
}
Bewahren Sie Ihre Service-Schlüssel sicher auf und veröffentlichen Sie sie niemals in clientseitigem Code oder öffentlichen Repositories

​
Rate Limits

API-Anfragen unterliegen Rate Limits, um die Stabilität des Dienstes sicherzustellen. Wenn du ein Rate Limit überschreitest, erhältst du eine Antwort mit 429 Too Many Requests.

​
Support

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