API
Enviar solicitações para /api/v1 com o cabeçalho Authorization: Bearer uxp_.... Crie uma chave na sua conta. O limite é de 60 solicitações por minuto.
Iniciar um teste
curl -X POST $BASE/api/v1/runs \
-H "Authorization: Bearer $KEY" -H "Content-Type: application/json" \
-d '{"site":"SITE_ID","steps":20,"concurrency":3,"personas":["p01","p03"]}'Deixe de fora personas para usar todas as habilitadas no painel. Resposta: {"id":"r...","status":"queued","credits":2}
Métodos
| Método | Caminho | O que faz |
|---|---|---|
| GET | /balance | Saldo de créditos |
| GET | /sites | Seus sites, seus ids e painéis |
| GET | /personas | A biblioteca de personas |
| GET | /runs | Testes recentes |
| POST | /runs | Iniciar um teste |
| GET | /runs/{id} | Status e resultados por persona |
| POST | /runs/{id}/cancel | Cancelar, créditos não utilizados são devolvidos |
Erros
Formato: {"error":{"code":"...","message":"..."}}
| HTTP | Código | Significado |
|---|---|---|
| 400 | no_personas | Nenhuma persona selecionada, ou um id não está neste site |
| 400 | not_test_host | O modo de pagamento de teste precisa de uma página inicial em um host de teste |
| 401 | unauthorized | Chave ausente ou inválida |
| 402 | insufficient_credits | Créditos insuficientes |
| 403 | domain_not_verified | Domínio não verificado |
| 404 | not_found | Nada disso na sua conta |
| 409 | too_many_runs | Muitos testes na fila |
| 429 | rate_limited | Limite de solicitações excedido |
O que um teste faz no seu site
Apenas solicitações GET para o domínio verificado. Os formulários não são enviados e os campos de senha e cartão permanecem vazios, então um teste nunca se registra, entra ou paga. A exceção é o modo de pagamento de teste, que você ativa para um host de teste. As anotações vêm de um modelo; verifique-as antes de agir.
