公共参数
**公共请求参数：**
- 公共参数分为 公共请求参数 和 公共返回参数
**公共参数：**
|名称|必选|类型|说明|
|:---- |:---|:----- |----- |
|domain |是 |string |域名 |
|appid |是 |string |appid |
|time |是 |string |时间戳 |
|sign |是 |string |加密字段 |
**公共返回参数**
|参数名|类型|说明|
|:----- |:-----|----- |
|RequestId |string |请求编号 |
获取账户余额
**简要描述：**
- 本接口用于查询账户余额。接口请求地址
**输入示例**
https://www.qg.net/api/merchant/getBalance
**返回示例**
JSON格式
```
{
"result":true,
"data":"1.00",
"msg":null
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|result |bool |请求结果 |
|data |string |账户余额 |
|msg |string |错误信息 |
**备注**
- 此接口不需要额外的参数，公共参数请参考[公共参数][001]
[001]: https://www.qg.net/doc/250.html "公共参数"
API概览
## 1 接口简介
青果代理IP提供了功能丰富的API接口，满足开发者在各种场景下的调用需求。
所有接口支持 HTTP 或者 HTTPS 请求，部分接口采用 GET 方法，部分接口采用 POST 方法；接口返回数据的格式支持文本、json、xml。
具体请参见接口文档。
## 2 API列表
- [短效代理](https://www.qg.net/doc/2254.html)
- [独享代理](https://www.qg.net/doc/2141.html)
- [长效代理](https://www.qg.net/doc/2143.html)
- [短效代理（全球HTTP）](https://www.qg.net/doc/2144.html)
- [长效代理（全球HTTP）](https://www.qg.net/doc/6636.html)
- [独享代理（全球HTTP）](https://www.qg.net/doc/6635.html)
- [隧道代理相关](https://www.qg.net/doc/1940.html)
## 3 测试代理可用性
### 3.1 生成API链接
对于代理提取API，您可以到提取工具在线生成API链接，内置到您的程序中：
[提取代理API链接生成 ＞](https://www.qg.net/tools/IPget.html "提取代理API链接生成 ＞＞")
其他接口请查看API文档，获取接口url和参数说明，自己生成API链接。
### 3.2 测试API链接
**浏览器测试**
您可以把生成的API链接直接在浏览器里打开，查看返回结果。例如，您直接点击如下api链接
https://proxy.qg.net/query?Key=0B***607
**命令行测试**
如果您在linux系统下，可以通过curl命令请求API链接查看结果：
`curl "https://proxy.qg.net/allocate?Key=请改成您的Key"`
## 4 接口返回错误码
公共接口返回错误码
| 错误码 | 描述 |
| ------ | ------------------------- |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -12 | Authkey被封禁 |
| -13 | 当前客户端IP不在授权名单中 |
| -14 | Pwd不合法 |
| -15 | Authkey对应的业务无此权限 |
| -100 | 计划不存在或已过期 |
| -103 | 资源不足 |
| -104 | 申请资源失败 |
| -105 | 释放的IP数超过允许释放的IP数 |
## 5 代码样例
查看API调用的[代码样例 ＞](https://www.qg.net/doc/172.html)
全球-长效代理-API接口介绍
## 1 说明
通过编码使用长效代理（全球HTTP）-通道提取主要有以下4步骤：
1.先在[提取工具](https://www.qg.net/tools/IPget.html)或[调试工具](https://www.qg.net/tools/IPdebug.html)上获取api接口；
2.使用白名单或账密进行授权验证；
3.进行代理测试；[查看测试步骤＞＞](https://www.qg.net/doc/1574.html "查看测试步骤")
4.参考[代码样例](https://www.qg.net/list/192.html)编写采集程序，使用代理IP。
## 2 API接口
长效代理（全球HTTP）-通道提取API接口一览
| 接口类型 | API | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [get](https://www.qg.net/doc/6637.html)
- [query](https://www.qg.net/doc/6638.html)
- [channels](https://www.qg.net/doc/6639.html)
| - 提取IP资源
- 查询在用IP资源
- 查询通道数
|
| 白名单相关 | - [whitelist/query](https://www.qg.net/doc/180.html "whitelist/query")
- [whitelist/add](https://www.qg.net/doc/178.html "whitelist/add")
- [whitelist/del](https://www.qg.net/doc/179.html "删除白名单")
| - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
全球-长效代理-查询通道数
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/channels) 用于全球-长效代理产品查询通道数的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=2-2)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.toal | Integer | key的通道总数。 |
| data.idle | Integer | 空闲通道数。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/channels?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"total": 10,
"idle": 5
},
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
全球-长效代理-查询在用IP资源
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/query) 用于全球-长效代理产品查询在用的IP资源的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/query?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [{
"proxy_ip": "129.150.42.240",
"server": "129.150.42.240:18080",
"area": "新加坡",
"deadline": "2023-02-25 15:38:36"
}],
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
全球-长效代理-提取IP资源
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/get) 用于全球-长效代理产品提取IP的接口。
默认接口请求频率限制：（通道数*5+10）次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。
需注意，如使用白名单IP，请在提取前添加白名单。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------- | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area | 否 | String | 国家筛选。支持国家编码和自定义编码，比如：US,EU，或者990100,990200。[国家编码](https://www.qg.net/doc/use/8_234_201/1975.html) |
| area_ex | 否 | String | 排除某些地区提取。使用方式同上 |
| num | 否 | Integer | 提取个数，默认为1 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/get?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [{
"proxy_ip": "129.150.42.240",
"server": "129.150.42.240:18080",
"area": "新加坡",
"deadline": "2023-02-25 15:38:36"
}],
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyipResource)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
| BALANCE_INSUFFICIENT | Key余额不足。 |
| NO_RESOURCE_FOUND | 资源不足。 |
| FAILED_OPERATION | 提取失败。 |
| EXTRACT_LIMIT_EXCEEDED | 超出提取配额。 |
全球-独享代理（地区锁）-API接口介绍
## 1 说明
通过编码使用全球-独享代理（地区锁独占）主要有以下4步骤：
1.先在[提取工具](https://www.qg.net/tools/IPget.html)或[调试工具](https://www.qg.net/tools/IPdebug.html)上获取api接口；
2.使用白名单或账密进行授权验证；
3.进行代理测试；[查看测试步骤＞＞](https://www.qg.net/doc/1574.html "查看测试步骤")
4.参考[代码样例](https://www.qg.net/list/192.html)编写采集程序，使用代理IP。
## 2 API接口
全球-独享代理（地区锁独占）-按量提取API接口一览
| 接口类型 | API | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [monopolize](https://www.qg.net/doc/6630.html)
- [query_monopolize](https://www.qg.net/doc/6631.html)
- [channels](https://www.qg.net/doc/6632.html)
- [changeip](https://www.qg.net/doc/6633.html)
- [delete_monopolize](https://www.qg.net/doc/6634.html)
| - 提取资源
- 查询在用资源
- 查询通道
- 更换IP
- 释放资源
|
| 白名单相关 | - [whitelist/query](https://www.qg.net/doc/180.html "whitelist/query")
- [whitelist/add](https://www.qg.net/doc/178.html "whitelist/add")
- [whitelist/del](https://www.qg.net/doc/179.html "删除白名单")
| - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
全球-独享代理（地区锁）-释放资源
## 海外独占-释放资源
`https://overseas.proxy.qg.net/delete_monopolize`
### 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| uuid | 是 | String | 释放指定的独占资源。 |
### 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | --------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of String | 释放成功的独占资源UUID列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
### 输入示例
```
GET https://overseas.proxy.qg.net/delete_monopolize?key=<您的key信息>&<其他输入参数>
```
### 输出示例
```json
{
"code": "SUCCESS",
"data": [
"jike-hk:ppp497"
],
"request_id": "df747ce4-2e60-4c3d-bade-05535f5dadee"
}
```
全球-独享代理（地区锁）-更换IP
## 海外独占-更换IP
`https://overseas.proxy.qg.net/changeip`
### 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | --------------------------------------------------- |
| key | 是 | String | 公共参数，产品唯一标识。 |
| uuid | 是 | String | 需要更换IP的独占资源uuid。 更换指定的独占资源的IP。 |
### 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | --------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of String | 更换成功的独占资源UUID列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
### 输入示例
```
GET https://overseas.proxy.qg.net/changeip?key=<您的key信息>&<其他输入参数>
```
### 输出示例
```json
{
"code": "SUCCESS",
"data": [
"jike-hk:ppp497"
],
"request_id": "61af19f0-e906-4654-9c08-ab86ed0a0ba3"
}
```
---
