Crear, Modificar y Ejecutar Escaneos por API

Los administradores de Axe Monitor pueden generar una clave API en Axe Account y crear, modificar o ejecutar escaneos sistemáticamente, sin usar la interfaz de usuario.

Aprende más sobre Primeros Pasos.

Puntos de Acceso

Crear un Escaneo

Crea un escaneo a partir de un solo objeto de configuración de escaneo. Para crear varios escaneos a la vez, envía una solicitud por cada escaneo.

Nota: Para mantener tus credenciales seguras, la API no acepta contraseñas, archivos de almacén de claves o valores de variables de entorno. Agrega estos valores en la interfaz de usuario de Axe Monitor en los detalles de inicio de sesión del escaneo.

Ejemplo de Solicitud

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>
Content-Type: application/json

Parámetros Requeridos

Configuraciones Opcionales

Se pueden usar configuraciones adicionales de escaneo con el punto de acceso Crear Escaneo. Ver documentación de Configuraciones de Escaneo.

Ejemplo de Solicitud

{
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],
  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "depth": 3,
  "pageLimit": 100,
  "skipSpecificUrls": ["https://www.example.com/logout"],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": true
}

Ejemplo de Respuesta

Estado: 201 Creado

{
  "scanId": 12345
}

Usa el [scanId] devuelto para leer, editar o ejecutar el escaneo.

Nota: La API no acepta contraseñas, almacenamientos de claves o valores de variables de entorno. Si tu escaneo inicia sesión en un sitio o ejecuta scripts que necesitan valores secretos, crea el escaneo a través de la API y luego agrega esos valores en Axe Monitor bajo Configuraciones Avanzadas, Iniciando una sesión.

Respuestas de Error

Editar un escaneo

Actualiza una o más configuraciones de un escaneo existente. Envía solo las configuraciones que deseas cambiar; las configuraciones que omites mantienen sus valores actuales.

Nota:

• Algunas configuraciones requieren IDs para ser editadas. Consulta la documentación para obtener IDs.
• Cuando un escaneo tiene un preset aplicado, algunas configuraciones pueden no ser editables. Consulta la documentación del preset.
• Consulta la lista completa de configuraciones de escaneo que se pueden editar vía API.

Ejemplo de Solicitud

PATCH
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-Key: <your_api_key>
Content-Type: application/json

Parámetros Requeridos

Se requiere al menos una configuración adicional para realizar un cambio. Consulta la documentación de Configuraciones de Escaneo.

Nota:

• ‘null’ restablece un campo a su valor predeterminado
• Los arreglos reemplazan el valor almacenado

Ejemplo de Solicitud

{
  "name": "Marketing Site - Production (weekly)",
  "depth": 4,
  "pageLimit": 250
}

Ejemplo de Respuesta

Estado: 200 OK

{
  "scanId": 12345,
  "updatedFields": ["name", "depth", "pageLimit"]
}

updatedFields enumera las configuraciones que cambiaron.

Respuesta de Error

Iniciar una Ejecución de Escaneo

Encola una nueva ejecución de un escaneo existente. La ejecución comienza cuando axe Monitor la recoge de la cola. Para verificar su progreso, utiliza GET /scans/[scanId]/runs.

Ejemplo de Solicitud

POST
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-Key: <your_api_key>

Parámetros Requeridos

Ejemplo de Respuesta

Estado: 202 Aceptado

La respuesta no tiene cuerpo.

Ejemplo de Respuesta de Error

{
  "title": "Bad Request",
  "status": 400,
  "detail": "Couldn't queue job since it's already running",
  "instance": "/v1/scans/20/runs"
}

Respuestas de Error