简介

本文档是调用ipipv，开通代理的说明。

开通代理先向我方获取appKey 和 appSecret,在沙盒环境下调试。

沙盒环境地址: https://sandbox.ipipv.com/

沙盒调试成功后，可以切换至生产环境。

注意：生产环境测试会正式开通代理，产生费用。

生产环境地址: https://api.ipipv.com/

sdk

golang

https://github.com/clpublic/ipv-sdk

java（部分完成）

https://github.com/clpublic/ipv-java-sdk

php

https://github.com/clpublic/ipv-php-sdk.git

快速开始

本指南将帮助您快速了解如何使用API开通代理服务。

1. 申请appKey

首先，您需要向我方申请 appKey 和 appSecret 来获得访问权限。

沙盒环境地址： https://sandbox.ipipv.com/

生产环境地址： https://api.ipipv.com/

2. 获取产品列表

使用 get_products 接口获取可购买的产品列表：

请求路径

/api/open/app/product/query/v2

请求参数

3. 开通实例

使用 create_order 接口开通代理实例：

请求路径

/api/open/app/instance/open/v2

请求参数

4. 处理回调并获取订单信息

订单是异步处理的，当订单状态发生变化时，系统会向您配置的回调地址发送通知。

请参考 回调文档 了解回调机制。

收到回调后，使用 getorder 接口获取订单详细信息：

请求路径

/api/open/app/order/v2

请求参数

5. 获取实例信息

最后，根据订单信息中的实例编号，使用 get_instance 接口获取实例详细信息：

请求路径

/api/open/app/instance/v2

请求参数

注意事项

• 订单为异步开通，具体请查看回调章节
• 生产环境测试会正式开通代理，产生费用
• 所有API请求都需要使用AES加密传输，请参考请求统一加密传输

渠道商总体接入流程

本文档基于 cl-cloud 的渠道商开放接口实现和 ipv-sdk 的 Go SDK 封装整理，用于说明渠道商从申请密钥、同步产品、下单、处理回调到后续运维的整体接入顺序。

1. 接入边界

渠道商调用的是平台开放接口，统一路径前缀为：

/api/open/app/{resource}/v2

cl-cloud/modules/open/service/supplier 是平台对上游供应商的适配层，渠道商接入时通常不需要实现该部分接口。渠道商只需要：

• 向平台申请 appKey、appSecret、产品授权和回调地址配置。
• 使用 ipv-sdk 或自行按统一加密规则请求 /api/open/app/.../v2。
• 保存平台返回的 orderNo 和 instanceNo，按回调或轮询补齐订单、实例最终状态。

2. 环境和密钥

生产环境会真实开通代理并产生费用。上线前建议先在沙盒完成加密、下单、回调、订单查询和实例查询的完整闭环。

3. 统一加密请求

所有 v2 业务请求外层都是统一报文：

{
  "version": "v2",
  "encrypt": "AES",
  "appKey": "渠道商 appKey",
  "reqId": "每次请求的唯一编号",
  "params": "业务参数 JSON 经 AES-CBC 加密后 Base64"
}

加密规则：

• params 的明文是具体业务参数 JSON。
• AES-CBC，PKCS5/PKCS7 Padding。
• 密钥使用 appSecret，长度必须是 16、24 或 32 字节。
• IV 使用 appSecret 的前 16 字节。
• 响应成功时，外层 data 也是 AES-CBC 加密后 Base64，需要用同一个 appSecret 解密。

响应外层结构：

{
  "reqId": "请求编号",
  "code": 200,
  "msg": "ok",
  "data": "加密后的业务响应"
}

如果 code != 200，按 msg 和状态码处理错误，不要按成功响应解析 data。/api/open/app/proxy/user/flow/limit/v2 成功时只返回普通成功结果，不返回加密业务数据。

使用 Go SDK 时，SDK 会自动封装加密、解密和基础错误处理：

