Obtener configuraciones de la API

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

Utilice esta página para leer las configuraciones de un escaneo, consultar todas las configuraciones que puede enviar al crear o editar un escaneo, y encontrar qué valores y ediciones están permitidos.

Método Punto de acceso Propósito
GET /scans/[scanId]/settings Obtener la configuración completa de un escaneo.
GET /axe-versions Listado de versiones de axe-core disponibles en su instancia de axe Monitor.
GET /presets Listar ajustes preestablecidos
GET /presets/[presetId]/editability Listar qué configuraciones pueden ser editadas en escaneos que usan un ajuste preestablecido.

Obtener configuraciones del escaneo

Devuelve la configuración completa de un escaneo. Puede enviar esta respuesta de vuelta a POST /scans or PATCH /scans/[scanId] sin cambiarla.

Ejemplo de solicitud

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-KEY: <your_api_key>

Parámetros requeridos

Nombre Tipo Descripción
scanId Entero El identificador único del escaneo.

Ejemplo de respuesta

Estado: 200 OK

{
  "scanId": 12345,
  "presetId": null,
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],

  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "customRules": [],
  "enablePdfUa": false,
  "publicShareLink": false,
  "axeReportsUpload": false,
  
  "depth": 3,
  "pageLimit": 100,
  "windowWidth": 1920,
  "windowHeight": 1080,
  "storeScreenshotsFileContent": false,
  "includeErrorPages": false,
  "excludeMimeTypes": [],
  "pdfTarget": -1,
  "pdfModifiedBetween": null,

  "commonComponents": [],
  "templateUris": [],
  "excludeCommonComponents": false,

  "scripts": [],
  "runSessionScriptFirst": false,
  "environmentVariables": [
    { "name": "ENV_API_KEY" }
  ],
  "userAgent": null,
  "referrer": null,
  "sessionEstablishment": {
    "authType": null,
    "authUserName": null
  },

  "restrictToFolder": false,
  "skipSpecificUrls": [],
  "mustHaveAll": [],
  "mustHaveAny": [],
  "mustNotHaveAny": [],
  "ignoreAllParams": false,
  "discardAnchorTags": false,
  "meaningfulParams": [],
  "meaninglessParams": [],

  "longPageOptimized": false,
  "pageWait": 0,
  "dynamicContentActive": false,
  "priority": 2,

  "scanGroups": [
    { "id": 7, "name": "Marketing Sites" }
  ],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": false,
  "notifyUsers": []
}

Nota: Las contraseñas, almacenes de claves y valores de variables de entorno nunca se devuelven. Se omiten completamente de la respuesta, no se devuelven como nulos. Las variables de entorno se enumeran solo por nombre.

Nota: presetId es el ajuste preestablecido aplicado al escaneo, o nulo si no hay ninguno. Cuando se aplica un ajuste preestablecido, use GET /presets/[presetId]/editability para ver qué configuraciones puede editar.

Respuestas de error

Código de estado HTTP Descripción
401 La clave de API falta o es inválida.
403 No tiene acceso a este escaneo.
404 El escaneo no existe.

Configuraciones completas de escaneo disponibles por API

Esta sección lista cada configuración de escaneo que puede enviar a POST /scans y PATCH /scans/[scanId], y que GET /scans/[scanId]/settings devuelve. Las configuraciones están agrupadas de la misma manera que las configuraciones de escaneo en la interfaz de usuario de axe Monitor, y la API acepta los mismos valores que la interfaz de usuario.

Excepción: las credenciales para iniciar una sesión no son modificables por API por razones de seguridad. Las credenciales solo pueden modificarse desde la interfaz de usuario de Axe Monitor.

Configuraciones generales (Requeridas)

Nombre Tipo Descripción
nombre Cadena El nombre del escaneo.
sitios Cadena[] Las URLs iniciales para el escaneo. Solo se requiere si no hay scripts en el escaneo.

Estándar de Accesibilidad (Requerido)

Nombre Tipo Descripción
axeCoreVersion Cadena La versión de axe-core para escanear. Use un valor de versión de GET /axe-versions.
nivelEstándar Cadena El estándar de accesibilidad con el que se va a realizar la prueba, por ejemplo, wcag22aa. Use un valor de las etiquetas de la versión de axe-core elegida.

Configuraciones básicas (Opcionales)

