API
Stuur verzoeken naar /api/v1 met de header Authorization: Bearer uxp_.... Maak een sleutel aan in je account. De limiet is 60 verzoeken per minuut.
Start een run
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"]}'Laat personas weg om iedereen te gebruiken die op het panel is ingeschakeld. Antwoord: {"id":"r...","status":"queued","credits":2}
Methoden
| Methode | Pad | Wat het doet |
|---|---|---|
| GET | /balance | Creditbalance |
| GET | /sites | Jouw sites, hun ids en panels |
| GET | /personas | De persona-bibliotheek |
| GET | /runs | Laatste runs |
| POST | /runs | Start een run |
| GET | /runs/{id} | Status en resultaten per persona |
| POST | /runs/{id}/cancel | Annuleren, ongebruikte credits worden teruggestort |
Fouten
Formaat: {"error":{"code":"...","message":"..."}}
| HTTP | Code | Betekenis |
|---|---|---|
| 400 | no_personas | Geen persona geselecteerd, of een id bestaat niet op deze site |
| 400 | not_test_host | Testbetalingsmodus vereist een startpagina op een testhost |
| 401 | unauthorized | Ontbrekende of ongeldige sleutel |
| 402 | insufficient_credits | Onvoldoende credits |
| 403 | domain_not_verified | Domein niet geverifieerd |
| 404 | not_found | Niets dergelijks op je account |
| 409 | too_many_runs | Te veel runs in de wachtrij |
| 429 | rate_limited | Aanvraaglimiet overschreden |
Wat een run met je site doet
Alleen GET-aanvragen naar het geverifieerde domein. Formulieren worden niet verzonden en wachtwoord- en kaartvelden blijven leeg, dus een run registreert zich nooit, logt niet in of betaalt niet. De uitzondering is de testbetalingsmodus, die je zelf inschakelt voor een testhost. Opmerkingen komen van een model; controleer ze voordat je handelt.
