快速开始
本指南将帮助您快速了解如何使用API开通代理服务。
1. 申请appKey
首先，您需要向我方申请 appKey 和 appSecret 来获得访问权限。
沙盒环境地址： https://sandbox.ipipv.com/
生产环境地址： https://api.ipipv.com/
2. 获取产品列表
使用 get_products 接口获取可购买的产品列表：
请求路径
/api/open/app/product/query/v2
请求参数
| 参数 | 二级参数 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| proxyType | - | []int | 是 | 代理类型，详见字典 |
| productNo | - | string | 否 | 产品编号 如果传了产品编号，则只返回该编号对应的产品信息 |
| countryCode | - | string | 否 | 国家代码 可选 |
| cityCode | - | string | 否 | 城市代码 可选 |
3. 开通实例
使用 create_order 接口开通代理实例：
请求路径
/api/open/app/instance/open/v2
请求参数
| 参数 | 二级参数 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| appOrderNo | - | string(32) | 是 | 渠道商订单号,保持唯一，我方作幂等性检查 |
| params | - | array | 是 | 购买代理产品列表 |
| - | productNo | - | string | 是 |
| - | count | - | int | 是 |
| - | duration | - | int32 | 是 |
| - | cycleTimes | - | int32 | 是 |
4. 处理回调并获取订单信息
订单是异步处理的，当订单状态发生变化时，系统会向您配置的回调地址发送通知。
请参考 回调文档 了解回调机制。
收到回调后，使用 getorder 接口获取订单详细信息：
请求路径
/api/open/app/order/v2
请求参数
| 参数 | 二级参数 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| orderNo | - | string(32) | 是 | 平台订单编号 两个订单号必须至少传一个 |
| appOrderNo | - | string(32) | 是 | 渠道商（购买订单）订单号 两个订单号必须至少传一个 |
5. 获取实例信息
最后，根据订单信息中的实例编号，使用 get_instance 接口获取实例详细信息：
请求路径
/api/open/app/instance/v2
请求参数
| 参数 | 二级参数 | 类型 | 必填 | 说明 |
|---|---|---|---|---|
| instances | - | []string | 是 | 供应商实例编号(供应商系统内部唯一) |