Nombre Tipo Predeterminado Descripción
opcionesEstándar Cadena[] [] Conjuntos de reglas adicionales a incluir. Actualmente solo se admite "mejores prácticas".
reglasPersonalizadas Array [] Agregar frases o palabras para usar con la configuración Buscar texto.
habilitarPdfUa Booleano falso Verificar PDFs con respecto a PDF/UA.
enlaceCompartirPúblico Booleano falso Crear un enlace de compartir público para los resultados del escaneo.
subidaInformesAxe Booleano falso Enviar los resultados del escaneo a Informes Axe.

Ámbito del Escaneo (Opcional)

Nombre Tipo Predeterminado Descripción
profundidad Entero [] Cuántos niveles de enlace rastrear desde las URLs iniciales.
límiteDePáginas Entero [] El número máximo de páginas escaneadas en cada ejecución.
anchuraVentana Entero 1920 Ancho de la ventana del navegador, en píxeles.
alturaVentana Entero 1080 Altura de la ventana del navegador, en píxeles.
guardarCapturasDePantalla Booleano falso Guardar capturas de pantalla con los resultados del escaneo.
guardarContenidoArchivo Booleano falso Guardar el código fuente completo de la página con los resultados del escaneo.
incluirPáginasErrores Booleano falso Incluir páginas que devuelvan un estado de error HTTP.
excluirTiposMIME Cadena[] [] Tipos de archivo a omitir durante el rastreo, por ejemplo, application/pdf.
objetivoPdf Entero -1 El objetivo de escaneo de PDF. -1 desactiva el escaneo de PDF. No se puede usar cuando application/pdf está en excluirTiposMIME.
pdfModificadoDesdeFecha Objeto o nulo nulo Solo escanear PDFs modificados después de una fecha específica.
pdfModificadoHastaFecha Objeto o nulo nulo Solo escanear PDFs modificados antes de una fecha específica.

Componentes Comunes (Opcional)

Nombre Tipo Predeterminado Descripción
componentesComunes Array [] Definiciones de componentes compartidos aplicadas en varias páginas.
UrisPlantilla Cadena[] [] URL utilizada para detectar y consolidar componentes comunes.
excluirComponentesComunes Booleano falso Excluir los resultados de componentes comunes del conteo de incidencias.

Rastreo y Sesión (Opcional)

Nombre Tipo Predeterminado Descripción
scripts Array [] Scripts de tarea y sesión. Cada script tiene { "name", “id”, "contents", "shared", "mimeType" }.
runSessionScriptFirst Booleano falso Ejecutar el script de sesión antes que los scripts de la página.
environmentVariables Array [] Variables disponibles para los scripts. Cada entrada es { "name" }. Los valores no pueden modificarse y no se incluyen en las respuestas por razones de seguridad.
userAgent Cadena o nulo nulo Anula la cadena del agente de usuario del navegador.
referrer Cadena o nulo nulo El valor del encabezado HTTP Referer que se enviará.
sessionEstablishment.authType Cadena o nulo nulo El método de inicio de sesión, por ejemplo, básico o keystore.
sessionEstablishment.authUserName Cadena o nulo nulo El nombre de usuario utilizado para iniciar sesión.
sessionEstablishment.script Objeto [] Se devuelve cuando el análisis tiene un script de autenticación. Cada script tiene { "id", “name”, "contents", "mimeType", "shared" }.
sessionEstablishment.script.id Entero 0 Se devuelve cuando el análisis tiene un script de autenticación. Para agregar un script compartido al usar los puntos finales Crear o Editar Análisis, vaya a Admin → Scripts Compartidos en la interfaz de usuario de Axe Monitor. Edite un script y recupere el ID de la URL en la barra de direcciones: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
sessionEstablishment.script.name Cadena [] Nombre del archivo del script de autenticación que se aplica al análisis.
sessionEstablishment.script.contents Cadena [] Contenido del script de autenticación aplicado al análisis.
sessionEstablishment.script.mimeType Cadena [] Tipo de archivo del script que se aplica al análisis.
sessionEstablishment.script.shared Booleano falso True indica que el script es un script compartido disponible en la sección Admin de Axe Monitor.

Alcance de URL (Opcional)

