Antes de começar
O que é preciso
- O módulo Connections no seu workspace: está incluído nos planos Team, Business, Partner e Enterprise, e como o módulo Integrations for one UAT com o plano Project.
- Direitos de administrador no projeto do UAT Studio.
- Uma conta Make. O plano gratuito serve.
Configuração · uma vez por projeto
Conectar o UAT Studio ao Make
1
Crie uma API key no UAT Studio
- Entre em app.uat.studio, abra o projeto e vá a Setup.
- No cartão API keys, escreva um nome como Make e clique em Create API key.
- Clique em Copy. O UAT Studio só mostra a chave uma vez; mantenha a janela aberta até a ter colado.
2
Adicione um módulo HTTP a um cenário
- No Make, clique em Create a new scenario e clique no + grande.
- Procure HTTP e escolha Make a request.
Uma app UAT Studio para o Make está para breveAté lá, o módulo HTTP faz o mesmo. Quando a app estiver disponível, escolhe antes o UAT Studio e cola a mesma API key.
3
Preencha o pedido
Preencha os campos de Make a request de cima para baixo. Deixe como estão os campos que não constam da tabela.
| Campo | O que preencher |
|---|---|
| Authentication type | No authentication. A chave vai no header abaixo. |
| URL | https://app.uat.studio/api/v1/issues?order=created, ou outro endereço da tabela abaixo. |
| Method | GET para ler, POST para criar, PATCH para alterar. |
| Headers | Clique em Add a header. Name: Authorization. Value: Bearer, um espaço e a sua API key. |
| Query parameters | Deixe vazio. |
| Body content type | Para ler (GET): deixe vazio. Para criar ou alterar: application/json. |
| Body input method | Apenas para criar ou alterar: JSON string. |
| Body content | Apenas para criar ou alterar: os campos em JSON, por exemplo {"title": "Save fails", "severity": "High"}. |
| Parse response | Yes, para que os módulos seguintes possam usar os campos das ocorrências. |
| Pagination type | Deixe vazio. |
Clique em Save.
4
Execute e defina o agendamento
- Clique em Run once. O resultado mostra as ocorrências do seu projeto.
- Adicione os módulos seguintes: um Iterator sobre a lista de ocorrências, um Filter (por exemplo, gravidade igual a Critical) e a app que deve agir, como o Slack ou o Google Sheets.
- Para agir apenas sobre novas ocorrências, acrescente
&since=com a hora da execução anterior, ou use o Data store do Make para memorizar as chaves já tratadas. - Defina o agendamento (por exemplo, a cada 15 minutos) e ative o cenário.
O que pode usar · https://app.uat.studio/api/v1
Os endereços da API
| Tipo | Pedido | O que faz |
|---|---|---|
| Ler | GET /issues?order=created | As ocorrências mais recentes. order=updated: as últimas alteradas. Também since, status e limit (até 100). |
| Ler | GET /issues/ISS-012 | Uma ocorrência. |
| Ler | GET /signoffs | Os sign-offs, os mais recentes primeiro. |
| Criar | POST /issues | Uma nova ocorrência: title e, opcionalmente, description, severity, priority, test_number, step_number, assignee. |
| Alterar | PATCH /issues/ISS-012 | status, severity ou assignee, com um comment opcional. |
| Alterar | POST /issues/ISS-012/comments | Um comment no histórico. |
| Criar | POST /testers | Um tester: name e, opcionalmente, email e group. |
Cada ocorrência vem com a chave (ISS-012), título, descrição, gravidade, prioridade, estado, responsável, o teste e o tester que a encontrou, o ticket no Jira ou no Azure DevOps e um link para o UAT Studio.
Ideias
O que as equipas constroem com isto
- Uma mensagem para cada ocorrência Critical num canal de chat, com um filtro por gravidade.
- Cada sign-off numa folha de cálculo ou na sua ferramenta de gestão de projetos, para que a direção do projeto veja que UATs estão aceites.
- Testers a partir de um formulário ou do seu sistema de RH: uma nova linha torna-se um tester no grupo certo.
- Ocorrências a partir de uma ferramenta de suporte: um ticket com uma tag torna-se uma ocorrência no UAT, associada ao seu teste.
Se algo falhar
Mensagens comuns
| Mensagem | O que fazer |
|---|---|
| The API key is not valid | A chave foi revogada ou foi mal escrita. Crie uma nova chave em Setup › API keys e volte a conectar. |
| Connections … are not part of the plan | O workspace não tem o módulo Connections. Adicione-o em Plan & billing. |
| This workspace is read-only | O plano terminou. Ler ainda funciona; criar e alterar não. |
| There is no issue ISS-… | A chave pertence a outro projeto, ou a ocorrência foi fundida. Verifique a API key e a chave da ocorrência. |
| Não acontece nada depois de uma nova ocorrência | O cenário é executado conforme o agendamento. Verifique se está ativo e se a chave pertence ao projeto certo. |
Segurança
Como a chave é protegida
- Uma chave dá acesso a um projeto, a nada mais no seu workspace.
- O UAT Studio guarda apenas uma impressão digital da chave, nunca a própria chave. Setup mostra os últimos quatro caracteres e quando foi usada pela última vez.
- Revoke em Setup desativa uma chave de imediato.
- Cada ocorrência ou tester criado ou alterado através de uma chave aparece no histórico da ocorrência e no audit log, com o nome da chave.
- Nunca coloque uma chave num email, num chat ou em código; cole-a apenas no Make.