API Documentation

API 文档

参考快代理 API 文档页的入口式结构,这里把快速开始、鉴权方式、接口参数、 调用示例和错误排查整理成一个面向开发者的落地页。

文档范围

  • 提取 API 使用说明
  • 认证与授权方式
  • 返回结果和错误码
  • 不同语言的调用示例

快速开始

先让开发者 1 分钟看懂如何接入

API 文档首页最重要的是“先上手”,所以这里把获取提取链接、完成鉴权、 请求接口和消费返回结果的路径先讲清楚。

  1. 在控制台生成专属提取链接或查看固定 API 地址。
  2. 选择用户名密码授权或白名单授权方式。
  3. 按返回格式拿到代理列表,在程序里设置代理即可。
curl
curl "https://api.example.com/getproxy?num=5&format=json"
-H "Authorization: Basic <token>"
Python
import requests

url = "https://api.example.com/getproxy?num=5&format=json"
res = requests.get(url, timeout=10)
print(res.json())
Node.js
const res = await fetch("https://api.example.com/getproxy?num=5&format=json")
const data = await res.json()
console.log(data)

鉴权方式

把最常见的两种授权方式放在文档首页,减少接入时的理解成本。

用户名密码授权

适合本地调试、多环境联调和多人协作,接入简单,适配主流开发语言。

白名单 IP 授权

适合服务器固定出口环境,避免在业务代码中保存认证信息。

接口参数

常用参数一页看全,方便前端、后端和测试同学统一理解接口约定。

参数名
必填
说明
示例 / 备注
num
返回 IP 数量
1 ~ 100,根据套餐能力决定
format
返回格式
text / json
protocol
协议筛选
http / https / socks5
sep
分隔符
默认换行,可自定义
region
地区筛选
省份、城市或线路标识
dedup
去重模式
1 表示尽量去重

错误排查

帮助开发者在最短时间内定位调用失败的方向。

返回为空

先检查套餐余量、地区筛选条件和目标协议是否过于严格。

鉴权失败

确认账号密码是否正确,或当前出口 IP 是否已经加入白名单。

请求频繁

检查接口调用频率,必要时调大批量参数或降低请求次数。

IP 无法连接

确认代理协议、端口和目标站访问方式是否匹配,再检查本地网络限制。

Developer Ready

现在 API 文档已经有独立入口页了

如果你想继续做得更像文档系统,下一步我可以拆成“左侧目录 + 详情内容”的多级结构。