API
Send forespørsler til /api/v1 med headeren Authorization: Bearer uxp_.... Opprett en nøkkel i kontoen din. Grensen er 60 forespørsler i minuttet.
Start en kjøring
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"]}'La ut personas for å bruke alle som er aktivert på panelet. Svar: {"id":"r...","status":"queued","credits":2}
Metoder
| Metode | Sti | Hva det gjør |
|---|---|---|
| GET | /balance | Kredittbalanse |
| GET | /sites | Dine nettsteder, deres id-er og paneler |
| GET | /personas | Personabiblioteket |
| GET | /runs | Siste kjøringer |
| POST | /runs | Start en kjøring |
| GET | /runs/{id} | Status og resultater per persona |
| POST | /runs/{id}/cancel | Avbryt, ubrukte kreditter returneres |
Feil
Format: {"error":{"code":"...","message":"..."}}
| HTTP | Kode | Betydning |
|---|---|---|
| 400 | no_personas | Ingen persona valgt, eller en id er ikke på dette nettstedet |
| 400 | not_test_host | Testbetalingsmodus trenger en startside på en testvert |
| 401 | unauthorized | Mangler eller ugyldig nøkkel |
| 402 | insufficient_credits | Ikke nok kreditter |
| 403 | domain_not_verified | Domene ikke verifisert |
| 404 | not_found | Ingenting av dette på kontoen din |
| 409 | too_many_runs | For mange kjøringer i køen |
| 429 | rate_limited | Forespørselsgrense overskredet |
Hva en kjøring gjør med nettstedet ditt
Kun GET-forespørsler til det verifiserte domenet. Skjema sendes ikke, og felt for passord og kort forblir tomme, så en kjøring registrerer seg aldri, logger ikke inn eller betaler. Unntaket er testbetalingsmodus, som du slår på for en testvert. Notatene kommer fra en modell, sjekk dem før du handler.