Nombre Tipo Predeterminado Descripción
restrictToFolder Booleano falso Solo rastrear las URL bajo la ruta de la URL de inicio.
domains Cadena[] [] Limitar el análisis a estos dominios y sus subdirectorios. No se siguen enlaces a otros dominios. Derivado del valor ‘sites’. Por defecto, solo se escanean los dominios en el campo ‘sites’.
skipSpecificUrls Cadena[] [] Patrones de URL para excluir del rastreo.
mustHaveAll Cadena[] [] Solo analizar URLs que contengan todas estas cadenas de texto.
mustHaveAny Cadena[] [] Solo analizar URLs que contengan al menos una de estas cadenas de texto.
mustNotHaveAny Cadena[] [] Saltar URLs que contengan cualquiera de estas cadenas de texto.
ignoreAllParams Booleano falso Tratar las URLs que difieren solo en los parámetros de consulta como la misma página. Cuando es true, meaningfulParams y meaninglessParams deben estar vacíos.
discardAnchorTags Booleano falso Tratar las URLs que difieren solo en su fragmento # como la misma página.
meaningfulParams Cadena[] [] Parámetros de consulta que hacen que una URL sea una página separada.
parametrosInútiles Cadena[] [] Parámetros de consulta a ignorar al decidir si dos URL son la misma página.

Optimización (Opcional)

Nombre Tipo Predeterminado Descripción
páginaLargaOptimizadа Booleano falso Espere antes de escanear cada página. Establezca el tiempo de espera con pageWait.
esperaPágina Entero 0 Cuánto tiempo esperar antes de escanear cada página, en milisegundos. Rango permitido: 0 a 120000.
esperaTodasLasPáginas Booleano verdadero Aplica esperaPágina a cada página en el escaneo. Cuando es falso, solo se aplica a las URL en esperaPáginasUrls.
esperaPáginasUrls Cadena[] [] Las URL a las que aplica esperaPágina cuando esperaTodasLasPáginas es falso.
contenidoDinámicoActivo Booleano falso Espere a que se cargue el contenido dinámico, como animaciones, componentes de carga diferida y medios integrados, antes de escanear cada página. Establezca el tiempo de espera con esperaContenidoDinámico.
esperaContenidoDinámico Entero 0 Cuánto tiempo esperar para el contenido dinámico antes de escanear cada página. Se utiliza cuando contenidoDinámicoActivo es verdadero.
prioridad Entero 2 Lugar del escaneo en la cola. Rango permitido: 1 (más alto) a 3 (más bajo).

Frecuencia de Programación (Requerido para escaneos programados)