client, err := sdk.NewClient(
    "https://sandbox.ipipv.com",
    "your_app_key",
    "your_app_secret",
    sdk.Encrypt_AES,
)

4. 接入总流程

申请密钥和配置回调
  -> 联调统一加密和 GetAppInfo
  -> 同步地域、城市、项目和产品
  -> 按产品类型选择静态或动态开通流程
  -> 提交订单，保存平台 orderNo
  -> 等待 order 回调或轮询 GetOrder
  -> 查询订单实例，保存 instanceNo
  -> 使用实例，后续按需续费、释放、更换代理、重置密码或查询动态流量

5. 前置初始化

5.1 获取渠道商信息

调用 GetAppInfo：

POST /api/open/app/info/v2

用于确认渠道商状态、余额、授信额度、桥配置和回调地址。status=1 才表示渠道商可正常使用。

5.2 同步基础字典

建议启动时或定时同步：

产品返回中的关键字段：

• productNo：平台产品编号，下单优先使用该字段。
• proxyType：101/102/103 为静态代理，104/105 为动态代理。
• enable=1：可购买。
• inventory：库存。
• duration、unit：产品最小购买周期。
• productType=2：共享产品，下单需要 projectId。
• cidrBlocks、cidrStatus：是否支持按网段购买。
• assignIp：是否支持指定 IP 购买。
• changeProxy：是否支持更换代理。
• resetPassword：是否支持重置密码。
• 动态能力字段：drawType、ipWhiteList、pwdDrawProxyUser、proxyUserFlowLimit、flowUseLog、proxyGlobalRandom、apiDrawGlobalRandom 等。

6. 静态代理开通流程

适用代理类型：101 静态云平台、102 静态国内家庭、103 静态国外家庭、201 WhatsApp 等非动态产品。

1. 查询并选择产品。 推荐传 productNo 下单。也可以不传 productNo，由平台按 proxyType、countryCode、cityCode、supplierCode、unit、ispType 等条件匹配产品，但推荐只在明确需要自动匹配时使用。

2. 提交开通订单。

POST /api/open/app/instance/open/v2
SDK: InstanceOpen

核心参数：

3. 处理下单响应。 开通接口返回的是异步订单受理结果：

{
  "orderNo": "平台订单号",
  "appOrderNo": "渠道商订单号",
  "amount": "订单金额"
}

此时不代表实例已经可用。渠道商需要保存 orderNo，等待回调或轮询订单。

4. 查询订单和实例。

POST /api/open/app/order/v2
SDK: GetOrder

可用平台 orderNo 或渠道商 appOrderNo 查询。订单 status：

订单成功或部分完成后，读取返回的 instances，保存每个实例的 instanceNo、ip、port、username、pwd、userExpired、productNo。后续续费、释放、更换代理、重置密码都使用平台 instanceNo。

7. 动态代理开通和提取流程

适用代理类型：104 动态国外、105 动态国内。

7.1 创建主账号

动态代理必须先创建渠道商主账号：

POST /api/open/app/user/v2
SDK: CreateUser

核心参数：

创建主账号时，平台会自动创建一个同名代理子账号。若业务需要多个独立子账号，可继续调用 CreateProxyUser。

7.2 可选同步实名

POST /api/open/app/userAuth/v2
SDK: UserAuth

username 和 appUsername 二选一，必须属于当前渠道商。

7.3 可选创建子账号

POST /api/open/app/proxy/user/v2
SDK: CreateProxyUser

核心参数：

7.4 购买动态套餐

动态产品也通过开通接口下单：

POST /api/open/app/instance/open/v2
SDK: InstanceOpen

动态购买项必须关注：

下单后同样等待 order 回调或轮询 GetOrder。动态套餐对应的实例主要用于记录套餐和余额，实际代理地址通过提取接口获取。

7.5 查询余额和区域

余额查询中的 total、used、balance 单位为 MB；流量明细中的 used、total、balance 单位为 B。

