## 1. 接口描述 接口请求域名： exclusive.proxy.qg.net。 本接口 (/channels) 用于独享代理产品通道数查询的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data.toal | Integer | key的通道总数。 | | data.idle | Integer | 空闲通道数。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://exclusive.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 | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： overseas.proxy.qg.net。 本接口 (/resources) 用于全球HTTP-短效代理产品按量提取模式下查询国家资源的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of [ResourceAreaISP](https://www.qg.net/doc/1839.html) | [国家编码](https://www.qg.net/doc/use/8_234_201/1975.html) | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://overseas.proxy.qg.net/resources?key=<您的key信息> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": [ { "area": "美国", "area_code": 990100, "country": "US", "available": true } ], "request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e" } ``` ## 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 | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： overseas.proxy.qg.net。 本接口 (/query) 用于全球HTTP-短效代理产品按量提取模式下查询在用的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资源列表。 | | 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/proxyipResource)。 | | KEY_BLOCK | Key被封禁。 | | REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： static.proxy.qg.net。 本接口 (/resources) 用于静态代理产品查询资源地区的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of [ResourceAreaISP](https://www.qg.net/doc/1839.html) | 资源地区列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://static.proxy.qg.net/resources?key=<您的key信息> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": [ { "area": "福建省泉州市", "area_code": 350500, "isp": "电信", "isp_code": 1, "available": false }, { "area": "河南省商丘市", "area_code": 411400, "isp": "电信", "isp_code": 1, "available": true } ], "request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e" } ``` ## 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 | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： static.proxy.qg.net。 本接口 (/query) 用于静态代理产品查询在用的IP资源的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------------------------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | | task | 否 | String | 提取批次筛选。支持多批次筛选，用逗号隔开。比如："Z5p2DKKCSyhocKEa,kAEaWHucf8iPXm0O"。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ------------------------------------------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data.tasks | Array of [Task](https://www.qg.net/doc/1839.html) | 提取批次列表。 | | data.num | Integer | 提取批次数量。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://static.proxy.qg.net/query?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": { "tasks": { "task_id": "Z5p2DKKCSyhocKEa", "ips": [ { "proxy_ip": "123.54.55.24", "server": "123.54.55.24:59419", "area": "河南省商丘市", "isp": "电信", "deadline": "2023-02-25 15:38:36" } ], "num": 1 }, "num": 1 }, "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 | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： monopoly.proxy.qg.net。 本接口 (/delete) 用于独享代理产品启用地区锁功能后释放资源的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------------------------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | | uuid | 是 | String | 释放指定的独占资源。支持多资源同时释放，按逗号隔开。比如：hn_sqdx2-1:ppp1,hn_sqdx2-1:ppp14。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | --------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of String | 释放成功的独占资源UUID列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://monopoly.proxy.qg.net/delete?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": ["hn_sqdx2-1:ppp14", "hn_sqdx2-1:ppp1"], "request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e" } ``` ## 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 | 请求频率超出限制。 | | MONOPOLY_DELETE_TIME_LIMIT | 独占资源需要12小时后才能释放。 |
## 1. 接口描述 接口请求域名： overseas.proxy.qg.net。 本接口 (/balance) 用于全球HTTP-短效代理产品按量提取模式下查询余额的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ------------ | ------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data.balance | Integer | key的IP余额。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://overseas.proxy.qg.net/balance?key=<您的key信息> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": { "balance": 9999 }, "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 | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： monopoly.proxy.qg.net。 本接口 (/query) 用于独享代理产品启用地区锁功能后查询在用IP资源的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------------------------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | | uuid | 否 | String | 查询指定的独占资源。支持多资源查询，按逗号隔开。比如：hn_sqdx2-1:ppp1,hn_sqdx2-1:ppp14。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ----------------------------------------------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of [Monopoly](https://www.qg.net/doc/1839.html) | 独占资源列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://monopoly.proxy.qg.net/query?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": [ { "uuid": "hn_sqdx2-1:ppp14", "area": "河南省商丘市", "isp": "电信", "state": "在线", "ip": "122.57.90.234", "heartbeat": "2023-02-25 09:48:23", "monopolize_time": "2023-02-25 09:45:10", }, { "uuid": "hn_sqdx2-1:ppp1", "area": "河南省商丘市", "isp": "电信", "state": "等待中(30)", "monopolize_time": "2023-02-25 09:45:10", } ], "request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e" } ``` ## 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 | 请求频率超出限制。 |
**全球HTTP均不支持在中国大陆地区网络环境下使用。** 青果为有经验的开发者提供多种API接口及代码示例，以协助开发者更便利地使用代理。 本篇仅以【提取IP】这一操作为例，介绍如何使用API接口-代码方式来使用代理。 ## 步骤总览  ## 一、获取api接口 青果给开发者提供两种方式来获得api接口 ① 使用调试工具/提取工具 调试工具是青果为开发者推出的快速获取接口&调试的简便工具，传送门[＞＞调试工具](https://www.qg.net/tools/IPdebug.html) 使用调试工具，用户需要先在左侧栏目中选好产品及接口类型，并在右侧表格的参数值列中填写所需信息，便可在页面上方看到完整的【请求地址】，这便是提取IP的API接口。 点击【发送】还能快速调试，查看响应结果，确认该代理接口是否可用。  调试工具除了有提取IP接口，还提供查询在用IP、资源池、资源地区等接口。 若只需要提取IP，也可以使用提取工具，进行简单的选择便可以获取一样的接口链接。传送门[＞＞提取工具 ](https://www.qg.net/tools/IPget.html)  ② 查看api接口文档 除了简便工具，开发者也可以通过更原始的接口文档，自主编写所需的接口链接。 **点击了解API接口文档 ＞[按量提取类型](https://www.qg.net/doc/product/6_259_275_276/2144.html)、[通道提取类型](https://www.qg.net/doc/product/6_259_275_277/2262.html)** ## 二、授权验证 正式使用代理之前，还需要通过授权验证。青果代理IP支持白名单和帐密两种验证方式，可自主选择使用。 白名单模式，即把要实现代理的服务器IP添加进代理白名单中，后续使用该IP连接代理就能成功； 账密模式，即先获取该代理业务的账号密码信息，连接代理时填入账密进行验证就可使用代理。  详细步骤可查看＞[代理验证](https://www.qg.net/doc/use/8_244/1574.html) ## 三、代理测试 在代理服务器中打开命令行，输入相应的代理信息进行运行，若响应成功，则代理可用。 以下图为例，通过curl命令测试账密模式的代理结果，查询IP并成功响应。 `curl -x http://{authkey}:{authpwd}@{118.92.69.112}:{32105} {targetUrl}`  若响应不成功，可对应[错误码表](https://www.qg.net/doc/1838.html)，排查问题。 ## 四、编写采集程序 测试代理可用后，便可开始编写代理采集程序了。 青果提供了多种编程语言的代码示例以及SDK下载包供开发者参考， 详情查看 - [SDK下载](https://www.qg.net/doc/sdk/9_230/1745.html) - [C语言代码示例](https://www.qg.net/doc/sdk/9_230/1694.html) - [Go语言代码示例](https://www.qg.net/doc/sdk/9_230/1695.html) - [PHP语言代码示例](https://www.qg.net/doc/sdk/9_230/1696.html) - [Python语言代码示例](https://www.qg.net/doc/sdk/9_230/1697.html) - [Java语言代码示例](https://www.qg.net/doc/sdk/9_230/1698.html) - [Shell语言代码示例](https://www.qg.net/doc/sdk/9_230/1699.html) - [C#语言代码示例](https://www.qg.net/doc/sdk/9_230/1700.html) - [Node语言代码示例](https://www.qg.net/doc/sdk/9_230/1701.html) **注：**青果代理IP产品都有相对应的IP存活周期，其有效时长是从提取到IP时算起，超过这个时长IP会失效。
## 1. 接口描述 接口请求域名： static.proxy.qg.net。 本接口 (/channels) 用于静态代理产品通道数查询的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data.toal | Integer | key的通道总数。 | | data.idle | Integer | 空闲通道数。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://static.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 | 请求频率超出限制。 |
