Obter Configurações da 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

Use esta página para ler as configurações de uma varredura, verificar todas as configurações que você pode enviar quando criar ou editar uma varredura, e descobrir quais valores e edições são permitidos.

Método Endpoint Finalidade
GET /scans/[scanId]/settings Obter as configurações completas de uma varredura.
GET /axe-versions Listar as versões do axe-core disponíveis na sua instância do axe Monitor.
GET /presets Listar presets
GET /presets/[presetId]/editability Listar quais configurações podem ser editadas em varreduras que usam um preset.

Obter Configurações de Varredura

Retorna as configurações completas de uma varredura. Você pode enviar esta resposta de volta para POST /scans or PATCH /scans/[scanId] sem alterá-la.

Exemplo de Solicitação

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

Parâmetros Obrigatórios

Nome Tipo Descrição
scanId Integer O identificador único da varredura.

Exemplo de Resposta

Status: 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: Senhas, stores de chaves e valores de variáveis de ambiente nunca são retornados. Eles são deixados fora da resposta completamente, não são retornados como nulos. As variáveis de ambiente são listadas apenas pelo nome.

Nota: presetId é o preset aplicado à varredura, ou nulo se não houver nenhum. Quando um preset é aplicado, use GET /presets/[presetId]/editability para ver quais configurações você pode editar.

Respostas de Erro

Código de Status HTTP Descrição
401 A chave da API está ausente ou é inválida.
403 Você não tem acesso a esta varredura.
404 A varredura não existe.

Configurações completas de varredura disponíveis por API

Esta seção lista todas as configurações de varredura que você pode enviar para POST /scans e PATCH /scans/[scanId], e que GET /scans/[scanId]/settings retorna. As configurações estão agrupadas da mesma forma que as configurações de varredura na interface do usuário do axe Monitor, e a API aceita os mesmos valores que a interface do usuário.

Exceção: credenciais para iniciar uma sessão não são modificáveis pela API por razões de segurança. As credenciais só podem ser modificadas a partir da interface do usuário do Axe Monitor.

Configurações Gerais (Obrigatórias)

Nome Tipo Descrição
nome String O nome da varredura.
sites String[] Os URLs iniciais para a varredura. Apenas obrigatório se não houver scripts na varredura.

Padrão de Acessibilidade (Obrigatório)

Nome Tipo Descrição
axeCoreVersion String A versão axe-core para escanear. Use um valor de versão do GET /axe-versions.
standardLevel String O padrão de acessibilidade para testar, por exemplo, wcag22aa. Use um valor das tags da versão do axe-core escolhida.

Configurações Básicas (Opcionais)

Nome Tipo Padrão Descrição
opçõesPadrão String[] [] Conjuntos de regras extras para incluir. Atualmente, apenas as melhores práticas são suportadas.
regrasPersonalizadas Array [] Adicione frases ou palavras a serem usadas com a configuração de Encontrar Texto.
habilitarPdfUa Booleano falso Verificar PDFs em relação ao PDF/UA.
linkCompartilhamentoPúblico Booleano falso Criar um link de compartilhamento público para os resultados da varredura.
uploadRelatóriosAxe Booleano falso Enviar resultados da varredura para Relatórios Axe.

Âmbito da Varredura (Opcional)

Nome Tipo Padrão Descrição
profundidade Integer [] Quantos níveis de links rastrear a partir das URLs iniciais.
limiteDePáginas Integer [] O número máximo de páginas examinadas em cada execução.
larguraJanela Integer 1920 Largura da janela do navegador, em pixels.
alturaJanela Integer 1080 Altura da janela do navegador, em pixels.
armazenarCapturasDeTela Booleano falso Armazenar capturas de tela com os resultados da varredura.
armazenarConteúdoArquivo Booleano falso Armazenar o código-fonte completo da página com os resultados da varredura.
incluirPáginasErro Booleano falso Incluir páginas que retornam um status de erro HTTP.
excluirTiposMime String[] [] Tipos de arquivo a serem ignorados durante o rastreamento, por exemplo, application/pdf.
alvoPdf Integer -1 O alvo da varredura de PDFs. -1 desativa a varredura de PDFs. Não pode ser usado quando application/pdf está em excluirTiposMime.
dataModificaçãoPdf Objeto ou nulo nulo Somente escanear PDFs modificados após uma certa data.
dataModificaçãoPdfAté Objeto ou nulo nulo Somente escanear PDFs modificados antes de uma certa data.

