API
Invia richieste a /api/v1 con l'intestazione Authorization: Bearer uxp_.... Crea una chiave nel tuo account. Il limite è di 60 richieste al minuto.
Avvia un'esecuzione
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"]}'Ometti personas per usare tutte quelle abilitate nel pannello. Risposta: {"id":"r...","status":"queued","credits":2}
Metodi
| Metodo | Percorso | Cosa fa |
|---|---|---|
| GET | /balance | Saldo crediti |
| GET | /sites | I tuoi siti, i loro ID e i panel |
| GET | /personas | Libreria delle personas |
| GET | /runs | Esecuzioni recenti |
| POST | /runs | Avvia un'esecuzione |
| GET | /runs/{id} | Stato e risultati per persona |
| POST | /runs/{id}/cancel | Annulla, i crediti non utilizzati vengono restituiti |
Errori
Formato: {"error":{"code":"...","message":"..."}}
| HTTP | Codice | Significato |
|---|---|---|
| 400 | no_personas | Nessuna persona selezionata o ID non presente su questo sito |
| 400 | not_test_host | La modalità di pagamento di prova richiede una pagina iniziale su un host di prova |
| 401 | unauthorized | Chiave mancante o non valida |
| 402 | insufficient_credits | Crediti insufficienti |
| 403 | domain_not_verified | Dominio non verificato |
| 404 | not_found | Nessuna corrispondenza sul tuo account |
| 409 | too_many_runs | Troppe esecuzioni in coda |
| 429 | rate_limited | Limite di richieste superato |
Cosa fa un'esecuzione al tuo sito
Solo richieste GET al dominio verificato. I moduli non vengono inviati e i campi password e carta restano vuoti, quindi un'esecuzione non si registra, non effettua il login né paga. L'eccezione è la modalità di pagamento di prova, che attivi per un host di prova. Le note provengono da un modello, controllale prima di agire.
