API
Send anmodninger til /api/v1 med headeren Authorization: Bearer uxp_.... Opret en nøgle i din konto. Grænsen er 60 anmodninger i minuttet.
Start en kørsel
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"]}'Udelad personas for at bruge alle, der er aktiveret i panelet. Svar: {"id":"r...","status":"queued","credits":2}
Metoder
| Metode | Sti | Hvad det gør |
|---|---|---|
| GET | /balance | Kreditbalance |
| GET | /sites | Dine sider, deres ids og paneler |
| GET | /personas | Persona-biblioteket |
| GET | /runs | Seneste kørsler |
| POST | /runs | Start en kørsel |
| GET | /runs/{id} | Status og resultater per persona |
| POST | /runs/{id}/cancel | Annuller, ubrugte credits returneres |
Fejl
Format: {"error":{"code":"...","message":"..."}}
| HTTP | Kode | Betydning |
|---|---|---|
| 400 | no_personas | Ingen persona valgt, eller et id findes ikke på dette site |
| 400 | not_test_host | Testbetalingsmodus kræver en startside på en testvært |
| 401 | unauthorized | Manglende eller ugyldig nøgle |
| 402 | insufficient_credits | Ikke nok credits |
| 403 | domain_not_verified | Domæne ikke verificeret |
| 404 | not_found | Intet af den slags på din konto |
| 409 | too_many_runs | For mange kørsler i køen |
| 429 | rate_limited | Forespørgselsgrænsen overskredet |
Hvad en kørsel gør ved dit site
Kun GET-anmodninger til det verificerede domæne. Formularer sendes ikke, og feltene til adgangskode og kort forbliver tomme, så en kørsel hverken registrerer sig, logger ind eller betaler. Undtagelsen er testbetalingsfunktionen, som du aktiverer til en testvært. Noterne kommer fra en model; tjek dem, før du handler.