Componentes Comuns (Opcional)

Nome Tipo Padrão Descrição
componentesComuns Array [] Definições de componentes compartilhados aplicadas entre páginas.
URIsModelos String[] [] URL usado para detectar e consolidar componentes comuns.
excluirComponentesComuns Booleano falso Deixar resultados de componentes comuns fora da contagem de problemas.

Rastreamento e Sessão (Opcional)

Nome Tipo Padrão Descrição
scripts Array [] Scripts de tarefas e sessão. Cada script possui { "name", “id”, "contents", "shared", "mimeType" }.
runSessionScriptFirst Booleano falso Executar o script da sessão antes dos scripts da página.
environmentVariables Array [] Variáveis disponíveis para scripts. Cada entrada é { "name" }. Valores não podem ser modificados e não são incluídos nas respostas por razões de segurança.
userAgent String ou null nulo Sobrescrever a string do user agent do navegador.
referrer String ou null nulo O valor do cabeçalho HTTP Referer a ser enviado.
sessionEstablishment.authType String ou null nulo O método de login, por exemplo, básico ou keystore.
sessionEstablishment.authUserName String ou null nulo O nome de usuário utilizado para entrar.
sessionEstablishment.script Objeto [] Retornado quando a verificação possui um script de autenticação. Cada script possui { "id", “name”, "contents", "mimeType", "shared" }.
sessionEstablishment.script.id Integer 0 Retornado quando a verificação possui um script de autenticação. Para adicionar um script compartilhado ao usar os endpoints Criar ou Editar Verificação, vá para Admin → Scripts Compartilhados na interface do usuário do Axe Monitor. Edite um script e recupere o ID da URL na barra de endereços: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
sessionEstablishment.script.name String [] Nome do arquivo de script de autenticação que é aplicado à verificação.
sessionEstablishment.script.contents String [] Conteúdo do script de autenticação aplicado à verificação.
sessionEstablishment.script.mimeType String [] Tipo de arquivo do script que é aplicado à verificação.
sessionEstablishment.script.shared Booleano falso Verdadeiro indica que o script é um script compartilhado disponível na seção Admin do Axe Monitor.

Escopo de URL (Opcional)

Nome Tipo Padrão Descrição
restrictToFolder Booleano falso Rastrear apenas URLs sob o caminho do URL inicial.
domains String[] [] Limitar a verificação a esses domínios e seus subdiretórios. Links para outros domínios não são seguidos. Derivado do valor ‘sites’. Por padrão, apenas domínios no campo ‘sites’ são verificados.
skipSpecificUrls String[] [] Padrões de URL a serem omitidos do rastreamento.
mustHaveAll String[] [] Somente verificar URLs que contenham todas estas sequências de texto.
mustHaveAny String[] [] Somente verificar URLs que contenham pelo menos uma destas sequências de texto.
mustNotHaveAny String[] [] Pular URLs que contenham qualquer uma destas sequências de texto.
ignoreAllParams Booleano falso Tratar URLs que diferem apenas nos parâmetros de consulta como sendo a mesma página. Quando verdadeiro, meaningfulParams e meaninglessParams devem estar vazios.
discardAnchorTags Booleano falso Tratar URLs que diferem apenas no fragmento # como sendo a mesma página.
meaningfulParams String[] [] Parâmetros de consulta que tornam uma URL uma página separada.
parametrosSemSignificado String[] [] Parâmetros de consulta para ignorar ao decidir se dois URLs são da mesma página.

Otimização (Opcional)

