API

Wysyłaj żądania do /api/v1 z nagłówkiem Authorization: Bearer uxp_.... Utwórz klucz w swoim koncie. Limit to 60 żądań na minutę.

Uruchom test

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

Pomiń personas, aby użyć wszystkich włączonych w panelu. Odpowiedź: {"id":"r...","status":"queued","credits":2}

Metody

MetodaŚcieżkaCo robi
GET/balanceSaldo kredytów
GET/sitesTwoje strony, ich identyfikatory i panele
GET/personasBiblioteka person
GET/runsNajnowsze uruchomienia
POST/runsUruchom test
GET/runs/{id}Status i wyniki dla każdej persony
POST/runs/{id}/cancelAnuluj, niewykorzystane kredyty wracają

Błędy

Format: {"error":{"code":"...","message":"..."}}

HTTPKodZnaczenie
400no_personasNie wybrano żadnej persony lub id nie istnieje na tej stronie
400not_test_hostTryb płatności testowej wymaga strony startowej na hoście testowym
401unauthorizedBrakujący lub nieprawidłowy klucz
402insufficient_creditsZa mało kredytów
403domain_not_verifiedDomena niezweryfikowana
404not_foundNic takiego nie ma na Twoim koncie
409too_many_runsZbyt wiele uruchomień w kolejce
429rate_limitedPrzekroczono limit żądań

Co uruchomienie robi z Twoją stroną

Tylko żądania GET do zweryfikowanej domeny. Formularze nie są wysyłane, pola hasła i karty pozostają puste, więc uruchomienie nigdy się nie rejestruje, nie loguje się ani nie płaci. Wyjątkiem jest tryb płatności testowej, który włączasz dla hosta testowego. Uwagi generuje model, sprawdź je przed podjęciem działań.