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

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

O Que Você Pode Automatizar

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

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

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

Antes de Começar

• Criar um projeto requer uma assinatura ativa (licença) para o tipo daquele projeto. Quem quer que crie um projeto se torna automaticamente seu administrador de projeto.
• Funções de projeto são administrador e membro. Um administrador de projeto pode atualizar ou excluir o projeto e gerenciar seus membros. Um membro de projeto pode acessar o projeto, mas não pode geri-lo ou gerenciar seus membros.
• Administradores da Organização podem ver e gerenciar todos os projetos dos tipos licenciados de sua organização, independentemente de sua própria associação ao projeto. Eles não precisam de uma licença pessoal para visualizar, 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 administrador da organização ou não.
• Adicionar um membro a um projeto não exige 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é possuírem uma licença. O usuário alvo já deve 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 mudar depois de criado.

Obtenha Sua Chave API

1. Entre no Portal de Contas Axe.
2. Copie uma chave API do Axe Developer Hub para projetos web ou CI/CD, ou uma chave API do Axe DevTools Mobile para projetos móveis. Use este valor no cabeçalho X-API-Key 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 testes.

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 e-mail da Conta Axe. O usuário alvo já deve pertencer à sua organização. Adicioná-los não exige que possuam uma licença, mas eles não podem acessar o projeto até que possuam.

Próximos Passos

• Comece com as APIs do Axe Developer Hub para autenticação, tratamento de erros e as outras tarefas que você pode automatizar com a mesma chave API.
• Referência da API de Projetos para a referência completa de endpoints, incluindo recuperar, atualizar e excluir projetos, e gerenciar membros em larga escala com as operações em lote.
• Referência da API de Sessões e Resultados para recuperar resultados de acessibilidade assim que seus projetos automatizados começarem a produzi-los.