API

Posílejte požadavky na /api/v1 s hlavičkou Authorization: Bearer uxp_.... Vytvořte klíč ve svém účtu. Limit je 60 požadavků za minutu.

Spustit běh

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

Vynechejte personas pro použití všech povolených v panelu. Odpověď: {"id":"r...","status":"queued","credits":2}

Metody

MetodaCestaCo dělá
GET/balanceZůstatek kreditů
GET/sitesVaše weby, jejich ID a panely
GET/personasKnihovna person
GET/runsNejnovější běhy
POST/runsSpustit běh
GET/runs/{id}Stav a výsledky podle persony
POST/runs/{id}/cancelZrušit, nedokončené kredity se vrátí

Chyby

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

HTTPKódVýznam
400no_personasNebyla vybrána žádná persona nebo toto id na tomto webu není
400not_test_hostRežim testovací platby vyžaduje startovací stránku na testovacím hostiteli
401unauthorizedChybí nebo je neplatný klíč
402insufficient_creditsNedostatek kreditů
403domain_not_verifiedDoména není ověřena
404not_foundNa vašem účtu nic takového není
409too_many_runsPříliš mnoho běhů ve frontě
429rate_limitedPřekročen limit požadavků

Co běh dělá s vaším webem

Pouze GET požadavky na ověřenou doménu. Formuláře se neodesílají a pole pro heslo a kartu zůstávají prázdná, takže běh se nikdy neregistruje, nepřihlašuje se ani neplatí. Výjimkou je režim testovací platby, který si zapnete pro testovací hostitele. Poznámky generuje model, zkontrolujte je před zásahem.