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 अनुरोध। फॉर्म भेजे नहीं जाते और पासवर्ड व कार्ड के फ़ील्ड खाली रहते हैं, इसलिए एक रन कभी रजिस्टर, साइन इन या भुगतान नहीं करता। अपवाद टेस्ट पेमेंट मोड है, जिसे आप टेस्ट होस्ट के लिए चालू करते हैं। नोट्स मॉडल से आते हैं, कार्रवाई करने से पहले उन्हें जांचें।
