Obtener IDs por API
Los usuarios de Axe Monitor pueden generar una clave API en Axe Account y buscar los IDs necesarios para usar con otros puntos finales de la API de Axe Monitor, sin usar la interfaz de usuario.
Aprende más sobre Primeros pasos.
Puntos finales
| Método | Punto final | Propósito |
|---|---|---|
| GET | /lookups/presets |
Recuperar IDs de preconfiguración para aplicar una preconfiguración a un escaneo. Y, cuando un escaneo está actualmente asignado a una preconfiguración, buscar qué campos se pueden editar. |
| GET | /lookups/teams |
Obtener el nombre del equipo e IDs para proporcionar acceso a los escaneos a través de la API. |
| GET | /lookups/scans |
Obtener nombres e IDs de escaneos para obtener resultados, editar o ejecutar escaneos. |
| GET | /scans/[scanId]/runs |
Listar todos los ejecuciones de escaneo de un escaneo, con información general del escaneo. Te permite recuperar runId. |
| GET | /lookups/scan-groups |
Obtener nombres e IDs de grupos de escaneos para organizarlos a través de la API. |
| GET | /lookups/scripts |
Obtener IDs para asignar scripts compartidos a escaneos a través de la API. |
Preconfiguraciones
Puedes aplicar los ajustes de la preconfiguración a un escaneo a través de la API, pero primero se requieren el ID y el nombre de la preconfiguración. Usa este punto final para buscarlos.
El ID de preconfiguración también es necesario para entender qué ajustes del escaneo son editables cuando ya se ha aplicado una preconfiguración.
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/jsonEjemplo de respuesta
Estado: 200 Éxito
{
"presets": [
{ "id": 3, "name": "Gov Baseline" },
{ "id": 1, "name": "Marketing sites" }
]
}Equipos
Puedes asignar permisos de equipo al crear o editar un escaneo a través de la API. Usa este punto final para buscar nombres e IDs de equipos.
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/jsonEjemplo de respuesta
Estado: 200 Éxito
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
]
}Escaneos
Se requieren los IDs y nombres de escaneo para obtener resultados, editar y ejecutar escaneos. Usa este punto final para buscarlos.
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/jsonEjemplo de respuesta
Estado: 200 Éxito
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
]
}Ejecuciones de escaneos
Los IDs de ejecución de escaneo se pueden recuperar con este punto final para obtener datos detallados de los resultados.
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Ejemplo de respuesta
{
"scanRuns": [
{
"runNumber": 1,
"status": "Completed",
"queuedAt": "2025-08-21T06:50:27Z",
"startedAt": "2025-08-21T06:50:37Z",
"completedAt": "2025-08-21T06:51:52Z",
"axeVersion": "4.10.3",
"standard": "WCAG 2.1 AA",
"score": 0,
"issues": {
"total": 392,
"critical": 77,
"serious": 315,
"moderate": 0,
"minor": 0
},
"pages": {
"total": 18,
"completed": 17,
"critical": 17
},
"violationGroups": [
{
"name": "color",
"pageCount": 17
},
{
"name": "forms",
"pageCount": 17
},
{
"name": "name-role-value",
"pageCount": 10
},
{
"name": "parsing",
"pageCount": 1
},
{
"name": "text-alternatives",
"pageCount": 13
}
]
}
]
}Grupos de escaneos
Puedes organizar los escaneos por grupos de escaneos al crear o editar escaneos desde la API. Usa este punto final para buscar IDs y nombres de grupos de escaneos.
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/jsonEjemplo de respuesta
Estado: 200 Éxito
{
"scanGroups": [
{ "id": 1234, "name": "Marketing" },
{ "id": 1200, "name": "Storefront" }
]
}Scripts compartidos
Los scripts compartidos que están almacenados en la sección de administración de Axe Monitor y se usan en varios escaneos se pueden aplicar al crear o editar escaneos a través de la API. Usa este punto final para buscar IDs de scripts compartidos.
Ejemplo de solicitud
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/jsonEjemplo de respuesta
Estado: 200 Éxito
{
"scripts": [
{ "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
{ "id": 9, "name": "SSO login", "type": "SESSION" }
]
}