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

El 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. Usando servicios web RESTful, el API proporciona acceso a:

  • Escaneos para un usuario
  • Ejecuciones de Escaneo para un Escaneo
  • Detalles de Página para una Ejecución de Escaneo
  • Detalles del Problema para un Ejecución de Escaneo
  • Detalles del Problema para una Página

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

Comenzando

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

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

    Realice los siguientes pasos para generar su clave API:

    • En la página de Claves API en la cuenta de axe, seleccione el botón «Agregar nueva clave API».
      Aparece el diálogo AGREGAR NUEVA CLAVE API.

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

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

  2. Introduzca la URL base del API: Usando su plataforma de 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}

Agregue encabezados:

Para acceder al API, debe autenticarse usando la clave API de axe Account.

X-API-Key: <your_api_key>

Parámetros Opcionales del Encabezado

Nombre Tipo Descripción
X-Pagination-Per-Page Entero El número máximo de elementos devueltos en una sola página. Valor Predeterminado: 10
X-Pagination-Page Entero El número de página solicitado. Valor Predeterminado: 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>'

Puntos de acceso

Todos los puntos de acceso pueden recuperar información con solicitudes GET.

Punto de acceso Propósito
/scans Enlista todos los análisis a los que un usuario puede acceder. Le permite recuperar scanId.
/scans/[scanId]/runs Enlista 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 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>

Respuesta de Ejemplo

{
  "scans": [
    "id": 1,
    "name": "Test Scan",
    "groups": [
        "id": 1,
        "name": "Group A"
    ]
  ]
}

Respuesta de Error Ejemplo

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” te permite controlar si los problemas de “Necesita revisión” se cuentan en la respuesta.

Respuesta de Ejemplo


{
  "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 análisis tiene una o más frases ingresadas en la configuración “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.
númeroDeEjecución Entero El número específico de ejecución del escaneo.

Parámetros de Solicitud Opcionales

Nombre Tipo Descripción
estado cadena Filtra 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 de ordenamiento (asc o desc). El valor predeterminado es desc.

Respuesta de Ejemplo

{
  "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 Buscar texto está habilitada para el análisis, el arreglo contiene todas las frases de la configuración “Buscar texto” que fueron identificadas en esa página.

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

Parámetros Opcionales

Nombre Tipo Descripción
estado cadena Filtra problemas por estado (abierto, corregido o ignorado).
ordenarPor Cadena Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt o status). El valor predeterminado es testPageTitle.
orden Cadena Especifica la dirección de ordenamiento (asc o desc). El valor predeterminado es desc.

Respuesta de Ejemplo

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "axeRuleId": "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": "2026-07-10T06:17:38.854Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

Detalles del Problema para un 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
scanId 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 problemas por estado (abierto, corregido o ignorado).
ordenarPor Cadena No Especifica la columna por la que ordenar (testPageTitle, testUrl, selector, createdAt o status). El valor predeterminado es testPageTitle.
orden Cadena No Especifica la dirección de ordenamiento (asc o desc). El valor predeterminado es desc.

Respuesta de Ejemplo

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "axeRuleId": "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": "2026-07-10T06:17:38.854Z",
      "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?