# API

### 1024Proxy API功能介绍

API功能为有编程能力的用户提供了更加便捷的操作方式。可以通过修改API参数快速筛选提取自己需要的代理IP。使用1024Proxy API更常被应用于数据抓取等需要高频切换IP的业务场景。

### 快速了解

<figure><img src="https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2FLKllve0as6fkdwLgS7YL%2F1.png?alt=media&#x26;token=97ed405f-30e8-4831-b794-b97296855868" alt=""><figcaption></figcaption></figure>

### 如何使用1024Proxy的API功能

{% stepper %}
{% step %}

### 添加本地公网IP至IP白名单，点击按钮【添加白名单】

<figure><img src="https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2Fp4WXWbLQ8uYS6bsqSMKh%2F2.png?alt=media&#x26;token=45cd1bcb-dba2-4fa0-9202-f775b4ff3cb9" alt=""><figcaption></figcaption></figure>

<figure><img src="https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2Fyvw8cmNAWlVOYAo45UYB%2F3.png?alt=media&#x26;token=2d2894a8-05a9-4a3b-b266-ae8272f7baab" alt=""><figcaption></figcaption></figure>

{% endstep %}

{% step %}

### 完成无限流量-带宽 套餐的购买

返回API模式菜单下，选中无限流量-带宽，我们可以查看到当前已经添加我们的本地公网IP至IP白名单中。点击立即购买跳转到套餐购买页，完成无限流量-带宽的套餐购买。

![](https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2FknFeLvMQEoMU0kEVNs5v%2F4.png?alt=media\&token=90e7e6f3-5b32-4e2f-9999-3d16e05091b5)

选择需要的套餐类型，1024Proxy当前的无限流量-带宽套餐提供多种有效期选择包括：3小时、1天、7天、30天等多种有效期选择，能够满足用户的广泛的业务需求。![](https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2Fa4DpQ0bvkuIyeETC2StK%2F5.png?alt=media\&token=f2951da3-377b-4163-a579-57c1778863a4)
{% endstep %}

{% step %}

### 设置筛选条件或者参数

完成购买后点击进入控制台进入API模式，

<figure><img src="https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2FnWTZUZAc0qTdp9V3CEPW%2F6.png?alt=media&#x26;token=a6788acb-907e-4dd8-b0f6-bbee9cd2fa6f" alt=""><figcaption></figcaption></figure>

可以查看到我们购买的无限流量-带宽设备及对应的截止日期。

<figure><img src="https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2FRxcjXZqRRdsfswZR6kxb%2F7.png?alt=media&#x26;token=d912af42-1e23-4fab-9b3b-2b62b05255e2" alt=""><figcaption></figcaption></figure>

通过修改下面的参数完成API的基础设置后即可使用API链接批量修改提取自己需要的IP。

<figure><img src="https://724087567-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FlZfA4dcwPR9HllRofHVl%2Fuploads%2FeYdU3IdjrqFENNdamh66%2F8.png?alt=media&#x26;token=7918deae-393e-473e-a3f3-716ac82ba090" alt=""><figcaption></figcaption></figure>

1. 主机名：端口：在完成购买无限流量-带宽套餐后会发放一个云设备到用户的账号中，如果用户购买多个无限流量-带宽套餐，则可以通过下拉列表选择自己所需要使用的主机名和端口。
2. 白名单IP：上面我们已经将本地的IP添加到白名单列表之中。1024Proxy支持用户添加多个信任的安全IP至1024ProxyIP列表中，从而实现多人协作。通过填写IP白名单，省略了用户名和密码的校验，能够有效地节省时间提高工作效率。
3. 国家/地区：1024Proxy的无限流量-带宽支持用户精转筛选国家或地区。
4. 分隔符：通过修改分隔符来修改API链接，当前支持\n,\r\n。
5. 会话类型：无限流量-带宽套餐支持粘性和轮换模式两种类型，粘性模式下的时长在1-120分钟。
6. 数量：API功能通过修改数量参数可以一次性提取多个IP
7. 使用链接：通过修改上述参数或者手动修改链接参数来提取IP，将API链接复制到第三方工具中去使用即可。
   {% endstep %}
   {% endstepper %}

### 参数注释

| 参数名      | 说明                     | 类型     | 必选 |
| -------- | ---------------------- | ------ | -- |
| username | 账号：USENAME             | string | 是  |
| password | 账号：PASSWORD            | string | 是  |
| ips      | 多个用逗号分隔，默认添加访问接口的IP地址  | string | 否  |
| country  | 国家                     | int    | 是  |
| format   | 返回数据格式分割符，n=\n rn=\r\n | string | 是  |
| minute   | 会话时效（分钟）               | int    | 否  |
| num      | 返回端口数量                 | string | 否  |