APIs do Axe Developer Hub
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
Uma visão geral das APIs REST disponíveis para o Axe Developer Hub
Not for use with personal data
O Axe Developer Hub expõe um conjunto de APIs REST que você pode chamar com a sua chave de API da Conta Axe existente: não é necessário um credencial separado para nenhuma delas. Use-as para controlar pipelines CI/CD com base no status de acessibilidade, obter resultados de acessibilidade programaticamente e criar, gerenciar e consultar seus projetos.
Qual API Eu Preciso?
| Eu quero... | Usar... |
|---|---|
| Configurar autenticação, encontrar um ID de projeto e fazer uma primeira chamada | Começar com as APIs do Axe Developer Hub |
| Criar e gerenciar projetos e seus membros, listar seus projetos ou consultar um ID de projeto pelo nome | Referência da API de Projetos |
| Automatizar a criação de projetos e o gerenciamento de membros, passo a passo | Começar com a Automação de Gerenciamento de Projetos |
| Rejeitar um pull request ou commit quando erros de acessibilidade forem encontrados, a partir de um pipeline CI/CD não-GitHub (GitLab, BitBucket e similares) | Referência da API de Status de Commit |
| Fazer o mesmo a partir de um pipeline do GitHub | Usar a Ação do GitHub em vez de chamar a API REST diretamente |
| Recuperar resultados completos de acessibilidade para uma sessão ou listar as sessões de um projeto | Referência da API de Sessões e Resultados |
| Baixar um relatório resumido da mesma forma que as integrações antigas fazem | Obter Resultados Programaticamente (Descontinuado): migrar para a API de Sessões e Resultados em vez disso |
Autenticação, em Resumo
Todas as APIs nesta lista se autenticam da mesma maneira, com sua chave de API da Conta Axe em um cabeçalho X-API-Key. Veja Começar com as APIs do Axe Developer Hub para obter uma chave, encontrar seu ID de projeto e fazer sua primeira chamada.