7.6 提取动态代理

账密提取：

POST /api/open/app/proxy/draw/pwd/v2
SDK: DrawByPwd

使用渠道商子账号 appUsername。sessTime 默认为 5 分钟，通常支持 1 到 120 分钟；传 0 或 -1 表示每次切换代理。addressCode 可传洲、国家、州省或城市代码，空值表示混播，前提是产品支持。

API 提取：

POST /api/open/app/proxy/draw/api/v2
SDK: DrawByApi

使用渠道商主账号 appUsername。返回 proxyUrl，业务方再访问该 URL 获取代理结果。protocol 默认为 socks5，支持 socks5、http；returnType 支持 txt、json。

如产品要求 IP 白名单，提取前先调用：

POST /api/open/app/proxy/addIpWhiteList/v2
POST /api/open/app/proxy/delIpWhiteList/v2

8. 续费、释放和售后

8.1 续费静态实例

POST /api/open/app/instance/renew/v2
SDK: InstanceRenew

核心规则：

• appOrderNo 同一渠道商下唯一，最长 32 位。
• instances 不能为空，不能重复，单次最多 100 个。
• 只支持静态代理；动态代理不支持续费接口。
• 实例必须属于当前渠道商，且状态为运行中。
• 实例不能超过供应商续费宽限期。
• cycleTimes 优先；不传时默认按原购买周期续费。

续费是异步订单，返回平台 orderNo 后继续按回调或 GetOrder 查询最终结果。

8.2 释放静态实例

POST /api/open/app/instance/release/v2
SDK: InstanceRelease

注意：请求参数里的 orderNo 是渠道商释放订单号，不是平台订单号。

核心规则：

• 渠道商释放订单号同一渠道商下唯一，最长 32 位。
• instances 不能为空，不能重复，单次最多 100 个。
• 只支持运行中的静态代理；动态代理不支持释放接口。
• 已转移、已释放、正在释放、超过无理由释放期限或超过渠道商释放额度的实例会失败。

释放同样是异步订单，最终结果以回调后查询订单为准。

8.3 售后释放

POST /api/open/app/instance/aftersale/v2
SDK: InstanceAfterSale

该能力需要渠道商单独开通。适用于下架、断网、卡顿、地区异常、黑白名单、业务不支持等售后场景。请求中 orderNo 是渠道商售后释放订单号。

9. 可选能力

9.1 指定 IP 购买

先查询指定 IP 是否可购买：

POST /api/open/app/assign/ip/info/v2
SDK: GetAssignIpInfo

确认 canBuyStatus=true 后提交指定 IP 开通：

POST /api/open/app/instance/open/assign/ip/v2
SDK: InstanceOpenAssignIp

指定 IP 购买仅支持静态产品，产品和供应商都必须支持该能力。productNo、assignIp、cycleTimes 必填。

9.2 更换代理

POST /api/open/app/instance/change/v2
SDK: ChangeProxy

核心规则：

• 渠道商和供应商都必须开通更换代理能力。
• 产品列表返回 changeProxy=1 才能作为判断依据之一。
• 实例必须属于当前渠道商且为运行中。
• appOrderNo 为更换代理订单号，最长 64 位，同一渠道商下唯一。
• 同一实例同一时间只允许一个更换代理任务处理中。
• reason 最长 64 字符。

更换代理成功后，实例的 IP、端口、账号密码等连接信息会被更新。收到 op=5 的订单回调后，通过 GetOrder 或 GetInstance 获取最新实例信息。

9.3 重置实例密码

POST /api/open/app/instance/reset/password/v2
SDK: ResetProxyPassword

核心规则：

• 以产品 resetPassword=1 和实际供应商能力为准。
• resetNo 必填，最长 32 位，同一渠道商下用于幂等。
• instanceNoList 不能为空，不能重复。
• 实例必须属于当前渠道商且为运行中。
• 重复提交相同 resetNo 时，实例列表必须一致，平台返回第一次请求的处理结果。

