API de Acessibilidade Web

API de Acessibilidade Web otimizada para escalabilidade.

Para utilizar a API A11yWatch, adicione o seguinte formato JWT ao título de autorização: Bearer TOKEN. Para mais informações consulte a documentação OpenAPI, GraphQL ou gRPC. A utilização da API é paga.

Autenticação e Utilizadores
- https://api.a11ywatch.com/api/user
  GET
  curl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/login
  POST
  email stringEndereço de e-mail da conta para iniciar sessão.Campo obrigatóriopassword stringSenha da conta para iniciar sessão.Campo obrigatório
  curl --location --request POST 'https://api.a11ywatch.com/api/login' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "email": "example@email.com", "password": "somethingsafe" }'
Operações de Relatório
- https://api.a11ywatch.com/api/scan
  POST
  url stringURL para análise e exploração.Campo obrigatório
  curl --location --request POST 'https://api.a11ywatch.com/api/scan' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/crawl
  POST
  url stringURL para análise e exploração.Campo obrigatóriosubdomains booleanInclui subdomínios correspondentes ao domínio.sitemap numberInclui links do mapa do site - 0 para desativar, 1 para apenas analisar o mapa do site, 2 para exploração estendida através do mapa do site.tld booleanInclui todas as extensões TLD permitidas correspondentes ao domínio.csv Header [Accept: text/csv]Processar os dados como CSV em vez de JSON.standard stringO padrão de acessibilidade web. Um de WCAGA, WCAGAA, ou WCAGAAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/crawl' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/websites-sync
  POST
  curl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
Gestão de Sites
- https://api.a11ywatch.com/api/website
  POST
  url stringURL do site.Campo obrigatóriocustomHeaders string[{key: string, value: string}]Matriz de objetos contendo configurações de cabeçalho (chave-valor).mobile booleanExecutar a verificação na visualização móvel?standard stringEspecificação WCAG2.1 a usar, como WCAG2A, WCAG2AA ou WCAG2AAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "websiteUrl": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website?domain=https://mywebsite.com
  GET
  url stringURL do site.Campo obrigatório
  curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website
  PUT
  url stringURL do site.Campo obrigatóriocustomHeaders string[{key: string, value: string}]Matriz de objetos contendo configurações de cabeçalho (chave-valor).mobile booleanExecutar a verificação na visualização móvel?standard stringEspecificação WCAG2.1 a usar, como WCAG2A, WCAG2AA ou WCAG2AAA.
  curl --location --request PUT 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website
  DELETE
  url URL do site.domain stringO nome do website.deleteMany booleanApagar todos os websites e dados relacionados.
  curl --location --request DELETE 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "domain": "a11ywatch.com" }'
- https://api.a11ywatch.com/api/report?url=https://mywebsite.com
  GET
  url URL para análise e exploração.Campo obrigatóriodownload booleanDescarregar o relatório em formato Excel.csv booleanProcessar os dados como CSV em vez de JSON.
  curl --location --request GET 'https://api.a11ywatch.com/api/report?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com
  GET
  url URL do site.Campo obrigatório
  curl --location --request GET 'https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com
  GET
  url URL para análise e exploração.Campo obrigatório
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
Listas de Resultados
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberA posição da página para obter o próximo conjunto paginado.search stringPesquisar problemas numa página.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefined
- https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
  GET
  offset numberA posição da página para obter o próximo conjunto paginado.domain stringO nome do website.search stringPesquisar problemas numa página.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/pages?offset=0
  GET
  offset numberA posição da página para obter o próximo conjunto paginado.domain stringO nome do website.search stringPesquisar problemas numa página.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/pages?offset=0' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com
  GET
  offset numberA posição da página para obter o próximo conjunto paginado.domain stringO nome do website.pageUrl stringURL do site.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

Por defeito, a documentação da API A11yWatch descreve como interagir com a API via HTTP utilizando cURL. Para a maioria dos caminhos, pode enviar parâmetros a partir do URL ou do corpo do pedido. É preferível utilizar pedidos HTTP PUT e POST com corpo do pedido, já que alguns parâmetros precisam de ser definidos como tabela de matriz ou outra forma, enquanto outros parâmetros podem utilizar um formato diferente. Neste exemplo, substitua a11ywatch.com pelo site a ser verificado. A utilização do A11yWatch na integração contínua aumenta a consciencialização e reduz significativamente os custos de primeira instalação, uma vez que os problemas podem ser detetados antes do lançamento oficial.

Mantenha-se inclusivo com confiança

Comece agora com A11yWatch para ferramentas automatizadas de acessibilidade web acessíveis e eficientes.

Começar

API de Acessibilidade Web

API de Acessibilidade Web otimizada para escalabilidade.

Autenticação e Utilizadores

Operações de Relatório

Gestão de Sites

Listas de Resultados

Mantenha-se inclusivo com confiança