API do 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

Introdução

A API do axe Monitor oferece aos desenvolvedores uma maneira simplificada de interagir com os dados de resultados de testes de acessibilidade fora da interface de usuário do axe Monitor. Usando serviços web RESTful, a API fornece acesso a:

  • Varreduras para um usuário
  • Execuções de Varredura para uma Varredura
  • Detalhes da Página para uma Execução de Varredura
  • Detalhes da Questão para uma Execução de Varredura
  • Detalhes da Questão para uma Página

Usuários licenciados do axe Monitor podem usar a API com aplicativos externos, desde que o uso esteja em conformidade com o Acordo de Licença de Assinatura.

Começando

  1. Crie uma chave de API através da Conta axe.

    Consulte as instruções específicas de cada região fornecidas abaixo:

    Siga os passos abaixo para gerar sua chave de API:

    • Na página de Chaves de API na Conta axe, selecione o botão „Adicionar Nova Chave de API“.
      O diálogo ADICIONAR NOVA CHAVE DE API aparece.

    • Selecione axe Monitor no menu suspenso do produto, nomeie sua chave de API e selecione o botão Salvar.

    • Na coluna Ações, copie a chave de API para sua área de transferência.

  2. Digite a URL base da API: Usando sua plataforma de API preferida, como Postman ou SwaggerUI, ou seu diretório de trabalho, acesse a API do axe Monitor. Substitua “yourcompany” pelo subdomínio da sua instância do axe Monitor.

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

Adicione cabeçalhos:

Para acessar a API, você precisa autenticar usando a chave de API da Conta axe.

X-API-Key: <your_api_key>

Parâmetros de Cabeçalho Opcionais

Nome Tipo Descrição
X-Pagination-Per-Page Inteiro O número máximo de itens retornados em uma única página. Valor Padrão: 10
X-Pagination-Page Inteiro O número da página solicitada. Valor Padrão: 1

Exemplo de Solicitação 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>'

Pontos de Extremidade

Todos os pontos de extremidade podem recuperar informações com solicitações GET.

Ponto de Extremidade Finalidade
/scans Listar todas as verificações que um usuário pode acessar. Permite recuperar scanId.
/scans/[scanId]/runs Listar todas as execuções de verificação para uma verificação, com informações gerais sobre a verificação. Permite recuperar as runId.
/scans/[scanId]/runs/[runId]/pages Informações detalhadas da página para uma execução de verificação
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues Questões detalhadas de acessibilidade para uma página
/scans/[scanId]/runs/[runId]/issues Questões detalhadas de acessibilidade para uma execução de verificação

Listar Verificações para um Usuário

Exemplo de Solicitação

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

Exemplo de Resposta

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

Exemplo de Resposta de Erro

Execuções de Verificação para uma Verificação

Exemplo de Solicitação

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

Parâmetros Requeridos

Nome Tipo Descrição
scanId String O identificador único da verificação.

Parâmetros Opcionais

Nome Tipo Descrição
needsReview String “true” ou “false” permite controlar se os problemas de “Necessita de revisão” são contados na resposta.

Exemplo de Resposta


{
  "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: Se a sua verificação tiver uma ou mais frases inseridas na configuração “Encontrar Texto”, a resposta da API incluirá um array findText.

Cada entrada contém:

  • A frase inserida.
  • O número de páginas onde a frase foi identificada.

Detalhes da Página para uma Execução de Verificação

Exemplo de Solicitação

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

Parâmetros de Caminho Requeridos

Nome Tipo Descrição
scanId String O identificador único da verificação.
runNumber Inteiro O número específico da execução da verificação.

Parâmetros de Solicitação Opcionais

Nome Tipo Descrição
status string Filtra páginas por status (Concluído, Falhou).
sortBy String Especifica a coluna para ordenar (título, url). O valor padrão é título.
order String Especifica a direção da ordenação (asc ou desc). O valor padrão é desc.

Exemplo de Resposta

{
  "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: Quando a configuração de Encontrar Texto está ativada para a varredura, o array contém todas as frases da configuração “Encontrar Texto” que foram identificadas nessa página.

Detalhes do Problema para uma Página

Exemplo de Requisição

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

Parâmetros Obrigatórios

Nome Tipo Descrição
scanId String O identificador único da varredura.
runNumber Integer O número específico da execução da varredura.
pageId String O identificador único da página.

Parâmetros Opcionais

Nome Tipo Descrição
status string Filtra problemas por status (aberto, corrigido ou ignorado).
sortBy String Especifica a coluna para ordenar (títuloDaPáginaDeTeste, urlDoTeste, seletor, criadoEm ou status). O valor padrão é títuloDaPáginaDeTeste.
order String Especifica a direção da ordenação (asc ou desc). O valor padrão é desc.

Exemplo de Resposta

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

Detalhes do Problema para uma Execução de Varredura

Exemplo de Requisição


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

Parâmetros Obrigatórios

Nome Tipo Obrigatório Descrição
scanId String Sim O identificador único da varredura.
númeroExecução Inteiro Sim O número específico de execução da varredura.

Parâmetros de Requisição Opcionais

Nome Tipo Obrigatório Descrição
status string Não Filtra problemas por status (aberto, corrigido ou ignorado).
ordenarPor String Não Especifica a coluna para ordenar (títuloPáginaTeste, urlTeste, seletor, criadoEm ou status). O valor padrão é títuloPáginaTeste.
ordem String Não Especifica a direção da ordenação (asc ou desc). O valor padrão é desc.

Exemplo de Resposta

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

Erros

Código de Status HTTP Tipo de Erro Descrição
401 Não autorizado O usuário não está autenticado ou não possui direitos de acesso.
400 RequisiçãoInválida A requisição contém parâmetros inválidos.
500 Erro Interno do Servidor Ocorreu um erro ao processar a requisição.

Is this page helpful?

Help us improve this page

Still need help?