返回结果中 status 为 1=待处理、2=处理中、3=成功、4=失败；newPassword 为空表示尚未成功生成或处理失败。

9.4 动态子账号流量上限

POST /api/open/app/proxy/user/flow/limit/v2
SDK: SetProxyUserFlowLimit

产品和供应商必须支持 proxyUserFlowLimit=1。limitFlow=-1 表示不限制；如果设置正数，单位为 B，且不能小于 1024000B。

查询子账号信息：

POST /api/open/app/proxy/user/info/v2
SDK: GetProxyUserInfo

9.5 动态流量明细和回收

流量明细：

POST /api/open/app/proxy/flow/use/log/v2
SDK: ProxyFlowUseLog

默认查询近 7 天；分页默认 page=1、pageSize=10，最大 100。

流量回收：

POST /api/open/app/proxy/return/v2
SDK: DynamicProxyReturn

流量型产品使用 flowNum，单位 MB；按 IP 数量购买的产品使用 ipNum。平台会校验当前剩余量并按产品授权价格计算退回金额。

10. 回调处理

平台在订单、实例或产品变化时，向渠道商配置的回调地址发起 GET 请求：

{callbackUrl}?type={type}&no={no}&op={op}

常见回调：

渠道商回调接口必须返回 JSON：

{
  "code": "success",
  "msg": "ok"
}

如果没有返回 code=success，平台会重试。渠道商需要按 type + no + op 做幂等；同一个回调已经处理成功后，再次收到也应返回 success。

11. 幂等和重试建议

• 普通开通、续费、释放、售后订单使用渠道商订单号幂等，建议最长 32 位。
• 更换代理使用独立 appOrderNo 幂等，最长 64 位。
• 重置密码使用 resetNo 幂等，最长 32 位。
• 同一个订单号不要跨业务类型复用；例如开通订单号不能再用于续费或释放。
• 网络超时或未收到响应时，使用相同 reqId 和相同业务单号重试。
• 如果接口已返回平台 orderNo，后续以订单查询和回调为准，不要重复生成新的渠道商订单号补单。
• 保存平台 orderNo、渠道商订单号、instanceNo、productNo、账号映射关系，便于后续续费、释放、售后和对账。

12. 推荐最小联调清单

1. GetAppInfo：验证密钥、加密和响应解密。
2. GetArea、GetCityList：验证地域字典。
3. GetProductStock：验证产品授权和产品字段解析。
4. 静态产品：InstanceOpen -> 回调 -> GetOrder -> GetInstance。
5. 动态产品：CreateUser -> InstanceOpen -> ProxyInfo -> DrawByApi 或 DrawByPwd。
6. 后续操作：选择一个实例完成 InstanceRenew、InstanceRelease 或 ChangeProxy 的沙盒闭环。
7. 回调：验证订单回调重复通知时仍返回 success。

版本更新

全新对接，直接跳过当前，往后看，如果已经对接，看一下最新更新的内容

通用

请求统一加密传输

请求参数

返回数据

加密方式

接口通过aes 加密 cbc 模式 请求时序图如下

备注：

• 请求加密串最终存在params，返回数据加密串存在data参数
• 如果返回数据只有状态码，没有data数据，就不需要做加密返回。

数据加密

• 消息内容为： TestMessage （前后无空格）
• 密钥为： qwertyuiop123456 （前后无空格）
• 通过aes_cbc模式，并Base64后： 5cfJMwX0w65sEQVBxu9zHw==
• 初始向量参数为密钥前16位

请求json示例

{
    "version":"2.0",
    "reqId":"xxxxxx",
    "encrypt":"aes",
    "appKey":"testappid",
    "params":"5cfJMwX0w65sEQVBxu9zHw=="
}

返回json示例

