Passer au contenu principal

​
Vue d’ensemble

L’API Windsurf permet aux clients Enterprise d’accéder par programmation à des Analytics d’utilisation détaillées et de gérer les paramètres d’utilisation pour leurs équipes.
L’API est disponible uniquement pour les offres Enterprise

​
URL de base

Toutes les requêtes vers l’API doivent être effectuées à l’adresse : 
https://server.codeium.com/api/v1/

​
Authentification

L’API Windsurf utilise des clés de service pour l’authentification. Les clés de service doivent être incluses dans le corps de la requête pour tous les appels à l’API.

​
Création d’une clé de service

  1. Accédez à votre page des paramètres d’équipe
  2. Allez à la section « Clés de service »
  3. Créez une nouvelle clé de service avec les autorisations appropriées
  4. Copiez la clé de service générée pour l’utiliser dans les requêtes d’API

​
Autorisations requises

Différents endpoints de l’API nécessitent différentes autorisations. Reportez-vous à la documentation de chaque endpoint pour connaître l’autorisation spécifique requise :
EndpointAutorisation requise
Custom Analytics (/Analytics)Analytics Read
User Page Analytics (/UserPageAnalytics)Teams Read-only
Cascade Analytics (/CascadeAnalytics)Teams Read-only
Set Usage Configuration (/UsageConfig)Facturation Write
Get Usage Configuration (/GetUsageConfig)Facturation Read

​
Utilisation des clés de service

Incluez votre clé de service dans le corps de la requête pour tous les appels à l’API : 
{
  "service_key": "your_service_key_here",
  // ... autres paramètres
}
Protégez vos clés de service et ne les exposez jamais dans du code côté client ni dans des dépôts publics

​
Limitation du taux de requêtes

Les requêtes adressées à l’API sont soumises à une limitation de débit afin de garantir la stabilité du service. Si vous dépassez ce seuil, vous recevrez une réponse 429 Too Many Requests.

​
Support

Pour l’assistance concernant l’API et pour toute question, veuillez contacter le support Windsurf.