Nome Tipo Padrão Descrição
páginaLongaOtimizada Booleano falso Aguarde antes de escanear cada página. Defina o tempo de espera com pageWait.
pageWait Integer 0 Quanto tempo esperar antes de escanear cada página, em milissegundos. Intervalo permitido: 0 a 120000.
waitAllPages Booleano true Aplica pageWait a todas as páginas no escaneamento. Quando é false, aplica-se apenas aos URLs em waitPageUrls.
waitPageUrls String[] [] Os URLs aos quais pageWait se aplica quando waitAllPages é false.
conteúdoDinâmicoAtivo Booleano falso Espere que o conteúdo dinâmico, como animações, componentes carregados sob demanda e mídia incorporada, carregue antes de escanear cada página. Defina o tempo de espera com dynamicContentWait.
dynamicContentWait Integer 0 Quanto tempo esperar pelo conteúdo dinâmico antes de escanear cada página. Usado quando dynamicContentActive é true.
prioridade Integer 2 A posição do escaneamento na fila. Intervalo permitido: 1 (mais alta) a 3 (mais baixa).

Frequência do Agendamento (Necessário para escaneamentos agendados)

Nome Tipo Descrição
agendamento Objeto Contém a opção para escaneamentos manuais (única vez) ou agendados, e detalhes se o escaneamento está agendado. Cada agendamento tem { "frequencyType", “frequencyInterval”, "frequencyData", "startDate", "startTime", “endDate”, “maxOccurrences”, “timeoutMinutes”, “timeZone.” }. Enviar null remove o agendamento.
agendamento.tipoFrequência String Necessário para escaneamentos agendados. Com que frequência o escaneamento se repete. Manual cria um escaneamento sem agendamento. Semana cria escaneamentos semanais, e Mês cria um escaneamento mensal. M_DoW permite executar um escaneamento mensal em um determinado dia da semana.
agendamento.intervaloFrequência Integer Necessário para escaneamentos agendados. Quantos períodos esperar entre as execuções (Week ou Month) . Por exemplo, 2 significa a cada 2 semanas ou meses.
agendamento.dadosFrequência String (como JSON) Em quais dias o escaneamento ocorre. O valor é um JSON escrito como string, e o que vai dentro depende de frequencyType. Semana: Array JSON com os dias da semana para executar. Exemplo: "[1,3]" roda toda segunda e quarta-feira. Mês: Objeto JSON com a data para executar em cada mês. Um número do dia, a string “Primeiro” ou a string “Último”. Primeiro e Último são sensíveis a maiúsculas. Exemplo: "{\"dayOfMonth\":15}" roda no dia 15. M_DoW: Objeto JSON com um dia da semana e qual deles no mês. Exemplo: "{\"weekOfMonth\":2,\"dayOfWeek\":2}" roda na segunda terça-feira. Use weekOfMonth: 5 para a última semana do mês, então "{\"weekOfMonth\":5,\"dayOfWeek\":5}" é a última sexta-feira de cada mês. Os dias são numerados 1 = segunda-feira até 7 = domingo.

Detalhes do Agendamento (Necessário para escaneamentos agendados)

Nome Tipo Descrição
agendamento.dataInicial Data Necessário. Data da primeira execução, como YYYY-MM-DD.
agendamento.horaInicial Hora-local Necessário. Hora local. cada execução inicia, como 24 horas HH:mm:ss, então 14:30 é 14:30:00 (assumido 24 horas). Interpretado em timeZone.
agendamento.dataFinal Data Data em que o agendamento termina. Definir isso ou maxOccurrences, não ambos.
agendamento.maxOcorrências Integer Número de execuções após as quais o agendamento termina. Definir isso ou endDate, não ambos.
agendamento.tempoLimiteMinutos Integer Duração máxima de execução em minutos, após a qual o escaneamento para automaticamente. Útil quando um site impede a conclusão de um escaneamento (como um URL com redirecionamento infinito) ou quando muitos escaneamentos grandes ocorrem de uma vez. Se não estiver presente, não há tempo limite.
agendamento.fusoHorário String Nome do fuso horário IANA, como America/New_York. (Todas as opções de fuso horário)

Equipes e Compartilhamento (Opcional)