{
    "reqId":"xxxxxx",
    "code":200,
    "msg":"ok",
    "data":"5cfJMwX0w65sEQVBxu9zHw=="
}

go aes cbc加解密函数

package cryptos

import (
	"bytes"
	"crypto/aes"
	"crypto/cipher"
)

// =================== CBC ======================

// key的长度必须为16, 24或者32
func AesEncryptCBC(origData []byte, key []byte) (encrypted []byte, err error) {
	// 分组秘钥

	block, _err := aes.NewCipher(key)
	if _err != nil {
		err = _err
		return
	}
	blockSize := block.BlockSize()                              // 获取秘钥块的长度
	origData = pkcs5Padding(origData, blockSize)                // 补全码
	blockMode := cipher.NewCBCEncrypter(block, key[:blockSize]) // 加密模式
	encrypted = make([]byte, len(origData))                     // 创建数组
	blockMode.CryptBlocks(encrypted, origData)                  // 加密
	return encrypted, nil
}

// key的长度必须为16, 24或者32
func AesDecryptCBC(encrypted []byte, key []byte) (decrypted []byte, err error) {
	block, _err := aes.NewCipher(key) // 分组秘钥
	if _err != nil {
		err = _err
		return
	}
	blockSize := block.BlockSize()                              // 获取秘钥块的长度
	blockMode := cipher.NewCBCDecrypter(block, key[:blockSize]) // 加密模式
	decrypted = make([]byte, len(encrypted))                    // 创建数组
	blockMode.CryptBlocks(decrypted, encrypted)                 // 解密
	decrypted = pkcs5UnPadding(decrypted)                       // 去除补全码
	return decrypted, nil
}
func pkcs5Padding(ciphertext []byte, blockSize int) []byte {
	padding := blockSize - len(ciphertext)%blockSize
	padtext := bytes.Repeat([]byte{byte(padding)}, padding)
	return append(ciphertext, padtext...)
}
func pkcs5UnPadding(origData []byte) []byte {
	length := len(origData)
	unpadding := int(origData[length-1])
	return origData[:(length - unpadding)]
}

java aes cbc加解密函数

package com.ipipv.open.utils;

import javax.crypto.BadPaddingException;
import javax.crypto.Cipher;
import javax.crypto.IllegalBlockSizeException;
import javax.crypto.NoSuchPaddingException;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;
import java.security.InvalidAlgorithmParameterException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Base64;

public class AESCBC {
    public static byte[] encryptCBC(byte[] data, byte[] key, byte[] iv) throws NoSuchPaddingException, NoSuchAlgorithmException, InvalidKeyException, BadPaddingException, IllegalBlockSizeException, InvalidAlgorithmParameterException {
        Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding");
        cipher.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(key, "AES"), new IvParameterSpec(iv));
        byte[] result = cipher.doFinal(data);
        return result;
    }

    public static byte[] decryptCBC(byte[] data, byte[] key, byte[] iv) throws NoSuchPaddingException, NoSuchAlgorithmException, InvalidKeyException, BadPaddingException, IllegalBlockSizeException, InvalidAlgorithmParameterException {
        Cipher cipher = Cipher.getInstance("AES/CBC/PKCS5Padding");
        cipher.init(Cipher.DECRYPT_MODE, new SecretKeySpec(key, "AES"), new IvParameterSpec(iv));
        byte[] result = cipher.doFinal(data);
        return result;
    }

    public static void main(String[] args) throws IllegalBlockSizeException, InvalidKeyException, BadPaddingException, NoSuchAlgorithmException, NoSuchPaddingException, InvalidAlgorithmParameterException {
        String data = "TestMessage"; // 待加密的原文
        String key = "qwertyuiop123456asdfghjk"; // key 长度只能是 16、24 或 32 字节
        String iv = key.substring(0,16); // CBC 模式需要用到初始向量参数

        byte[] ciphertext = encryptCBC(data.getBytes(), key.getBytes(), iv.getBytes());
        System.out.println("CBC 模式加密结果（Base64）：" + Base64.getEncoder().encodeToString(ciphertext));

        byte[] plaintext = decryptCBC(ciphertext, key.getBytes(), iv.getBytes());
        System.out.println("解密结果：" + new String(plaintext));
    }
}

