API

Posielajte požiadavky na /api/v1 s hlavičkou Authorization: Bearer uxp_.... Vytvorte kľúč vo svojom účte. Limit je 60 požiadaviek za minútu.

Spustiť beh

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"]}'

Vynechajte personas pre použitie všetkých povolených v paneli. Odpoveď: {"id":"r...","status":"queued","credits":2}

Metódy

MetódaCestaČo robí
GET/balanceZostatok kreditov
GET/sitesVaše stránky, ich ID a panely
GET/personasKnihovňa person
GET/runsNajnovšie behy
POST/runsSpustiť beh
GET/runs/{id}Stav a výsledky podľa persony
POST/runs/{id}/cancelZrušiť, nedokončené kredity sa vrátia

Chyby

Formát: {"error":{"code":"...","message":"..."}}

HTTPKódVýznam
400no_personasNebola vybraná žiadna persona alebo toto id na tejto stránke nie je
400not_test_hostRežim testovacej platby vyžaduje štartovaciu stránku na testovacom hostiteľovi
401unauthorizedChýba alebo je neplatný kľúč
402insufficient_creditsNedostatok kreditov
403domain_not_verifiedDoména nie je overená
404not_foundNa vašom účte nič také nie je
409too_many_runsPríliš veľa behov v rade
429rate_limitedPrekročený limit požiadaviek

Čo beh urobí s vaším webom

Len GET požiadavky na overenú doménu. Formuláre sa neodosielajú a polia pre heslá a karty zostávajú prázdne, takže beh sa nikdy neregistruje, neprihlasuje sa ani neplatí. Výnimkou je režim testovacej platby, ktorý si zapnete pre testovací hostiteľ. Poznámky generuje model, skontrolujte ich pred akciou.