OpenApi 文档

1.概述

所有接口均采用统一的认证、参数和响应格式。

2.调用凭证

控制台订单详情页获取secret_id和secret_key

确保订单状态为正常生效状态

3. 接口调用规范

3.1 认证方式

所有开放API请求必须包含以下认证参数：

参数名	类型	必填	说明
secret_id	string	是	用户唯一标识
secret_key	string	是	用户密钥

3.2 请求频率限制

每个业务接口都对应自己的请求频率限制

3.3 请求方式

支持以下请求方式：

GET：参数通过URL传递

POST：支持application/json和application/x-www-form-urlencoded

3.4 字符编码

所有请求和响应使用UTF-8编码。

4. 响应格式

4.1 成功响应

{
    "code": 0,
    "message": "Success",
    "data": {
        "key1": "value1",
        "key2": "value2"
    }
}

4.2 错误响应

{
    "code": -1001,
    "message": "缺少secret_id或secret_key参数",
    "data": {}
}

5. 接口列表

API接口详情	接口名称	接口路径	请求方法	接口频率
OpenAPI-获取订单鉴权信息	`get_order_auth`	`/v1/get-order-auth`	GET	5秒1次
OpenAPI-设置订单鉴权白名单列表	`set_order_whitelist`	`/v1/set-order-whitelist`	POST	1秒1次
OpenAPI-获取短效代理订单IP	`get_dxi`	`/v1/get-dxi`	GET	1秒5次
OpenAPI-获取短效代理订单IP余量	`get_dxi_left_count`	`/v1/get-dxi-left-count`	GET	5秒1次
OpenAPI-获取隧道代理	`get_txi`	`/v1/get-txi`	GET	5秒1次

6. 错误码说明

6.1 公共错误码

错误码	错误信息	说明	解决方案
0	Success	请求成功	-
-1000	服务异常，请稍后重试	服务器内部错误	稍后重试或联系技术支持
-1001	缺少secret_id或secret_key参数	认证参数缺失	检查请求参数
-1002	secret_id或secret_key无效	认证失败	检查凭证是否正确或订单是否有效
-1003	订单状态异常	订单未激活或已关闭	联系客服确认订单状态
-1004	请求频率过高，请稍后重试	超出频率限制	降低请求频率
-1005	请求方法使用错误，请更换请求方法	请求方法使用错误	更换请求方法

6.2 接口错误码

各业务接口可能有特定的错误码，详见具体接口文档。

1.概述#

2.调用凭证#

3. 接口调用规范#

3.1 认证方式#

3.2 请求频率限制#

3.3 请求方式#

3.4 字符编码#

4. 响应格式#

4.1 成功响应#

4.2 错误响应#

5. 接口列表#

6. 错误码说明#

6.1 公共错误码#

6.2 接口错误码#