Nombre Tipo Descripción
programa Objeto Contiene opción para escaneos manuales (una sola vez) o programados, y detalles si el escaneo está programado. Cada programa tiene { "tipoFrecuencia", “intervaloFrecuencia”, "datosFrecuencia", "fechaInicio", "horaInicio", “fechaFin”, “ocurrenciasMáximas”, “minutosTimeout”, “zonaHoraria". Enviar null elimina el programa.
programa.tipoFrecuencia Cadena Obligatorio con escaneos programados. Con qué frecuencia se repite el escaneo. Manual crea un escaneo sin programa. Semana crea escaneos semanales y Mes crea un escaneo mensual. M_DSM permite ejecutar un escaneo mensual en un determinado día de la semana.
programa.intervaloFrecuencia Entero Obligatorio con escaneos programados. Cuántos períodos esperar entre ejecuciones (Week o Month). Por ejemplo, 2 significa cada 2 semanas o meses.
programa.datosFrecuencia Cadena de texto (como JSON) En qué días se ejecuta el escaneo. El valor es JSON escrito como cadena de texto, y lo que va dentro depende de frequencyType. Semana: Arreglo JSON con los días de la semana para ejecutar. Ejemplo: "[1,3]" ejecuta todos los lunes y miércoles. Mes: Objeto JSON con la fecha en que se ejecuta cada mes. Un número del día, la cadena “Primero”, o la cadena “Último”. Primero y Último son sensibles a mayúsculas. Ejemplo: "{\"dayOfMonth\":15}" se ejecuta el día 15. M_DSM: Objeto JSON con un día de la semana y cuál en el mes. Ejemplo: "{\"weekOfMonth\":2,\"dayOfWeek\":2}" se ejecuta el segundo martes. Use weekOfMonth: 5 para la última semana del mes, así "{\"weekOfMonth\":5,\"dayOfWeek\":5}" es el último viernes de cada mes. Los días están numerados 1 = lunes a 7 = domingo.

Detalles de la Programación (Requerido para escaneos programados)

Nombre Tipo Descripción
programa.fechaInicio Fecha Obligatorio. Fecha de la primera ejecución, como YYYY-MM-DD.
programa.horaInicio Hora-local Obligatorio. Hora local. cada ejecución comienza, como 24 horas HH:mm:ss, así que 2:30 PM es 14:30:00 (Se asume formato de 24 horas). Se interpreta en timeZone.
programa.fechaFin Fecha Fecha en que finaliza el programa. Establezca esto o maxOccurrences, no ambos.
programa.ocurrenciasMáximas Entero Número de ejecuciones después de las cuales finaliza el programa. Establezca esto o endDate, no ambos.
programa.minutosTimeout Entero Duración máxima de la ejecución en minutos, tras la cual el escaneo se detiene automáticamente. Útil cuando un sitio impide que un escaneo finalice (como una URL que redirige infinitamente) o cuando se ejecutan muchos escaneos grandes a la vez. Si no está presente, no hay tiempo de espera.
programa.zonaHoraria Cadena Nombre de la zona horaria IANA, como America/New_York. (Todas las opciones de zona horaria)

Equipos y Compartición (Opcional)

Nombre Tipo Predeterminado Descripción
gruposDeEscaneo Object[] [] Grupos de escaneo a los que pertenece el escaneo. Cada entrada es { “id”, "name" }.
scanGroups.id Cadena [] IDs de los grupos de escaneo a los que pertenece el escaneo.
scanGroups.name Cadena [] Nombres de los grupos de escaneo a los que pertenece el escaneo.
equipos Object[] [] Equipos con acceso al escaneo. Cada entrada es { “id”, "name", “accessLevel” }.
teams.id Cadena [] IDs de los equipos con acceso al escaneo.
teams.name Cadena [] Nombres de los equipos con acceso al escaneo.
teams.accessLevel Cadena [] El acceso “viewer” proporciona acceso como Visualizador de Escaneo para el equipo correspondiente. El acceso “member” proporciona acceso como Miembro del Escaneo, y “admin” proporciona acceso como Administrador del Escaneo.
scanGroups.id Cadena [] ID de los grupos de escaneo. Para añadir grupos de escaneo al usar los endpoints de Crear o Editar Escaneo, dirígete a Administrador → Grupos de Escaneo en la interfaz de usuario de Axe Monitor. Edita un script y obtén el ID desde la URL en la barra de direcciones: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
scanGroups.name Cadena [] Nombre de los grupos de escaneo
scanGroups.accessLevel Cadena [] “viewer”, “member” o “admin”
grupoDeNotificación Booleano falso Enviar un correo electrónico a los miembros del grupo de escaneo cuando una ejecución finaliza.
notificarUsuarios Array [] Usuarios específicos para notificar por correo electrónico cuando una ejecución finaliza.

Configuraciones de solo lectura

GET /scans/[scanId]/settings también devuelve estos. Se ignorarán si los envías a POST o PATCH.

Nombre Tipo Descripción
scanId Entero El identificador único del escaneo.
presetId Entero o nulo El preajuste aplicado al escaneo, o nulo si no hay ninguno.
scanGroups[].id Entero El identificador único de cada grupo de escaneo.

Ejemplo de respuesta

{
  "scanId": 0,
  "name": "string",
  "sites": [
    "string"
  ],
  "axeCoreVersion": "string",
  "standardLevel": "string",
  "standardOptions": [
    "string"
  ],
  "enablePdfUa": true,
  "depth": 0,
  "pageLimit": 0,
  "axeReportsUpload": true,
  "publicShareLink": true,
  "includeErrorPages": true,
  "storeFileContent": true,
  "storeScreenshots": true,
  "pdfModifiedFromDate": "2026-11-03",
  "pdfModifiedToDate": "2026-11-03",
  "pdfTarget": 0,
  "scanGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "teams": [
    {
      "id": "string",
      "name": "string",
      "accessLevel": "viewer"
    }
  ],
  "schedule": {
    "frequencyType": "Manual",
    "frequencyInterval": 0,
    "frequencyData": "string",
    "startDate": "2026-11-03",
    "startTime": "string",
    "endDate": "2026-11-03",
    "maxOccurrences": 0,
    "timeoutMinutes": 0,
    "timeZone": "string"
  },
  "scripts": [
    {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  ],
  "runSessionScriptFirst": true,
  "userAgent": "string",
  "referrer": "string",
  "sessionEstablishment": {
    "authType": "basic",
    "authUserName": "string",
    "script": {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  },
  "restrictToFolder": true,
  "skipSpecificUrls": [
    "string"
  ],
  "mustHaveAll": [
    "string"
  ],
  "mustHaveAny": [
    "string"
  ],
  "mustNotHaveAny": [
    "string"
  ],
  "ignoreAllParams": true,
  "discardAnchorTags": true,
  "meaningfulParams": [
    "string"
  ],
  "meaninglessParams": [
    "string"
  ],
  "domains": [
    "string"
  ],
  "excludeMimeTypes": [
    "string"
  ],
  "longPageOptimized": true,
  "pageWait": 0,
  "dynamicContentActive": true,
  "dynamicContentWait": 0,
  "waitAllPages": true,
  "waitPageUrls": [
    "string"
  ],
  "headlessMode": true,
  "eagerStrategy": true,
  "windowWidth": 0,
  "windowHeight": 0,
  "priority": 1,
  "templateUris": [
    "string"
  ],
  "commonComponents": [
    {
      "id": 0,
      "name": "string",
      "selectors": [
        "string"
      ]
    }
  ],
  "excludeCommonComponents": true,
  "customRules": [
    {
      "ruleId": "find-text",
      "options": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "notifyGroup": true,
  "notifyUsers": [
    "string"
  ],
  "presetId": 0,
  "draft": true
}

Listar versiones de axe-core

Devuelve las versiones de axe-core disponibles en tu instancia de axe Monitor, y los estándares que cada una soporta. axe Monitor no detecta nuevas versiones de axe-core automáticamente, así que utiliza este endpoint para ver qué versiones puedes establecer como la axeCoreVersion de un escaneo.

Ejemplo de solicitud

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/axe-versions
X-API-Key: <your_api_key>

Ejemplo de respuesta

Estado: 200 OK

{
  "versions": [
    {
      "version": "latest",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    },
    {
      "version": "4.12.1",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    }
  ],
  "default": "latest"
}

Campos de respuesta

Nombre Tipo Descripción
versiones Array Las versiones de axe-core disponibles en tu instancia.
versions[].version Cadena El identificador de la versión. Usa este valor como la axeCoreVersion de un escaneo.
versions[].supported Booleano Si la versión está actualmente soportada.
versions[].tags Cadena[] Los estándares y conjuntos de reglas que esta versión soporta. Usa estos valores para la standardLevel y standardOptions de un escaneo.
predeterminado Cadena La versión predeterminada de axe-core para tu instancia.

Obtener editabilidad del preajuste

Devuelve qué configuraciones se pueden editar en escaneos que usan un preajuste. Revisa esto antes de enviar PATCH /scans/[scanId]/settings a un escaneo con un preajuste, para saber qué configuraciones aceptará.

Para encontrar el preajuste de un escaneo, lee presetId desde GET /scans/[scanId]/settings. Para encontrar otros IDs de preajuste, ve a la interfaz de usuario de Axe Monitor y navega a Admin → Preajustes. Edita tu preajuste deseado. Copia el ID desde la URL en la barra de direcciones: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit

Ejemplo de solicitud

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/presets/[presetId]/editability

X-API-KEY: <your_api_key>

Parámetros requeridos

Nombre Tipo Descripción
presetId Entero El identificador único del preajuste.

Ejemplo de respuesta

Estado: 200 OK

{
  "presetId": 42,
  "fields": {
    "name": true,
    "depth": false,
    "pageLimit": false,
    "axeCoreVersion": false
  }
}

Campos de respuesta

Nombre Tipo Descripción
presetId Entero El identificador único del preajuste.
campos Objeto Cada clave es un nombre de configuración de Configuración Avanzada de Escaneo. true significa que puedes editarlo en las exploraciones que usen este preajuste; false significa que el preajuste lo bloquea.

Enviar un ajuste bloqueado con un nuevo valor devuelve 400 field_locked_by_preset. Enviarlo con su valor actual tiene éxito y no cambia nada.

Respuesta de Error

Nombre Tipo
401 La clave de API falta o es inválida.
403 No tienes acceso a este preajuste.
404 El preajuste no existe.

Is this page helpful?

Help us improve this page

Still need help?