Nome Tipo Padrão Descrição
gruposDeEscaneamento Object[] [] Agrupamentos de varredura aos quais a varredura pertence. Cada entrada é { “id”, "name" }.
scanGroups.id String [] IDs dos agrupamentos de varredura aos quais a varredura pertence.
scanGroups.name String [] Nomes dos agrupamentos de varredura aos quais a varredura pertence.
equipes Object[] [] Equipes com acesso à varredura. Cada entrada é { “id”, "name", “accessLevel” }.
teams.id String [] IDs das equipes com acesso à varredura.
teams.name String [] Nomes das equipes com acesso à varredura.
teams.accessLevel String [] O acesso “viewer” fornece acesso de Visualizador de Varredura para a equipe correspondente. O acesso “member” fornece acesso de Membro de Varredura, e “admin” fornece acesso de Admin de Varredura.
scanGroups.id String [] ID dos agrupamentos de varredura. Para adicionar agrupamentos de varredura ao usar os endpoints Criar ou Editar Varredura, vá para Admin → Agrupamentos de Varredura na interface do usuário do Axe Monitor. Edite um script e obtenha o ID na URL da barra de endereço: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
scanGroups.name String [] Nome dos agrupamentos de varredura
scanGroups.accessLevel String [] “viewer”, “member”, ou “admin”
grupoDeNotificação Booleano falso Enviar e-mail para membros do grupo de varredura quando uma execução terminar.
notificarUsuários Array [] Usuários específicos para enviar e-mail quando uma execução terminar.

Configurações de Somente Leitura

GET /scans/[scanId]/settings também retorna estas. Elas são ignoradas se forem enviadas para POST ou PATCH.

Nome Tipo Descrição
scanId Integer O identificador único da varredura.
presetId Inteiro ou nulo O predefinido aplicado à varredura, ou nulo se não houver nenhum.
scanGroups[].id Integer O identificador único de cada grupo de varredura.

Exemplo de Resposta

{
  "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 Versões do axe-core

Retorna as versões do axe-core disponíveis na sua instância do axe Monitor, e os padrões que cada uma suporta. O axe Monitor não detecta novas versões do axe-core automaticamente, então use este endpoint para ver quais versões você pode definir como axeCoreVersion de uma varredura.

Exemplo de Solicitação

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

Exemplo de Resposta

Status: 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 Resposta

Nome Tipo Descrição
versões Array As versões do axe-core disponíveis na sua instância.
versions[].version String O identificador da versão. Use este valor como axeCoreVersion de uma varredura.
versions[].supported Booleano Se a versão é atualmente suportada.
versions[].tags String[] Os padrões e conjuntos de regras que esta versão suporta. Use esses valores para standardLevel e standardOptions de uma varredura.
padrão String A versão padrão do axe-core para a sua instância.

Obter Editabilidade do Predefinido

Retorna quais configurações podem ser editadas em varreduras que usam um predefinido. Verifique isso antes de enviar PATCH /scans/[scanId]/settings para uma varredura com um predefinido, para saber quais configurações ela aceitará.

Para encontrar o predefinido de uma varredura, leia presetId do GET /scans/[scanId]/settings. Para encontrar outros IDs de predefinidos, vá para a interface do usuário do Axe Monitor e navegue até Admin → Predefinidos. Edite o predefinido desejado. Copie o ID da URL na barra de endereços: https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit

Exemplo de Solicitação

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

X-API-KEY: <your_api_key>

Parâmetros Obrigatórios

Nome Tipo Descrição
presetId Integer O identificador único do predefinido.

Exemplo de Resposta

Status: 200 OK

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

Campos de Resposta

Nome Tipo Descrição
presetId Integer O identificador único do predefinido.
campos Objeto Cada chave é um nome de configuração de Configurações Avançadas de Digitalização. true significa que você pode editá-la em digitalizações que usam este predefinição; false significa que a predefinição a bloqueia.

Enviar uma configuração bloqueada com um novo valor retorna 400 field_locked_by_preset. Enviá-la com seu valor atual é bem-sucedido e não muda nada.

Resposta de Erro

Nome Tipo
401 A chave da API está ausente ou é inválida.
403 Você não tem acesso a esta predefinição.
404 A predefinição não existe.

Is this page helpful?

Help us improve this page

Still need help?