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 将使用面板上启用的所有 persona。响应: {"id":"r...","status":"queued","credits":2}

方法

方法路径功能说明
GET/balance积分余额
GET/sites您的网站、它们的 ID 和面板
GET/personasPersona 库
GET/runs最新运行
POST/runs开始运行
GET/runs/{id}各 Persona 的状态与结果
POST/runs/{id}/cancel取消,未使用的 credits 将退回

错误

格式: {"error":{"code":"...","message":"..."}}

HTTP代码含义
400no_personas未选择 Persona,或该 ID 不在本网站上
400not_test_host测试支付模式需要在测试主机上设置起始页面
401unauthorized缺少或无效的密钥
402insufficient_creditsCredits 不足
403domain_not_verified域名未验证
404not_found您的账户中没有此类内容
409too_many_runs队列中的运行次数过多
429rate_limited请求限制已超出

运行对您的网站做了什么

仅对已验证域名发起 GET 请求。表单不会提交,密码和银行卡字段保持为空,因此运行不会注册、登录或支付。例外情况是测试支付模式,您可为测试主机开启此模式。备注由模型生成,请在采取行动前进行检查。