Skip to main content
La API pública de Acrity permite consultar contexto del workspace, repositorios, pull requests, reviews, webhooks, credenciales, bootstrap y security scans, conforme a los alcances de la API key.

​
Base

Las rutas públicas usan el prefijo /api/v1. La documentación OpenAPI está disponible en el ambiente de Acrity en:
  • /docs, para visualización interactiva;
  • /openapi/v1-public.json, para consumo por herramientas;
  • variantes localizadas cuando estén habilitadas, como /openapi/v1-public.pt-BR.json.

​
Autenticación

Usa el header X-Acrity-Key:
Las API keys se crean en API Keys. Crear una API key requiere un administrador del Workspace (los administradores de plataforma también tienen acceso).

​
Alcances

Prefiere una API key por sistema consumidor. Esto facilita la rotación, la auditoría y la limitación de alcance.

​
Recursos principales

​
Paginación y filtros

Los listados pueden usar paginación y filtros. Consulta la especificación OpenAPI de tu ambiente para conocer los parámetros exactos de cada recurso. El tamaño de página predeterminado es 20 y el máximo es 50. Una solicitud con un tamaño de página superior a 50 devuelve 400. Buenas prácticas:
  • usa páginas pequeñas en integraciones recurrentes;
  • mantén el cursor o la página procesada en la automatización;
  • trata las respuestas vacías como un estado válido;
  • aplica backoff en 429.

​
Errores

​
Límites de tasa

Cada API key está limitada a aproximadamente 300 solicitudes por minuto de forma predeterminada. Cuando superas el límite, la API devuelve 429 junto con estos headers de respuesta: Respeta Retry-After y aplica backoff antes de reintentar.

​
Ejemplo de llamada

Empieza por /api/v1/context al diagnosticar una integración. Esa llamada confirma si la key está activa y qué alcances están disponibles.