APIs del Centro de Desarrolladores de Axe
Una visión general de las REST APIs disponibles para el Centro de Desarrolladores de Axe
Not for use with personal data
El Centro de Desarrolladores de Axe expone un conjunto de REST APIs que puedes llamar con tu clave API de tu cuenta de Axe existente: no se necesita credencial separada para ninguna de ellas. Úsalas para controlar las canalizaciones CI/CD en el estado de accesibilidad, recuperar resultados de accesibilidad de manera programática y crear, gestionar y buscar tus proyectos.
¿Qué API Necesito?
| Quiero... | Usar... |
|---|---|
| Configurar la autenticación, encontrar un ID de proyecto y realizar una primera llamada | Comenzar con las APIs del Centro de Desarrolladores de Axe |
| Crear y gestionar proyectos y sus miembros, listar tus proyectos o buscar un ID de proyecto por nombre | Referencia de la API de Proyectos |
| Automatizar la creación de proyectos y la gestión de miembros, paso a paso | Comenzar con la Automatización de Gestión de Proyectos |
| Fallar una solicitud de extracción o commit cuando se encuentren errores de accesibilidad, desde una canalización CI/CD que no sea de GitHub (GitLab, BitBucket y similares) | Referencia de la API de Estado de Commit |
| Hacer lo mismo desde una canalización de GitHub | Usar la Acción de GitHub en lugar de llamar directamente a la REST API |
| Recuperar resultados completos de accesibilidad para una sesión o listar las sesiones de un proyecto | Referencia de la API de Sesiones y Resultados |
| Descargar un informe resumido de la manera en que lo hacen las integraciones anteriores | Obtener Resultados Programáticamente (Descontinuado): cambia a la API de Sesiones y Resultados en su lugar |
Autenticación, de un Vistazo
Cada API de esta lista se autentica de la misma manera, con tu clave API de tu cuenta de Axe en un header de X-API-Key. Consulta Comenzar con las APIs del Centro de Desarrolladores de Axe para obtener una clave, encontrar tu ID de proyecto y realizar tu primera llamada.
