Passer au contenu principal

​
Présentation

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

​
URL de base

Toutes les requêtes à l’API doivent être envoyées à : 
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 API.

​
Créer une clé de service

  1. Accédez à la page des paramètres de votre équipe
  2. Accédez à 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 à l’API

​
Autorisations requises

Les différents points de terminaison d’API nécessitent des autorisations différentes. Consultez la documentation de chaque endpoint pour connaître l’autorisation spécifique requise :
EndpointAutorisation requise
Custom Analytics (/Analytics)Lecture Analytics
User Page Analytics (/UserPageAnalytics)Teams Read-only
Cascade Analytics (/CascadeAnalytics)Teams Read-only
Set Usage Configuration (/UsageConfig)Écriture Facturation
Get Usage Configuration (/GetUsageConfig)Lecture Facturation

​
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
}
Conservez vos clés de service en sécurité et ne les exposez jamais dans du code côté client ni dans des dépôts publics

​
Limites de débit

Les requêtes API sont soumises à des limites de débit afin de garantir la stabilité du service. Si vous dépassez la limite de débit, vous recevrez une réponse 429 Too Many Requests.

​
Support

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