极安代理 - API概览

## 1 接口简介
极安代理提供了功能丰富的API接口，满足开发者在各种场景下的调用需求。

所有接口支持 HTTP 或者 HTTPS 请求，部分接口采用 GET 方法，部分接口采用 POST 方法；
接口返回数据的格式支持文本、json、xml。
具体请参见接口文档。

## 2 API 列表
| 接口类型 | 接口名称 |
| ------------- | -------------------------------------------------------------------- |
| 短效代理接口 | - [提取IP](https://www.ja.cn/doc/2781.html) - [查询余额](https://www.ja.cn/doc/2782.html) | 
| 白名单相关接口 | - [查询白名单IP](https://www.ja.cn/doc/2779.html) - [添加白名单IP](https://www.ja.cn/doc/2777.html) - [删除白名单IP](https://www.ja.cn/doc/2778.html) |

## 3 测试代理可用性
#### 3.1 生成API链接
对于代理提取API，您可以到[提取工具](https://www.ja.cn/tools/IPget.html)在线生成API链接，内置到您的程序中：

也可以查看API文档，获取接口url和参数说明，自己生成API链接。

#### 3.2 测试API链接
浏览器测试

您可以把生成的API链接直接在浏览器里打开，查看返回结果。例如，您直接点击如下api链接

https://api.ja.cn/getip?key=ABCD1234

命令行测试

如果您在linux系统下，可以通过curl命令请求API链接查看结果：

curl "https://api.ja.cn/getip?key=ABCD1234"

## 4 错误码
查看公共接口返回错误码

| 错误码 | 描述                       |
| ------ | ------------------------- |
| -1      | 未知错误                  |
| -10     | 参数不合法                |
| -11     | 请求过于频繁              |
| -12     | Authkey被封禁             |
| -13     | 当前客户端IP不在授权名单中  |
| -14     | Pwd不合法                 |
| -15     | Authkey对应的业务无此权限  |
| -100    | 计划不存在或已过期         |
| -103    | 资源不足                  |
| -104    | 申请资源失败               |
| -105    | 释放的IP数超过允许释放的IP数 |

## 5 代理使用监控
业务开始使用后，您可在控制台-业务详情中了解AP代理使用的具体监控数据。
![image-20250731104700444](https://public-1251015552.cos.ap-guangzhou.myqcloud.com/Uploads%2Fimage%2F2025-07-31%2F104700d0f7ac1.png)