ipdouble工程openAPI文档
基础信息
● BASE_URL:https://ipdouble.com/slk-browser/openapi
● 认证请求头:secretKey:XXXXX
● 响应格式:统一使用ApiResponse封装,包含成功状态、数据及提示信息
1. 鉴权
需要在ipdouble获取用户秘钥
请求头参数
|
字段名 |
类型 |
描述 |
是否必填 |
|
secretKey |
String |
秘钥 |
是 |
|
Content-Type |
String |
application/json;charset=UTF-8 |
是 |
2. 地区查询接口
接口信息
● 接口地址:{{BASE_URL}}/listGoods
● 请求方式:GET
● 功能描述:查询可购买的代理商品地区及价格信息
请求参数(ListGoodsVO)
无
响应数据
● 类型:ApiResponse<List<ListGoodsVO>>
● 数据说明(ListGoodsVO):
|
字段名 |
类型 |
描述 |
|
region |
String |
地区 |
|
address |
String |
详细地址 |
|
spu |
String |
商品编码 |
|
category |
String |
商品分类 |
|
deviceType |
Integer |
设备类型编码 |
|
deviceTypeStr |
String |
设备类型描述 |
|
priceList |
List<ListGoodsPriceVO> |
价格列表 |
● 价格列表说明(ListGoodsPriceVO):
|
字段名 |
类型 |
描述 |
|
month |
int |
购买月份 |
|
amount |
BigDecimal |
价格金额 |
|
currency |
String |
货币类型(默认 USD) |
3. 购买代理接口
接口信息
● 接口地址:{{BASE_URL}}/buyProxy
● 请求方式:POST
● 功能描述:购买代理服务,返回订单号
请求参数(BuyProxyDTO)
|
字段名 |
类型 |
描述 |
是否必填 |
|
spu |
String |
商品编码 |
是 |
|
month |
int |
购买月份 |
是 |
|
num |
int |
购买数量 |
是 |
|
requestId |
String |
请求唯一标识 |
是 |
响应数据
● 类型:ApiResponse<String>
● 数据说明:返回生成的订单号
4. 续费代理接口
接口信息
● 接口地址:{{BASE_URL}}/renewProxy
● 请求方式:POST
● 功能描述:对已购买的代理进行续费,返回订单号
请求参数(RenewProxyDTO)
|
字段名 |
类型 |
描述 |
是否必填 |
|
ip |
String |
代理 IP 地址 |
是 |
|
month |
int |
续费月份 |
是 |
|
requestId |
String |
请求唯一标识 |
是 |
响应数据
● 类型:ApiResponse<String>
● 数据说明:返回生成的续费订单号
5. 获取订单列表接口
接口信息
● 接口地址:{{BASE_URL}}/listOrder
● 请求方式:GET
● 功能描述:查询订单列表,支持分页查询
请求参数(QueryListOrderDTO)
|
字段名 |
类型 |
描述 |
是否必填 |
|
orderNumber |
String |
订单号 |
否 |
|
spu |
String |
商品编码 |
否 |
|
category |
String |
商品分类 |
否 |
|
deviceType |
String |
设备类型 |
否 |
|
region |
String |
地区 |
否 |
|
address |
String |
详细地址 |
否 |
|
pageNo |
int |
页码(默认 1) |
否 |
|
pageSize |
int |
每页条数(默认 20) |
否 |
响应数据
● 类型:ApiResponse<PageVO<ListOrderVO>>
● 分页信息(PageVO):
|
字段名 |
类型 |
描述 |
|
pageNo |
int |
当前页码 |
|
pageSize |
int |
每页条数 |
|
total |
long |
总记录数 |
|
list |
List<ListOrderVO> |
订单列表数据 |
● 订单信息(ListOrderVO):
|
字段名 |
类型 |
描述 |
|
orderNumber |
String |
订单号 |
|
payType |
Integer |
支付方式;3余额支付 |
|
payStatus |
Integer |
支付状态;1已支付 0 未支付 |
|
payTime |
Date |
支付时间 |
|
payAmount |
BigDecimal |
支付金额 |
|
payCurrency |
String |
支付货币类型 |
|
num |
Integer |
购买数量 |
|
month |
int |
购买月份 |
|
spu |
String |
商品编码 |
|
category |
String |
商品分类 |
|
deviceType |
String |
设备类型 |
|
region |
String |
地区 |
|
address |
String |
详细地址 |
|
ipList |
List<String> |
IP 列表 |
6. 代理列表接口
接口信息
● 接口地址:{{BASE_URL}}/listProxy
● 请求方式:GET
● 功能描述:查询已购买的代理列表
请求参数(ListGoodsVO)
|
字段名 |
类型 |
描述 |
是否必填 |
|
region |
String |
地区 |
否 |
|
address |
String |
详细地址 |
否 |
|
spu |
String |
商品编码 |
否 |
|
category |
String |
商品分类 |
否 |
|
deviceType |
Integer |
设备类型(枚举值) |
否 |
响应数据
● 类型:ApiResponse<PageVO<ListProxyVO>>
● 分页信息(PageVO):
|
字段名 |
类型 |
描述 |
|
pageNo |
int |
当前页码 |
|
pageSize |
int |
每页条数 |
|
total |
long |
总记录数 |
|
list |
List<ListProxyVO> |
订单列表数据 |
● 订单信息(ListProxyVO):
|
字段名 |
数据类型 |
字段描述 |
示例值 |
|
ip |
String |
设备/服务的 IP 地址(如 IPv4 或 IPv6) |
192.168.1.100 |
|
region |
String |
所属地域/区域(如城市、机房位置等) |
北京/ 华东-上海 |
|
address |
String |
详细地址(物理地址或逻辑地址描述) |
北京市海淀区中关村南大街5号 |
|
deviceType |
String |
设备类型编码(内部标识,如 01表示服务器,02表示网关等) |
01 |
|
spu |
String |
SPU(标准化产品单元,通常用于商品/设备唯一标识,可选) |
SPU_123456 |
|
expireTime |
Date |
过期时间(格式:yyyy-MM-dd HH:mm:ss,时区:东八区 UTC+8) |
2025-12-31 23:59:59 |
|
createTime |
Date |
创建时间(格式:yyyy-MM-dd HH:mm:ss,时区:东八区 UTC+8) |
2025-01-01 10:30:00 |
|
proxyAddress |
String |
代理服URL |
|
|
proxyAccount |
String |
代理服务器登录账号 |
proxy_user |
|
proxyPassword |
String |
代理服务器登录密码 |
proxy_pass123(示例) |
附录:数据类型说明
1. ApiResponse:统一响应封装类
a. 成功:{ "code":200,"success": true, "data": ... }
b. 失败:{ "code":500,"success": false, "msg": "错误信息" }
2. 日期格式:统一使用yyyy-MM-dd HH:mm:ss格式,time-zone=Asia/Shanghai时区 UTC+8
3. 分页查询:所有分页接口默认页码从 1 开始,默认每页 20 条数据
4. deviceType: 1 机房 3 住宅 9 动态住宅 10 动态机房