Comece com Automação de Gestão de Projetos

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

Use sua chave de API da Conta Axe existente para automatizar a gestão de projetos e membros

Not for use with personal data

Se a sua organização gerencia um grande número de projetos no Axe Developer Hub ou integra e remove colaboradores frequentemente, você pode automatizar esse trabalho com a API de Projetos em vez de clicar pela interface do Axe Developer Hub.

note

Não há novas credenciais para configurar. A automação de gestão usa a mesma chave de API da Conta Axe que você já utiliza para o restante das APIs REST do Axe Developer Hub. Isso inclui a API de Sessões e Resultados e a API de Status de Commit. Se você já pode enviar resultados de teste para o Axe Developer Hub, você já tem o que precisa.

O Que Você Pode Automatizar

Usando sua chave de API, sua automação pode:

Criar, atualizar e excluir projetos.
Listar todos os projetos em sua organização (como um administrador de organização) ou todos os projetos aos quais você pertence.
Listar os membros de um projeto, adicionar um membro com um papel, mudar o papel de um membro e remover um membro.

Veja a Referência da API de Projetos para obter detalhes completos de solicitações e respostas para cada operação.

Antes de Começar

Criando um projeto requer uma assinatura ativa (licença) para o tipo desse projeto. Quem cria um projeto se torna automaticamente o administrador do projeto.
Papéis nos projetos são administrador e membro. Um administrador de projeto pode atualizar ou excluir o projeto e gerenciar sua membresia. Um membro de projeto pode acessar o projeto, mas não pode geri-lo ou gerir sua membresia.
Admins de Organização pode ver e gerenciar todos os projetos dos tipos licenciados de sua organização, independentemente de sua própria membresia de projeto. Eles não precisam de uma licença pessoal para ver, atualizar, excluir ou gerenciar os membros de um projeto existente. Criar um projeto é a única exceção: sempre requer uma licença ativa, seja o chamador um admin de organização ou não.
Adicionar um membro a um projeto não requer que esse membro possua uma licença. A API os registra como membro do projeto imediatamente, mas eles não podem acessar o projeto até que possuam uma licença. O usuário alvo deve já pertencer à organização. Você não pode adicionar alguém que ainda não seja membro da organização.
Excluir um projeto é definitivo. Não há restauração automática para um projeto excluído.

Cada tipo de projeto aceita apenas valores específicos de test_language e test_platform, listados em Valores de Configuração do Tipo de Projeto. Escolha o tipo cuidadosamente: o tipo de um projeto não pode ser alterado depois de criado.

Obtenha Sua Chave de API

Entre no Portal de Contas Axe.
Copie uma chave de API do Axe Developer Hub para projetos web ou CI/CD, ou uma chave de API do Axe DevTools Mobile para projetos móveis. Use o valor do cabeçalho X-API-Key dessa chave em todas as solicitações para a API de Projetos.

Crie Seu Primeiro Projeto Automaticamente

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright"
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects"

A resposta inclui o novo project_id. Salve-o: você precisará dele para todas as chamadas subsequentes contra este projeto, incluindo o envio de resultados de teste.

Adicione Colegas ao Projeto

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "user_email_role_pairs": [
      { "user_email": "sam@example.com", "role": "member" }
    ]
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects/$PROJECT_ID/memberships"

Identifique cada usuário pelo seu endereço de e-mail da Conta Axe. O usuário alvo deve já pertencer à sua organização. Adicioná-los não requer que possuam uma licença, mas eles não podem acessar o projeto até que a tenham.

Próximos Passos

Referência da API de Projetos para a referência completa dos endpoints, incluindo recuperar, atualizar e excluir projetos, e gerenciar membros em escala com as operações em lote.
Referência da API de Sessões e Resultados para recuperar resultados de acessibilidade uma vez que seus projetos automatizados estejam produzindo-os.