OpenAPI 接口文档
OpenAPI 接口文档
查询动态流量产品
查询当前可购买的动态流量产品和阶梯单价。购买时应使用本接口返回的 product_code。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/dynamic/traffic/products |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
请求参数
无 Query 和请求体。产品名称根据 X-LANG 返回。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/traffic/products' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--header 'X-LANG: zh_CN'
响应参数
data 为产品数组。
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
product_code |
string | 否 | 稳定产品编码,购买时原样传入 |
name |
string | 否 | 产品名称 |
fixed_traffic_gb |
string | 是 | 固定规格的流量;自定义规格为空 |
allow_custom_quantity |
boolean | 否 | 是否允许指定购买流量 |
min_purchase_gb |
string | 是 | 最小购买流量 |
max_purchase_gb |
string | 是 | 最大购买流量 |
purchase_step_gb |
string | 是 | 购买流量步长 |
valid_days |
integer | 是 | 购买后的有效天数;null 表示永久有效 |
currency |
string | 否 | 结算币种 |
tiers |
array | 否 | 阶梯价格数组 |
tiers 元素:
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
min_exclusive |
string | 是 | 阶梯流量下界,不含该值 |
max_inclusive |
string | 是 | 阶梯流量上界,包含该值;空表示无上限 |
unit_price |
string | 否 | 本阶梯每 GB 单价,USD 十进制字符串 |
计价方式
动态流量使用累计阶梯计价,不会把整笔购买量全部套用到某一个阶梯。购买量跨越多个阶梯时,分别计算每个阶梯实际覆盖的流量与该阶梯 unit_price 的乘积,再将各阶梯金额相加:
总金额 = Σ(各阶梯实际覆盖流量 × 该阶梯单价)
相加后的总金额使用 HALF_UP 四舍五入到小数点后 4 位。产品查询返回的阶梯价格只用于预估;提交购买请求时会按当时有效的价格重新计算,实际金额以购买响应中的 order_amount 为准。
成功响应示例
下列值用于说明响应格式。实际可用产品和规格以接口实时返回为准。
{
"code": 0,
"msg": "success",
"data": [
{
"product_code": "DYNAMIC_1GB",
"name": "Dynamic Traffic",
"fixed_traffic_gb": "1.000000",
"allow_custom_quantity": false,
"min_purchase_gb": null,
"max_purchase_gb": null,
"purchase_step_gb": null,
"valid_days": 30,
"currency": "USD",
"tiers": [
{
"min_exclusive": "0.000000",
"max_inclusive": null,
"unit_price": "0.850000"
}
]
}
],
"next": null
}
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
请求包含不支持的参数 |
500000 |
系统处理失败,请求未完成 |