API
Lähetä pyynnöt osoitteeseen /api/v1 otsikolla Authorization: Bearer uxp_.... Luo avain tilillesi. Raja on 60 pyyntöä minuutissa.
Aloita suoritus
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"]}'Jätä personas pois, niin mukaan otetaan kaikki paneelissa käytössä olevat personat. Vastaus: {"id":"r...","status":"queued","credits":2}
Metodit
| Metodi | Polku | Mitä se tekee |
|---|---|---|
| GET | /balance | Krediittisaldo |
| GET | /sites | Sivustosi, niiden id:t ja paneelit |
| GET | /personas | Personakirjasto |
| GET | /runs | Viimeisimmät suoritukset |
| POST | /runs | Aloita suoritus |
| GET | /runs/{id} | Tila ja tulokset per persona |
| POST | /runs/{id}/cancel | Peruuta, kesken jääneet krediitit tulevat takaisin |
Virheet
Muoto: {"error":{"code":"...","message":"..."}}
| HTTP | Koodi | Merkitys |
|---|---|---|
| 400 | no_personas | Personaa ei valittu, tai id:tä ei löydy tältä sivustolta |
| 400 | not_test_host | Testimaksutila vaatii aloitussivun testialustalla |
| 401 | unauthorized | Avain puuttuu tai on virheellinen |
| 402 | insufficient_credits | Krediitteja ei riitä |
| 403 | domain_not_verified | Verkkotunnusta ei ole vahvistettu |
| 404 | not_found | Tällaista ei löydy tililtäsi |
| 409 | too_many_runs | Jonossa on liian monta suoritusta |
| 429 | rate_limited | Pyyntörajaa ylitetty |
Mitä suoritus tekee sivustollesi
Vain GET-pyynnöt vahvistetulle verkkotunnukselle. Lomakkeita ei lähetetä, ja salasana- sekä korttikentät pysyvät tyreinä, joten suoritus ei rekisteröidy, kirjaudu sisään tai maksa. Poikkeuksena on testimaksutila, jonka otat käyttöön testivieressä. Huomautukset tulee mallilta, tarkista ne ennen toimia.
