Saltar al contenido principal

​
Descripción general

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

​
URL base

Todas las solicitudes a la API deben realizarse en: 
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 la página de configuración de tu equipo
  2. Entra en 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 utilizarla en solicitudes a la API

​
Permisos requeridos

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

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

​
Soporte

Para recibir soporte de la API o resolver dudas, ponte en contacto con Windsurf Support.