Transição para APIs do Axe Developer Hub para Resultados Móveis

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

Se você esteve chamando a API REST do mobile-service a partir de seus próprios scripts, você deve saber que o mobile-service está sendo desativado. Os resultados agora residem no Axe Developer Hub. Consulte a documentação de API mantida nas páginas seguintes:

Esta página é projetada para ajudar os usuários da API a entender essa transição. Você pode desconsiderar esta página se estiver usando nossos SDKs, drivers Appium ou Analisadores Móveis.

Usando as APIs do Axe Developer Hub

Com cada uma das APIs do Developer Hub, você irá passar sua Chave de API do Axe DevTools Mobile para os cabeçalhos para autenticação.

Chave Valor
X-API-Key YOUR_API_KEY

Use o endpoint de Projetos para retornar uma lista de seus projetos móveis e acessar o ID de Projeto exclusivo para cada um. Você precisará de um ID de Projeto para chamar o endpoint de Sessões. Chame o endpoint de Sessões usando o ID do projeto para recuperar todas as sessões de um determinado projeto. Cada ID de sessão dessa resposta pode ser passado para o endpoint de Resultados.

Formato de Saída

Os resultados são retornados como JSON Universal do Axe, um formato padrão usado por todos os produtos Axe. Ele contém os resultados de testes de acessibilidade, mas não inclui uma captura de tela ou a hierarquia de visualização móvel. O JSON Móvel inclui todas as informações capturadas no momento da digitalização, incluindo os resultados de testes de acessibilidade, toda a hierarquia de visualização móvel e uma captura de tela. Embora o JSON Móvel não esteja disponível através da API, você pode exportar seus dados neste formato através da interface do Axe Developer Hub.

Migrando da API REST do mobile-service

Como os resultados das APIs do Axe Developer Hub vêm de sessões ao invés de varreduras únicas, a funcionalidade será diferente da mobile-service.

  • Use o API de Sessões e Resultados para resumos completos de digitalizações bem como resumos filtrados de digitalizações
  • Com a API do mobile-service, você poderia POSTar resultados de digitalizações para o Painel Móvel. Agora será necessário usar nossos SDKs ou drivers Appium e invocar o startScanSession para enviar resultados para o Axe Developer Hub
  • Você não pode atualizar os nomes de digitalizações individuais programaticamente, embora você pode renomeie a sessão na interface do Axe Developer Hub
  • Observe que com as APIs do Axe Developer Hub você não poderá mais atualizar a(s) tag(s) de uma digitalização ou excluir digitalizações individuais
note

As antigas digitalizações permanecerão no mobile-service e ainda poderão ser lidas através da antiga API até 31 de dezembro de 2026.