API接口文档

API概述

我们提供RESTful API接口，支持HTTP/HTTPS协议，返回JSON格式数据。

基础信息

• API基础URL：http://www.mayihttp.com


• 请求方式：GET/POST


• 返回格式：JSON


• 字符编码：UTF-8

认证方式

所有API请求都需要在参数中携带key字段进行身份认证：

?key=您的API密钥

接口列表

1. 提取代理IP

      GET /get_api.php
      
      请求参数：
      - key (必填): API密钥
      - action (必填): 固定值"ip"
      - num (选填): 提取数量，默认1，最大200
      - package_type (必填): 套餐类型，time/static/balance
      - time (选填): 使用时长，1/2/3/4（对应5分钟/15分钟/25分钟/3小时）
      - mode (选填): 协议类型，1(HTTP)/3(SOCKS5)，默认1
      - type (选填): 返回格式，1(TXT)/2(JSON)，默认2
      - province (选填): 省份代码，如440000（广东省）
      - city (选填): 城市代码，如440300（深圳市）
      - quchong (选填): IP去重，1(自动去重)，默认1
      
      返回示例（JSON格式）：
      {
        "code": 200,
        "success": true,
        "message": "提取成功",
        "data": [
          {
            "ip": "123.456.789.012",
            "port": 8080,
            "city": "深圳",
            "isp": "电信",
            "expire_time": "2024-01-20 15:30:00"
          }
        ]
      }
      

2. 查询余额

      GET /auth.php?key=YOUR_KEY&action=balance
      
      请求参数：
      - key (必填): API密钥
      - action (必填): 固定值"balance"
      
      返回示例：
      {
        "code": 200,
        "success": true,
        "message": "查询成功",
        "data": {
          "balance": 10000.50
        }
      }
      

3. 查询白名单列表

      GET /auth.php?key=YOUR_KEY&action=whitelist_list
      
      请求参数：
      - key (必填): API密钥
      - action (必填): 固定值"whitelist_list"
      
      返回示例：
      {
        "code": 200,
        "success": true,
        "message": "查询成功",
        "data": {
          "total": 3,
          "limit": 50,
          "list": [
            {
              "ip": "192.168.1.100",
              "created_at": "2024-01-20 10:00:00"
            },
            {
              "ip": "10.0.0.1",
              "created_at": "2024-01-19 15:30:00"
            }
          ]
        }
      }
      

4. 添加白名单

      GET /auth.php?key=YOUR_KEY&action=whitelist_add&ip=192.168.1.100
      POST /auth.php
      
      请求参数：
      - key (必填): API密钥
      - action (必填): 固定值"whitelist_add"
      - ip (必填): 要添加的IP地址
      
      返回示例：
      {
        "code": 200,
        "success": true,
        "message": "白名单添加成功",
        "data": {
          "ip": "192.168.1.100"
        }
      }
      

5. 删除白名单

      GET /auth.php?key=YOUR_KEY&action=whitelist_delete&ip=192.168.1.100
      POST /auth.php
      
      请求参数：
      - key (必填): API密钥
      - action (必填): 固定值"whitelist_delete"
      - ip (必填): 要删除的IP地址
      
      返回示例：
      {
        "code": 200,
        "success": true,
        "message": "白名单删除成功"
      }
      

错误码说明

错误码	说明
200	成功
400	请求参数错误
401	API密钥无效或未提供
403	账户被禁用或无权限
404	资源不存在
405	请求方法不允许
429	请求频率过快
500	服务器内部错误

白名单功能说明

• 白名单用于限制只有特定IP地址可以使用您的API密钥


• 每个账户最多可添加50个白名单IP


• 添加白名单后立即生效


• 如果启用了白名单但未添加任何IP，所有请求都会被拒绝


• 建议只添加您实际使用的服务器IP地址

余额查询说明

• 余额查询会返回所有有效套餐的余额信息


• total_balance 是所有套餐余额的总和


• today_usage 是今日已使用的IP数量


• packages 数组包含每个套餐的详细信息


• expire_time 为null表示该套餐永不过期