OpenAPI 接口文档
OpenAPI 接口文档
快速开始
本页使用“查询钱包余额”接口验证 Base URL、网络连接和 API Key。
1. 准备 API Key
先按身份认证在测试环境网页控制台创建并保存 API Key。
2. 发起请求
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/wallet/balance' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--header 'X-LANG: zh_CN'
3. 判断结果
成功响应示例:
{
"code": 0,
"msg": "success",
"data": {
"available_balance": "125.5000",
"currency": "USD"
},
"next": null
}
必须同时完成以下判断:
- 请求已收到 HTTP 响应。
- 响应体可以解析为 JSON。
code等于0。
不要只以 HTTP 状态码判断业务成功。请求到达 Open API 并由 Open API 正常生成响应时,业务结果返回 HTTP 200;传输层故障仍可能得到非 200、非 JSON 或空响应,详见响应结构。
4. 保存追踪编号
Open API 正常响应的响应头包含 X-TRACE-ID。建议在调用方日志中保存可获得的追踪编号,用于问题排查,但不要同时记录 API Key 或代理密码。