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 configurațiile de utilizare pentru echipele lor.
API-ul este disponibil numai pentru planurile Enterprise

​
URL de bază

Toate solicitările 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 incluse în corpul solicitării pentru toate apelurile către 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 folosi în solicitările API

​
Permisiuni necesare

Diverse endpoint-uri API necesită permisiuni diferite. Consultați documentația fiecărui endpoint în parte pentru permisiunea specifică necesară:
EndpointPermisiune necesară
Analytics personalizate (/Analytics)Analytics Read
Analytics pentru pagina utilizatorului (/UserPageAnalytics)Teams Read-Only
Cascade Analytics (/CascadeAnalytics)Teams Read-Only
Setare configurație de utilizare (/UsageConfig)Billing Write
Obținere configurație de utilizare (/GetUsageConfig)Billing Read
Obținere sold de credite al echipei (/GetTeamCreditBalance)Billing Read

​
Utilizarea cheilor de serviciu

Includeți cheia de serviciu în corpul solicitării 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 client sau în depozite publice

​
Limite de rată

Cererile către API sunt supuse unor limite de rată pentru a asigura stabilitatea serviciului. Dacă depășiți aceste limite, veți primi un răspuns de tip 429 Too Many Requests.

​
Asistență

Pentru suport și întrebări legate de API, vă rugăm să contactați Windsurf Support.