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 forma simplificada de interagir com dados de resultados de testes de acessibilidade fora da interface do usuário do axe Monitor. Usando serviços web RESTful, a API fornece acesso a:

  • Verificações para um usuário
  • Execuções de Verificação para uma Verificação
  • Detalhes da Página para uma Execução de Verificação
  • Detalhes do Problema para uma Execução de Verificação
  • Detalhes do Problema 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.

Primeiros Passos

  1. Crie uma chave de API via Conta axe.

    Consulte as instruções específicas da região indicadas abaixo:

    Realize os seguintes passos 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 de produtos, 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. Insira 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 “suaempresa” pelo subdomínio da sua instância do axe Monitor.

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

Adicionar cabeçalhos:

Para acessar a API, é necessário autenticar-se 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 de página solicitado. Valor Padrão: 1

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

Endpoints

Todos os endpoints podem recuperar informações com requisições GET.

Endpoint Finalidade
/scans Listar todos os scans a que um usuário pode acessar. Permite recuperar scanId.
/scans/[scanId]/runs Listar todas as execuções de um scan, com informações gerais do scan. Permite recuperar o runId.
/scans/[scanId]/runs/[runId]/pages Informações detalhadas da página para uma execução de scan
/scans/[scanId]/runs/[runId]/pages/[pageId]/issues Problemas de acessibilidade detalhados para uma página
/scans/[scanId]/runs/[runId]/issues Problemas de acessibilidade detalhados para uma execução de scan

Listar Scans 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 Scan para um Scan

Exemplo de Solicitação

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

Parâmetros Obrigatórios

Nome Tipo Descrição
scanId String O identificador único do scan.

Parâmetros Opcionais

Nome Tipo Descrição
needsReview String “true” ou “false” permite controlar se questões "necessitam de revisão" são contadas 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 o seu scan possui 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 Scan

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 Obrigatórios

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

Parâmetros Opcionais de Solicitação

Nome Tipo Descrição
status string Filtra páginas por status (Concluído, Falhou).
sortBy String Especifica a coluna para ordenação (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 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 ordenação (testPageTitle, testUrl, selector, createdAt, ou status). O valor padrão é testPageTitle.
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.
runNumber Inteiro Sim O número específico da execução da varredura.

Parâmetros de Solicitação Opcionais

Nome Tipo Obrigatório Descrição
status string Não Filtra problemas por status (aberto, corrigido ou ignorado).
sortBy String Não Especifica a coluna para ordenar por (testPageTitle, testUrl, selector, createdAt ou status). O valor padrão é testPageTitle.
order 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 tem direitos de acesso.
400 Solicitação Inválida A solicitação contém parâmetros inválidos.
500 Erro Interno do Servidor Ocorreu um erro ao processar a solicitação.

Is this page helpful?

Help us improve this page

Still need help?