Salt la conținutul principal

Documentation Index

Fetch the complete documentation index at: https://docs.windsurf.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Prezentare generală

API-ul Windsurf le permite clienților Enterprise să acceseze programatic Analytics detaliate privind utilizarea și să gestioneze configurările de utilizare pentru echipele lor.
API-ul este disponibil numai pentru planurile Enterprise

​
URL de bază

Toate cererile către API trebuie trimise la: 
https://server.codeium.com/api/v1/

​
Autentificare

API-ul Windsurf folosește chei de serviciu pentru autentificare. Cheile de serviciu trebuie să fie incluse în corpul solicitării pentru toate apelurile API.

​
Crearea unei chei de serviciu

  1. Accesați pagina setărilor echipei
  2. Mergeți la secțiunea „Chei de serviciu”
  3. Creați o nouă cheie de serviciu cu permisiunile corespunzătoare
  4. Copiați cheia de serviciu generată pentru a o utiliza în solicitările către API

​
Permisiuni necesare

Diverse endpoint-uri API necesită permisiuni diferite. Consultați documentația fiecărui endpoint pentru permisiunea specifică necesară:
EndpointPermisiune necesară
Custom Analytics (/Analytics)Analytics Read
User Page Analytics (/UserPageAnalytics)Teams Read-Only
Cascade Analytics (/CascadeAnalytics)Teams Read-Only
Set Usage Configuration (/UsageConfig)Billing Write
Get Usage Configuration (/GetUsageConfig)Billing Read
Get Team Credit Balance (/GetTeamCreditBalance)Billing Read

​
Utilizarea cheilor de serviciu

Includeți cheia de serviciu în corpul cererii pentru toate apelurile API: 
{
  "service_key": "your_service_key_here",
  // ... alți parametri
}
Păstrați cheile de serviciu în siguranță și nu le expuneți niciodată în codul de pe client sau în depozite publice

​
Limitări de rată a solicitărilor

Solicitările către API sunt supuse unor limitări de rată pentru a menține stabilitatea serviciului. Dacă depășiți limita de rată a solicitărilor, veți primi un răspuns 429 Too Many Requests.

​
Asistență

Pentru asistență privind API-ul și pentru întrebări, vă rugăm să contactați Windsurf Support.