OpenAPI 接口文档
OpenAPI 接口文档
接入概述
Open API 提供钱包余额查询、动态代理管理和静态代理管理能力,适合由调用方的服务端程序发起请求。
接口范围
| 能力 | 说明 |
|---|---|
| 钱包 | 查询可用于购买的 USD 余额 |
| 动态流量 | 查询产品、购买流量、查询余额、日用量、批次和订单 |
| 动态地区 | 按国家、省州、城市查询可用地区编码 |
| 动态子账号 | 创建、查询、设置流量限额、启停并生成连接凭据 |
| 静态代理 | 查询地区、库存和报价,购买、查询资源并续费 |
| 回调通知 | 在静态代理购买或续费订单结束时发送一次通知 |
API Key 的创建、改名、启停和吊销通过网页控制台完成,不属于本接口文档的业务接口范围。
服务地址
| 环境 | Base URL | 用途 |
|---|---|---|
| 测试环境 | https://api-test.puraroute.com/gin |
开发和联调 |
| 生产环境 | https://api.puraroute.com/gin |
正式业务请求 |
接口文章中的请求路径需要拼接在 Base URL 之后。例如:
https://api-test.puraroute.com/gin/open-api/v1/wallet/balance
建议接入顺序
- 在网页控制台创建测试环境 API Key。
- 按快速开始验证认证和网络连接。
- 根据业务选择动态代理或静态代理流程。
- 完成错误码、超时、重复提交和敏感信息保护处理。
- 使用生产环境 API Key 和 Base URL 上线。
数据安全
API Key、代理账号、代理密码和完整连接凭据都属于敏感信息。调用方不应将它们写入浏览器代码、公开日志、错误页面、监控标签或工单正文。