API de axe Monitor

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

Introducción

La API de axe Monitor ofrece a los desarrolladores una manera simplificada de interactuar con los datos de resultados de pruebas de accesibilidad fuera de la interfaz de usuario de axe Monitor. Utilizando 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 de problemas para una ejecución de escaneo
  • Detalles de problemas para una página

Los usuarios con licencia de axe Monitor pueden utilizar la API con aplicaciones externas, siempre que el uso cumpla con el Acuerdo de Licencia de Suscripción.

Comenzando

  1. Cree una clave de API a través de axe Account.

    Consulte las instrucciones específicas de la región a continuación:

    Realice los siguientes pasos para generar su clave de API:

    • En la página de claves de API en axe Account, seleccione el botón "Añadir Nueva Clave de API".
      Aparece el diálogo de AÑADIR NUEVA CLAVE DE API.

    • Seleccione axe Monitor del menú desplegable de productos, nombre su clave de API y seleccione el botón Guardar.

    • En la columna Acciones, copie la clave de API a su portapapeles.

  2. Ingrese la URL base de la API: Usando su plataforma API preferida, como Postman o SwaggerUI, o su directorio de trabajo, acceda a la API de axe Monitor. Reemplace “yourcompany” con el subdominio para su instancia de axe Monitor.

https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}

Añadir encabezados:

Para acceder a la API, necesita autenticarse usando la clave de API desde axe Account.

X-API-Key: <your_api_key>

Parámetros opcionales de encabezado

Nombre Tipo Descripción
X-Pagination-Per-Page Entero El número máximo de elementos devueltos en una sola página. Valor por defecto: 10
X-Pagination-Page Entero El número de página solicitado. Valor por defecto: 1

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-Key: <your_api_key>'

Endpoints

Todos los endpoints pueden recuperar información con solicitudes GET.

Endpoint Propósito
/scans Lista todos los escaneos a los que un usuario puede acceder. Le permite recuperar scanId.
/scans/[scanId]/runs Lista todas las ejecuciones de escaneo para un escaneo, con información general sobre el escaneo. Le permite recuperar la runId.
/scans/[scanId]/runs/[runId]/pages Información detallada de la página para una ejecución de escaneo
/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 escaneo para 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 Cadena El identificador único del escaneo.

Parámetros opcionales

Nombre Tipo Descripción
needsReview Cadena “true” o “false” le permite controlar si los problemas que “Necesitan revisión” se cuentan en la respuesta.

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
        }
      ]
    }
  ]
}

Nota: Si su escaneo tiene una o más frases ingresadas en la configuración de “Buscar texto”, la respuesta de la API incluye un arreglo findText.

Cada entrada contiene:

  • La frase ingresada.
  • El número de páginas donde se identificó la frase.

Detalles de 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 Cadena El identificador único del escaneo.
runNumber Entero El número específico de ejecución del escaneo.

Parámetros de solicitud opcionales

Nombre Tipo Descripción
estado cadena Filtra las páginas por estado (Completado, Fallido).
ordenarPor Cadena Especifica la columna por la que ordenar (título, url). El valor predeterminado es título.
orden Cadena Especifica la dirección del orden (asc o desc). El valor predeterminado es desc.

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"
      "findtext"
[     "Accessibility Statement",
      "WCAG"

    }
  ]
}

Nota: Cuando la configuración de Buscar Texto está habilitada para el escaneo, el array contiene todas las frases de la configuración "Buscar Texto“ que fueron identificadas en esa página.

Detalles de Problemas para 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
identificadorDeEscaneo Cadena El identificador único del escaneo.
númeroDeEjecución Entero El número de ejecución específico del escaneo.
identificadorDePágina Cadena El identificador único de la página.

Parámetros Opcionales

Nombre Tipo Descripción
estado cadena Filtra problemas por estado (abierto, solucionado o ignorado).
ordenarPor Cadena Especifica la columna por la que ordenar (títuloDePáginaDePrueba, urlDePrueba, selector, creadoEn o estado). El valor predeterminado es títuloDePáginaDePrueba.
orden Cadena Especifica la dirección del orden (asc o desc). El valor predeterminado es desc.

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 Problemas para una Ejecución de Escaneo

Ejemplo de Solicitud


GET 
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>

Parámetros Requeridos

Nombre Tipo Requerido Descripción
identificadorDeEscaneo Cadena Sí El identificador único del escaneo.
númeroDeEjecución Entero Sí El número específico de ejecución del escaneo.

Parámetros de Solicitud Opcionales

Nombre Tipo Requerido Descripción
estado cadena No Filtra los problemas por estado (abierto, solucionado, o ignorado).
ordenarPor Cadena No Especifica la columna para ordenar (títuloDeLaPrueba, urlDeLaPrueba, selector, creadaEn, o estado). El valor predeterminado es títuloDeLaPrueba.
orden Cadena No Especifica la dirección de orden (asc o desc). El valor predeterminado es desc.

Ejemplo de Respuesta

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
      "issueGrouping": "string",
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
      "string"
      ],
      "source": "string",
      "tags": [
      "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2025-08-07T10:54:30.268Z",
      "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 SolicitudInválida La solicitud contiene parámetros inválidos.
500 Error Interno del Servidor Ocurrió un error al procesar la solicitud.

Is this page helpful?

Help us improve this page

Still need help?