API
Запити йдуть на /api/v1 із заголовком Authorization: Bearer uxp_.... Ключ створюється в кабінеті. Ліміт 60 запитів на хвилину.
Запустити прогін
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"]}'Без personas підуть усі ввімкнені в панелі. Відповідь: {"id":"r...","status":"queued","credits":2}
Методи
| Метод | Шлях | Що робить |
|---|---|---|
| GET | /balance | Баланс балів |
| GET | /sites | Ваші сайти, їхні id та панелі |
| GET | /personas | Бібліотека персон |
| GET | /runs | Останні прогони |
| POST | /runs | Запустити прогін |
| GET | /runs/{id} | Стан і результати за персонами |
| POST | /runs/{id}/cancel | Скасувати, незавершені бали повернуться |
Помилки
Формат: {"error":{"code":"...","message":"..."}}
| HTTP | Код | Значення |
|---|---|---|
| 400 | no_personas | Персону не вибрано або такого id немає на цьому сайті |
| 400 | not_test_host | Режим тестової оплати потребує стартової сторінки на тестовому хості |
| 401 | unauthorized | Немає або недійсний ключ |
| 402 | insufficient_credits | Замало балів |
| 403 | domain_not_verified | Домен не підтверджено |
| 404 | not_found | Такого об'єкта немає у вашому обліковому записі |
| 409 | too_many_runs | Забагато прогонів у черзі |
| 429 | rate_limited | Перевищено ліміт запитів |
Що прогін робить із сайтом
Лише GET-запити до підтвердженого домену. Форми не надсилаються, поля паролів і карток лишаються порожніми, тому прогін не реєструється, не входить і не платить. Виняток це режим тестової оплати, який ви самі вмикаєте для тестового хоста. Зауваження пише модель, перевіряйте їх перед виправленнями.