Saltar al contenido principal

​
Descripción general

La API de Windsurf permite a los clientes Enterprise acceder de forma programática a Analytics detallados sobre el uso y gestionar las configuraciones de uso de sus equipos.
La API está disponible únicamente para planes Enterprise

​
URL base

Todas las solicitudes a la API deben enviarse a: 
https://server.codeium.com/api/v1/

​
Autenticación

La API de Windsurf utiliza claves de servicio para la autenticación. Las claves de servicio deben incluirse en el cuerpo de la solicitud en todas las llamadas a la API.

​
Crear una Clave de servicio

  1. Ve a tu página de configuración del equipo
  2. Dirígete a la sección “Claves de servicio”
  3. Crea una nueva clave de servicio con los permisos adecuados
  4. Copia la clave de servicio generada para usarla en solicitudes a la API

​
Permisos requeridos

Los distintos endpoints de la API requieren permisos diferentes. Consulta la documentación de cada endpoint para conocer el permiso específico requerido:
EndpointPermiso requerido
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

​
Uso de claves de servicio

Incluye tu clave de servicio en el cuerpo de la solicitud en todas las llamadas a la API: 
{
  "service_key": "tu_service_key_aquí",
  // ... otros parámetros
}
Mantén seguras tus claves de servicio y nunca las expongas en código del lado del cliente ni en repositorios públicos

​
Límites de frecuencia

Las solicitudes a la API están sujetas a límites de frecuencia para garantizar la estabilidad del servicio. Si superas el límite, recibirás una respuesta 429 Too Many Requests.

​
Soporte

Para soporte y consultas sobre la API, ponte en contacto con Windsurf Support.