Introducción
La API de axe Monitor ofrece a los desarrolladores una forma optimizada de interactuar con los datos de resultados de pruebas de accesibilidad fuera de la interfaz de usuario de axe Monitor. Al utilizar servicios web RESTful, la API proporciona acceso a:
Escaneos para un usuario
Ejecuciones de escaneo para un escaneo
Detalles de la página para una ejecución de escaneo
Detalles del problema para una ejecución de escaneo
Detalles del problema de una página
Los usuarios con licencia de axe Monitor pueden utilizar la API con aplicaciones externas, siempre que su uso cumpla con el Acuerdo de licencia de suscripción.
Comenzando
Crear una clave API a través de axe Account.
En la página Claves API de axe Account, seleccione el botón "Agregar nueva clave API".
Aparecerá un modal. Seleccione axe Monitor en el menú desplegable de productos, asigne un nombre a su clave API y seleccione el botón Guardar.
En la columna Acciones, copie la clave API a su portapapeles.
Ingrese la URL base de la API: Utilizando su plataforma de API preferida, como Postman o SwaggerUI, o su directorio de trabajo, acceda a la API de axe Monitor. Reemplace "suempresa" con el subdominio de su instancia de axe Monitor.
https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}
Agregar encabezados:
Para acceder a la API, debe autenticarse utilizando la clave API de la cuenta axe.
X-API-Key: <your_api_key>
Parámetros de encabezado opcionales
Nombre
Tipo
Descripción
X-Pagination-Per-Page
Integer
Valor predeterminado: 10
El número máximo de elementos devueltos en una sola página
X-Pagination-Page
Integer
Valor predeterminado: 1
El número de página solicitado
Ejemplo de solicitud CURL
curl -X 'GET' \
'https://{base_url}/monitor-public-api/v1/scans/1/runs/1/issues?sortBy=testPageTitle&sortDir=desc' \
-H 'accept: application/json' \
-H 'X-API-KeyAuthorization: <your_api_key>' '
Puntos finales
Todos los puntos finales pueden recuperar información con solicitudes GET.
Endpoint
Propósito
/scans
Enumere todos los análisis a los que un usuario puede acceder. Permite recuperar scanId.
/scans/[scanId]/runs
Enumere todas las ejecuciones de análisis para un análisis, con información general del análisis. Le permite recuperar el runId.
/scans/[scanId]/runs/[runId]/pages
Información detallada de la página para una ejecución de análisis
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues
Problemas de accesibilidad detallados para una página
/scans/[scanId]/runs/[runId]/issues
Problemas de accesibilidad detallados para una ejecución de escaneo
Listar escaneos para un usuario
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>
Ejemplo de respuesta
{
"scans": [
"id": 1,
"name": "Test Scan",
"groups": [
"id": 1,
"name": "Group A"
]
]
}
Ejemplo de respuesta de error
Ejecuciones de un escaneo
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>
Parámetros requeridos
Nombre
Tipo
Descripción
scanId
String
El identificador único del escaneo.
Parámetros opcionales
Nombre
Tipo
Descripción
needsReview
String
"Verdadero" o "falso" le permite controlar si los problemas "Necesita revisión" se cuentan en la respuesta.
Ejemplo de respuesta
{
"runs": [
{
"runNumber" : 1,
"status" : "Complete",
"queuedAt": "2024-09-30T05:11:42Z",
"startedAt": "2024-09-30T05:11:45Z",
"completedAt": "2024-09-30T05:12:30Z",
"totalIssueCount": 29,
"completedPages": 1,
"axeVersion" : "4.9.0",
"standard" : "WCAG 2.2 AA"
“score”: “0”
“issues”: “28”
[ "criticalissues": “20”,
"seriousissues": “2”,
"moderateissues": “4”,
"minorissues": “2”,
]
pages: “40”
[ "criticalpages": “20”,
“aria”: “2”,
“color”: “2”,
“forms”: “2”,
“keyboard”: “2”,
“language”: “2”,
“namerolevalue”: “2”,
“pdf”: “2”,
“parsing”: “2”,
“semantics”: “2”,
“sensoryvisual”: “2”,
“structure”: “2”,
“tables”: “2”,
“alttext”: “2”,
“timemedia”: “2”
]
}
]
}
Detalles de la página para una ejecución de escaneo
Ejemplo de solicitud
GET https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages X-API-KEY: <your_api_key>
Parámetros de ruta requeridos
Nombre
Tipo
Descripción
scanId
String
El identificador único del escaneo.
runNumber
Integer
El número de ejecución específico del escaneo.
Parámetros de solicitud opcionales
Nombre
Tipo
Descripción
status
String
Filtra páginas por estado (Completado, Fallido).
sortBy
String
Especifica la columna por la que se ordenará (título, URL). El valor predeterminado es el título
order
String
Especifica la dirección de clasificación (ascendente o descendente). El valor predeterminado es descendente.
Ejemplo de respuesta
{
"pages": [
{
"id": 0,
"url": "string",
"title": "string",
"reasonForFailure": "string",
"totalCriticalIssues": 0,
"totalSeriousIssues": 0,
"totalModerateIssues": 0,
"totalMinorIssues": 0,
"totalNeedsReview": 0,
"totalFixedIssues": 0,
"totalOpenIssues": 0,
"health": "string",
"status": "string",
"scriptName": "string",
"scriptStep": 0,
"template": true,
"date": "2024-12-02T15:03:40.211Z",
"domainUrl": "string"
}
]
}
Detalles del problema de una página
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>
Parámetros requeridos
Nombre
Tipo
Descripción
scanId
String
El identificador único del escaneo.
runNumber
Integer
El número de ejecución específico del escaneo.
pageId
String
El identificador único de la página.
Parámetros opcionales
Nombre
Tipo
Descripción
status
String
Filtra los problemas por estado (abierto, solucionado o ignorado).
sortBy
String
Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt o estado). El valor predeterminado es testPageTitle.
order
String
Especifica la dirección de clasificación (ascendente o descendente). El valor predeterminado es descendente.
Ejemplo de respuesta
{
"issues": [
{
"issueId": 0,
"ruleId": "string",
"description": "string",
"help": "string",
"helpUrl": "string",
"impact": "string",
“issuegroup”: “string”
"needsReview": true,
"isExperimental": true,
"isManual": true,
"summary": "string",
"selector": [
"string"
],
"source": "string",
"tags": [
"string"
],
"igt": "string",
"testName": "string",
"createdAt": "2024-12-02T14:59:24.232Z",
"testUrl": "string",
"testPageTitle": "string",
"status": "string"
}
]
}
Detalles de incidencias para una ejecución de escaneo
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>
Parámetros requeridos
Nombre
Tipo
Obligatorio
Descripción
scanId
String
Sí
El identificador único del escaneo.
runNumber
Integer
Sí
El número de ejecución específico del escaneo.
pageId
String
Sí
El identificador único de la página.
Parámetros de solicitud opcionales
Nombre
Tipo
Obligatorio
Descripción
status
String
No
Filtra los problemas por estado (abierto, solucionado o ignorado).
sortBy
String
No
Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt o estado). El valor predeterminado es testPageTitle.
order
String
No
Especifica la dirección de clasificación (ascendente o descendente). El valor predeterminado es descendente.
Ejemplo de respuesta
{
"issues": [
{
"issueId": 0,
"ruleId": "string",
"description": "string",
"help": "string",
"helpUrl": "string",
"impact": "string",
“issuegroup”: “string”
"needsReview": true,
"isExperimental": true,
"isManual": true,
"summary": "string",
"selector": [
"string"
],
"source": "string",
"tags": [
"string"
],
"igt": "string",
"testName": "string",
"createdAt": "2024-12-02T14:59:24.232Z",
"testUrl": "string",
"testPageTitle": "string",
"status": "string"
}
]
}
Errores
Código de estado HTTP
Tipo de error
Descripción
401
No autorizado
El usuario no está autenticado o no tiene derechos de acceso.
400
Solicitud no válida
La solicitud contiene parámetros no válidos.
500
Error Interno del Servidor
Se produjo un error al procesar la solicitud.