同步地域

请求路径

/api/open/app/area/v2

请求参数

返回数据

同步地域

请求路径

/api/open/app/city/list/v2

请求参数

返回数据

获取产品库存

请求路径

/api/open/app/product/query/v2

请求参数

当主接口中的method为GetOrder时，该参数是主接口中的params参数

eg

{
    "proxyType":[103],
    "productNo":"productNo"
}

返回数据

开通代理

请求路径

/api/open/app/instance/open/v2

请求参数

主接口中的params参数

eg

{
    "appOrderNo":"TEST20240726094927",
    "params":[
        {
            "productNo":"ipideash_598",
            "count":20,
            "cycleTimes":1
        },
        {
            "productNo":"mb_gmhd5exp2",
            "count":20,
            "cycleTimes":12
        }
    ]
}

备注：

• 流量产品count 不起作用
• 流量产品只对flow起作用

返回数据

备注：订单为异步开通，具体查看回调章节

获取订单信息

请求路径

/api/open/app/order/v2

请求参数

返回数据

• 更换代理订单不会生成新的实例编号，type=5，amount=0，count=1。
• 更换代理成功后，instances 返回当前实例的最新代理连接信息。
• asnType 为实例 IP 的 ASN 网络类型；无法识别或尚未完成识别时返回 0。
• status 为订单状态，3=处理成功 4=处理失败 5=部分完成，这三个状态都是最终状态。

获取实例

获取实例的

请求路径

/api/open/app/instance/v2

请求参数

返回数据

asnType 为实例 IP 的 ASN 网络类型；无法识别或尚未完成识别时返回 0。

更换代理

请求路径

/api/open/app/instance/change/v2

请求参数

主接口中的params参数

eg

{
    "instanceNo": "c_gz3h2igp6dz9cq3",
    "appOrderNo": "CHANGE20260609143000",
    "reason": "代理不可用"
}

返回数据

• 更换代理为异步操作。接口返回后会创建更换代理订单并进入后台处理，处理完成后按订单回调，具体查看回调章节。
• 更换成功后，原平台实例编号不变，实例的IP、端口、账号、密码等代理连接信息可能会更新。收到回调后请通过获取订单信息或获取实例信息拉取最新实例信息。
• 获取订单信息支持通过平台更换代理订单号 orderNo 或渠道商更换代理订单号 appOrderNo 查询更换结果，订单类型为 5=更换代理。
• 同一实例同一时间只允许一个更换代理任务处理中。只有产品返回 changeProxy=1 且渠道商已开通更换代理能力时，才可调用该接口。

续费代理

请求路径

/api/open/app/instance/renew/v2

请求参数

当主接口中的method为RewProxy时，该参数是主接口中的params参数

返回数据

备注：订单为异步开通，具体查看回调章节

释放代理

请求路径

/api/open/app/instance/release/v2

请求参数

当主接口中的method为DelProxy时，该参数是主接口中的params参数

返回数据

备注：订单为异步开通，具体查看回调章节

获取App信息

请求路径

/api/open/app/info/v2

请求参数

无

返回数据

指定ip开通代理

请求路径

/api/open/app/instance/open/assign/ip/v2

请求参数

主接口中的params参数

eg

{
    "appOrderNo":"TEST20240726094927",
    "productNo":"ipideash_598",
    "assignIp":"127.0.0.1",
    "cycleTimes":1
}

返回数据

备注：订单为异步开通，具体查看回调章节

查询指定Ip可用信息

请求路径

/api/open/app/assign/ip/info/v2

请求参数

主接口中的params参数

eg

