API 帮助文档

概述

本文档为后端服务的 HTTP API 接口说明，提供代理IP提取，白名单管理和用量查询功能。所有接口均需通过 orderid 和 pass 参数进行身份验证，并使用 GET 方法请求。

认证方式

所有接口均需在请求中携带以下参数：

接口列表

1. 提取 IP

• URL: /getip

• 方法: GET

• 参数:

{
 "msg": "success",
 "code": 200,
 "data": [
  {
   "province": "广东省",
   "city": "江门市",
   "port": "20025",
   "ip": "110.40.38.249",
   "realIp": "120.230.190.21",
   "expire_at": "2023-04-02 13:46:38"
  },
  {
   "province": "广东省",
   "city": "惠州市",
   "port": "23625",
   "ip": "110.40.38.249",
   "realIp": "14.112.7.177",
   "expire_at": "2023-04-02 13:46:38"
  }
 ]
}

ip 和 port: 本次代理请求发送的IP和端口，实际出口为realIp
realIp: 本次代理出口的真实IP (不一定准确)

2. 添加白名单 IP

• URL: /api/addWhiteIp

• 方法: GET

• 参数:

• 成功响应:

"白名单添加成功"

• 错误响应:

  • 400: IP格式无效或IP已存在

  • 403: 身份验证失败

3. 删除白名单 IP

• URL: /api/delWhiteIp

• 方法: GET

• 参数:

• 成功响应:

"白名单删除成功"

• 错误响应:

  • 400: IP不在白名单中或IP格式无效

  • 403: 身份验证失败

4. 查询白名单列表

• URL: /api/query_ips

• 方法: GET

• 成功响应:

  192.168.1.1
  10.0.0.2

• 错误响应: 403（身份验证失败）

5. 查询历史用量数据

• URL: /api/all_use

• 方法: GET

• 成功响应:

  json

  [
    {
      "minute1": 86,
      "minute10": 0,
      "minute3": 0,
      "minute30": 0,
      "minute5": 0,
      "minute60": 0,
      "netflow": 2700004,
      "orderId": 10114,
      "useDate": "2025-02-26"
    },
    {
      "minute1": 1,
      "minute10": 0,
      "minute3": 0,
      "minute30": 0,
      "minute5": 0,
      "minute60": 0,
      "netflow": 451,
      "orderId": 10114,
      "useDate": "2025-04-02"
    }
  ]

  • 若无数据返回 {"message": "当前没有使用数据"}

6. 查询当日用量数据

• URL: /api/today_use

• 方法: GET

• 成功响应:

  json

  {
    "minute1": 1,
    "minute10": 0,
    "minute3": 0,
    "minute30": 0,
    "minute5": 0,
    "minute60": 0,
    "netflow": 451,
    "orderId": 10114,
    "useDate": "2025-04-02"
  }

  • 若无当天数据返回 {"message": "当前没有使用数据"}