OpenAPI 接口文档
OpenAPI 接口文档
Open API 接口文档
本文档面向通过服务端程序接入 Open API 的开发者，介绍认证方式、业务流程、接口参数、响应结构和异常处理方法。
开始接入
按任务阅读
重要约定
- 所有业务接口都通过
X-API-Key请求头认证。 - 当请求到达 Open API 且由 Open API 正常生成响应时，业务结果返回 HTTP
200；必须以响应体中的code判断结果，code = 0才表示成功。传输层故障不适用这一约定。 - 创建动态流量采购、动态子账号、静态代理购买订单或静态代理续费订单时，必须使用
request_no。相同请求号在保护期内重复提交会被拒绝。 - 静态代理订单回调只用于提醒。无论是否收到回调，都应以订单查询接口返回的结果为准。
服务地址
| 环境 | Base URL |
|---|---|
| 测试环境 | https://api-test.puraroute.com/gin |
| 生产环境 | https://api.puraroute.com/gin |
本文档中的命令默认使用测试环境。正式上线前，请将 Base URL 替换为生产环境地址。