{
    "ip":"127.0.0.1"
}

返回数据

获取项目列表

请求路径

/api/open/app/project/list/v2

请求参数

返回数据

动态

创建或修改主账户

该用户为动态用户的主账户，所有的流量分配都在主账户下，该用户下子账户可以使用主账户的流量。

请求路径

/api/open/app/user/v2

请求参数

返回数据

同步实名

请求路径

/api/open/app/userAuth/v2

请求参数

返回数据

动态产品区域列表

请求路径

/api/open/app/product/area/v2

请求参数

返回数据

[
    {"productNo":"out_dynamic_1","proxyType":104,"areaCode":"6","countryCode":"USA","stateCode":"","cityCode":"","status":1,"region":"us","supplierCode":"xxx"},
    {"productNo":"out_dynamic_1","proxyType":104,"areaCode":"2","countryCode":"FRA","stateCode":"","cityCode":"","status":1,"region":"fr","supplierCode":"xxx"},
    {"productNo":"out_dynamic_1","proxyType":104,"areaCode":"2","countryCode":"GBR","stateCode":"","cityCode":"","status":1,"region":"gb","supplierCode":"xxx"},
    {"productNo":"out_dynamic_1","proxyType":104,"areaCode":"1","countryCode":"JPN","stateCode":"","cityCode":"","status":1,"region":"jp","supplierCode":"xxx"}
]

获取代理余额信息

通过接口获取代理商户

请求路径

/api/open/app/proxy/info/v2

请求参数

返回数据

创建或修改代理用户（子账号）

请求路径

/api/open/app/proxy/user/v2

请求参数

返回数据

账密提取

请求路径

/api/open/app/proxy/draw/pwd/v2

请求参数

返回数据

Api提取代理请求

请求路径

/api/open/app/proxy/draw/api/v2

请求参数

返回数据

流量使用记录

请求路径

/api/open/app/proxy/flow/use/log/v2

请求参数

返回数据

添加ip白名单

请求路径

/api/open/app/proxy/addIpWhiteList/v2

请求参数

返回数据

删除ip白名单

请求路径

/api/open/app/proxy/delIpWhiteList/v2

请求参数

返回数据

动态代理流量回收

请求路径

/api/open/app/proxy/return/v2

请求参数

返回数据

设置子账户流量上限

请求路径

/api/open/app/proxy/user/flow/limit/v2

请求参数

返回数据

无

获取子账户信息

请求路径

/api/open/app/proxy/user/info/v2

请求参数

返回数据

回调

IPV系统存在三种回调：订单回调，实例回调，产品回调。 回调地址由客户提供，我们统一在后台配置。

假设用户设置的回调地址为 https://api.callback.com/ipv/callback

产生回调方式为,我方发起get请求

https://api.callback.com/ipv/callback?type={callbackType}&no={callbackNo}&op={opType}

用户收到回调处理后，要返回回调结果，否则会多次进行回调，因为网络波动等原因，用户对同一回调，做好幂等性操作。

回调结果定义

{
    "code":"",
    "msg":""
}

成功 code返回值 success 多次回调上一次已经成功，第二次还是返回success

订单回调

IPV系统的订单(开通，续费，释放，更换代理)都是异步的，即用户下单 -> ipv返回订单 同时处理代理 -> 代理处理完成回调客户回调地址 ->客户通过回调订单返回信息并拉去订单信息

eg

https://api.callback.com/ipv/callback?type=order&no=C20240429162339417081&op=1

实例回调

当实例产生变化（比如网络不通，停机等）的时候，我方会主动回调

eg

https://api.callback.com/ipv/callback?type=instance&no=c_gz3h2igp6dz9cq3&op=

产品回调

当产品进行变动的时候，我方也会主动回调

eg

https://api.callback.com/ipv/callback?type=product&no=mb_gmfcq7blc&op=

数据字典

代理类型

代理协议

时长单位

ispType

返回状态码