OpenAPI 接口文档
OpenAPI 接口文档
获取静态代理续费报价
按资源和统一续费时长获取当前续费报价。本接口无副作用,不创建订单,也不扣款。
接口信息
| 项目 | 内容 |
|---|---|
| Method | POST |
| Path | /open-api/v1/static/renewal-quotes |
| 认证 | X-API-Key |
| Content-Type | application/json |
| 处理方式 | 同步 |
| 副作用 | 无;不创建订单、不扣款 |
请求体
| 字段 | 类型 | 必填 | 说明 | 约束 |
|---|---|---|---|---|
resource_ids |
string[] | 是 | 需要续费的静态代理资源 ID | 去除首尾空白并去重后 1~500 个;全部必须可访问、当前为 ACTIVE 且尚未过期 |
duration_days |
integer | 是 | 全部资源的统一续费时长 | 仅 7、30、90;还必须符合下方资源类型组合 |
同一次报价中的全部资源使用相同的 duration_days,可用组合如下:
| 资源类型 | 可用的 duration_days |
|---|---|
全部为 ISP |
7、30 |
全部为 ISP_NATIVE |
7、30、90 |
同时包含 ISP 和 ISP_NATIVE |
7、30 |
duration_days 不是 7、30 或 90 时返回 400009。返回 300320 表示资源价格不存在或与请求规格不匹配;实际 msg 按 X-LANG 返回,省略或不支持时使用 en_US。
请求体只能包含上表中的两个字段,不接受 request_no、callback_url、报价金额或其他未列出的字段。
请求示例
curl --request POST \
--url 'https://api-test.puraroute.com/gin/open-api/v1/static/renewal-quotes' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--data '{
"resource_ids": [
"1912345678901234567",
"1912345678901234568"
],
"duration_days": 30
}'
响应参数
data 仅包含以下字段:
| 字段 | 类型 | 说明 |
|---|---|---|
order_amount |
string | 当前报价总金额,固定保留 4 位小数 |
currency |
string | 固定为 USD |
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"order_amount": "16.0000",
"currency": "USD"
},
"next": null
}
示例金额只说明字段格式,不代表实际价格。
报价有效性
报价不锁定价格。正式调用创建静态代理续费订单时,会重新检查资源状态并按当时价格计算订单金额,实际金额可能与本次报价不同。
可能的错误码
code |
说明 |
|---|---|
300001 |
某个资源不存在、不属于当前账号或不可访问、不是 ACTIVE,或已经过期 |
300320 |
资源价格不存在或与请求规格不匹配。 |
400001 |
认证失败 |
400009 |
时长不是 7、30、90,请求字段或其他参数不符合要求 |
500000 |
系统处理失败,本次未取得报价 |