API
Gửi yêu cầu đến /api/v1 với header Authorization: Bearer uxp_.... Tạo khóa trong tài khoản của bạn. Giới hạn là 60 yêu cầu mỗi phút.
Bắt đầu một run
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"]}'Bỏ qua personas để dùng tất cả persona đang bật trong panel. Phản hồi: {"id":"r...","status":"queued","credits":2}
Phương thức
| Phương thức | Đường dẫn | Nó làm gì |
|---|---|---|
| GET | /balance | Số dư credits |
| GET | /sites | Trang web của bạn, ID và panel |
| GET | /personas | Thư viện persona |
| GET | /runs | Các lần chạy gần nhất |
| POST | /runs | Bắt đầu một run |
| GET | /runs/{id} | Trạng thái và kết quả theo từng persona |
| POST | /runs/{id}/cancel | Hủy, số credits chưa dùng sẽ được hoàn lại |
Lỗi
Định dạng: {"error":{"code":"...","message":"..."}}
| HTTP | Mã | Ý nghĩa |
|---|---|---|
| 400 | no_personas | Chưa chọn persona, hoặc id không tồn tại trên trang web này |
| 400 | not_test_host | Chế độ thanh toán thử nghiệm cần một trang bắt đầu trên máy chủ thử nghiệm |
| 401 | unauthorized | Thiếu khóa hoặc khóa không hợp lệ |
| 402 | insufficient_credits | Không đủ credits |
| 403 | domain_not_verified | Tên miền chưa được xác minh |
| 404 | not_found | Không có mục nào như vậy trong tài khoản của bạn |
| 409 | too_many_runs | Quá nhiều lần chạy trong hàng đợi |
| 429 | rate_limited | Vượt quá giới hạn yêu cầu |
Một lần chạy tác động thế nào lên trang web của bạn
Chỉ thực hiện các yêu cầu GET đến tên miền đã xác minh. Các biểu mẫu không được gửi và các trường mật khẩu, thẻ vẫn để trống, nên một lần chạy không bao giờ đăng ký, đăng nhập hoặc thanh toán. Ngoại lệ là chế độ thanh toán thử nghiệm, do bạn bật cho máy chủ thử nghiệm. Các ghi chú được tạo bởi mô hình, hãy kiểm tra chúng trước khi hành động.
