API
Envoyer les requêtes à /api/v1 avec l'en-tête Authorization: Bearer uxp_.... Créez une clé dans votre compte. La limite est de 60 requêtes par minute.
Lancer un 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"]}'Omettez personas pour utiliser toutes celles activées dans le panel. Réponse : {"id":"r...","status":"queued","credits":2}
Méthodes
| Méthode | Chemin | Ce qu'elle fait |
|---|---|---|
| GET | /balance | Solde de crédits |
| GET | /sites | Vos sites, leurs ids et panels |
| GET | /personas | La bibliothèque de personas |
| GET | /runs | Derniers tests |
| POST | /runs | Lancer un test |
| GET | /runs/{id} | Statut et résultats par persona |
| POST | /runs/{id}/cancel | Annuler, les crédits non utilisés sont rendus |
Erreurs
Format: {"error":{"code":"...","message":"..."}}
| HTTP | Code | Signification |
|---|---|---|
| 400 | no_personas | Aucun persona sélectionné, ou un id n'est pas sur ce site |
| 400 | not_test_host | Le mode de paiement de test nécessite une page de démarrage sur un hôte de test |
| 401 | unauthorized | Clé manquante ou invalide |
| 402 | insufficient_credits | Pas assez de crédits |
| 403 | domain_not_verified | Domaine non vérifié |
| 404 | not_found | Rien de tel sur votre compte |
| 409 | too_many_runs | Trop de tests en file d'attente |
| 429 | rate_limited | Limite de requêtes dépassée |
Ce qu'un test fait à votre site
Seules les requêtes GET vers le domaine vérifié. Les formulaires ne sont pas envoyés et les champs mot de passe et carte restent vides, donc un test ne s'inscrit jamais, ne se connecte ni ne paie. L'exception est le mode de paiement test, que vous activez pour un hôte de test. Les notes proviennent d'un modèle, vérifiez-les avant d'agir.
