PHP API 接口文档
共 47 个接口 · 点击卡片展开详情 · 支持复制代码示例
认证接口
7 个接口向指定邮箱发送验证码,可用于注册、重置密码或更换邮箱。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| email string | 必填 | 目标邮箱地址 | |
| purpose string | 必填 | 用途:register / reset_password / change_email |
GET api.php?action=send_code&email=user@example.com&purpose=register
{\n "code": 200,\n "message": "success",\n "data": null\n}
通过邮箱验证码注册新用户账号。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username string | 必填 | 用户名(3-20位) | |
| email string | 必填 | 邮箱地址 | |
| password string | 必填 | 密码(至少6位) | |
| code string | 必填 | 邮箱验证码 |
GET api.php?action=register&username=testuser&email=user@example.com&password=123456&code=123456
{\n "code": 200,\n "message": "注册成功",\n "data": {\n "user_id": 1,\n "username": "testuser",\n "email": "user@example.com",\n "api_token": "38472915",\n "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."\n }\n}
通过账号(用户名或邮箱)和密码登录系统。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| account string | 必填 | 用户名或邮箱 | |
| password string | 必填 | 密码 |
GET api.php?action=login&account=testuser&password=123456
{\n "code": 200,\n "message": "登录成功",\n "data": {\n "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",\n "api_token": "38472915",\n "user": {\n "id": 1,\n "username": "testuser",\n "email": "user@example.com",\n "role": "user",\n "balance": "0.00"\n }\n }\n}
获取当前登录用户的详细信息,需携带 access_token。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 |
GET api.php?action=profile&access_token=eyJ...
{\n "code": 200,\n "message": "success",\n "data": {\n "user_id": 1,\n "username": "testuser",\n "email": "user@example.com",\n "nickname": "测试用户",\n "role": "user",\n "status": "active"\n }\n}
更新当前用户的昵称等信息。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 | |
| nickname string | 可选 | 昵称 |
GET api.php?action=update_profile&access_token=eyJ...&nickname=新昵称
{\n "code": 200,\n "message": "success",\n "data": null\n}
修改当前用户的登录密码。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 | |
| old_password string | 必填 | 原密码 | |
| new_password string | 必填 | 新密码 |
GET api.php?action=change_password&access_token=eyJ...&old_password=oldpass&new_password=newpass123
{\n "code": 200,\n "message": "success",\n "data": null\n}
永久删除当前用户账号,需提供密码确认。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 | |
| password string | 必填 | 当前密码(确认用) |
GET api.php?action=delete_account&access_token=eyJ...&password=123456
{\n "code": 200,\n "message": "success",\n "data": null\n}
API Token 接口
3 个接口通过 API Token 验证用户身份,供软件对接使用。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 用户的 API Token |
GET api.php?action=api_verify&api_token=abc123...
{\n "code": 200,\n "message": "验证成功",\n "data": {\n "user": {"id": 1, "username": "testuser"}\n }\n}
登录用户获取自己的 API Token,用于软件对接。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 |
GET api.php?action=get_api_token&access_token=eyJ...
{\n "code": 200,\n "message": "获取成功",\n "data": {\n "api_token": "38472915",\n "user_id": 1\n }\n}
重新生成 API Token,旧 Token 将立即失效。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 |
GET api.php?action=regenerate_api_token&access_token=eyJ...
{\n "code": 200,\n "message": "重新生成成功",\n "data": {\n "api_token": "new_token_value..."\n }\n}
启动统计
1 个接口记录应用启动事件(支持 API Token 或 JWT 认证)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 可选 | API Token(优先于 JWT) | |
| access_token string | 可选 | JWT 访问令牌 | |
| device_id string | 可选 | 设备唯一标识 | |
| app_version string | 可选 | 应用版本号 | |
| platform string | 可选 | 平台:android/ios/windows 等 |
GET api.php?action=record_launch&api_token=abc123&device_id=dev001&app_version=1.0.0
{\n "code": 200,\n "message": "记录成功",\n "data": {"recorded": true}\n}
广告墙
2 个接口获取可用的广告墙列表,已完成签到的广告不计入。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 可选 | API Token(用于过滤已完成广告) | |
| type string | 可选 | 按类型筛选:banner/interstitial/rewarded |
GET api.php?action=ad_wall_list&api_token=abc123
{\n "code": 200,\n "data": {\n "list": [\n {\n "id": 1,\n "name": "每日签到广告",\n "ad_type": "rewarded",\n "ad_url": "https://...",\n "reward_coins": 10,\n "daily_limit": 3,\n "earned_today": 0\n }\n ]\n }\n}
确认观看广告并获得金币奖励。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id int | 必填 | 广告 ID | |
| api_token string | 必填 | API Token |
GET api.php?action=ad_wall_view&id=1&api_token=abc123
{\n "code": 200,\n "message": "观看成功",\n "data": {\n "coins_earned": 10,\n "total_coins": 510\n }\n}
版本更新
2 个接口检查是否有新版本可用,返回更新信息。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| version string | 必填 | 当前版本号 | |
| platform string | 可选 | 平台:android/ios/windows 等 |
GET api.php?action=check_update&version=1.0.0&platform=android
{\n "code": 200,\n "data": {\n "has_update": true,\n "latest_version": "1.2.0",\n "force_update": false,\n "title": "新版本发布",\n "description": "修复若干 bug",\n "download_url": "https://...",\n "file_size": "25MB"\n }\n}
获取版本更新历史记录列表。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| page int | 可选 | 页码 | |
| page_size int | 可选 | 每页数量 | |
| platform string | 可选 | 按平台筛选 |
GET api.php?action=update_history&page=1
{\n "code": 200,\n "data": {\n "list": [...],\n "total": 10,\n "page": 1\n }\n}
远程通知
2 个接口获取用户的远程通知列表。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token | |
| page int | 可选 | 页码 |
GET api.php?action=notification_list&api_token=abc123
{\n "code": 200,\n "data": {\n "list": [\n {\n "id": 1,\n "title": "系统维护通知",\n "content": "服务器将于今晚维护",\n "type": "system",\n "is_popup": true,\n "sent_at": "2026-08-11 10:00:00"\n }\n ]\n }\n}
将指定通知标记为已读。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| id int | 必填 | 通知 ID | |
| api_token string | 必填 | API Token |
GET api.php?action=notification_read&id=1&api_token=abc123
{\n "code": 200,\n "message": "标记成功"\n}
签到
2 个接口获取当前签到状态、连签天数、奖励列表等。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token |
GET api.php?action=signin_status&api_token=abc123
{\n "code": 200,\n "data": {\n "signed_today": false,\n "current_streak": 0,\n "total_signin": 0,\n "next_reward": 10,\n "next_day": 1,\n "rewards": [10, 15, 20, 25, 30, 40, 60]\n }\n}
每日签到可获得金币奖励,连续签到奖励更多。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token |
GET api.php?action=signin&api_token=abc123
{\n "code": 200,\n "message": "签到成功",\n "data": {\n "reward_coins": 10,\n "streak_days": 1\n }\n}
卡密
4 个接口批量生成卡密(管理员权限)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 | |
| type string | 必填 | 类型:day/week/month/quarter/year/forever | |
| count int | 必填 | 生成数量 | |
| price float | 必填 | 每张卡密价格 |
GET api.php?action=card_generate&access_token=eyJ...&type=month&count=10&price=25
{\n "code": 200,\n "message": "success",\n "data": {\n "count": 10,\n "cards": ["CARD-XXXX-XXXX-XXXX", "..."]\n }\n}
获取所有卡密列表,支持筛选。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 | |
| page int | 可选 | 页码,默认 1 | |
| page_size int | 可选 | 每页数量 |
GET api.php?action=card_list&access_token=eyJ...&page=1&page_size=20
{\n "code": 200,\n "message": "success",\n "data": {\n "list": [\n {\n "id": 1,\n "code": "CARD-XXXX-XXXX-XXXX",\n "type": "month",\n "status": "unused",\n "price": 25.00,\n "created_at": "2026-08-11 10:00:00"\n }\n ],\n "total": 100,\n "page": 1,\n "page_size": 20\n }\n}
删除指定卡密。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | JWT 访问令牌 | |
| id int | 必填 | 卡密ID |
GET api.php?action=card_delete&access_token=eyJ...&id=1
{\n "code": 200,\n "message": "success",\n "data": null\n}
使用卡密兑换会员或余额。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token | |
| code string | 必填 | 卡密 |
GET api.php?action=card_redeem&api_token=abc123&code=CARD-XXXX-XXXX-XXXX
{\n "code": 200,\n "message": "success",\n "data": {\n "card_type": "month",\n "duration": 30,\n "balance_added": 0\n }\n}
管理员
6 个接口获取系统用户列表,支持筛选和搜索。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | 管理员 JWT 令牌 | |
| page int | 可选 | 页码,默认 1 | |
| page_size int | 可选 | 每页数量 |
GET api.php?action=admin_user_list&access_token=eyJ...&page=1&page_size=20
{\n "code": 200,\n "message": "success",\n "data": {\n "list": [\n {\n "user_id": 1,\n "username": "testuser",\n "email": "user@example.com",\n "role": "user",\n "status": "active",\n "balance": 100.00,\n "created_at": "2026-01-01 00:00:00"\n }\n ],\n "total": 1,\n "page": 1,\n "page_size": 20\n }\n}
获取指定用户的完整详细信息。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | 管理员 JWT 令牌 | |
| id int | 必填 | 用户ID |
GET api.php?action=admin_user_detail&access_token=eyJ...&id=1
{\n "code": 200,\n "message": "success",\n "data": {\n "id": 1,\n "username": "testuser",\n "email": "user@example.com",\n "nickname": "测试用户",\n "role": "user",\n "status": 1,\n "balance": 100.00,\n "coins": 500,\n "created_at": "2026-01-01 00:00:00"\n }\n}
更新指定用户的基础信息(昵称、角色、状态、余额、金币等)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | 管理员 JWT 令牌 | |
| id int | 必填 | 用户ID | |
| nickname string | 可选 | 昵称 | |
| role string | 可选 | 角色:user/admin | |
| status int | 可选 | 状态:0=禁用,1=启用 | |
| balance float | 可选 | 余额 | |
| coins int | 可选 | 金币 |
GET api.php?action=admin_user_update&access_token=eyJ...&id=1&status=0
{\n "code": 200,\n "message": "success",\n "data": null\n}
封禁指定用户,设置封禁时长(小时)及原因。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | 管理员 JWT 令牌 | |
| id int | 必填 | 用户ID | |
| duration int | 必填 | 封禁时长(小时),如 72=3天 | |
| reason string | 可选 | 封禁原因 |
GET api.php?action=admin_user_ban&access_token=eyJ...&id=1&duration=72&reason=违规行为
{\n "code": 200,\n "message": "用户已被封禁",\n "data": {\n "ban_until": "2026-08-14 10:00:00",\n "duration": "72小时",\n "reason": "违规行为"\n }\n}
解除指定用户的封禁状态,恢复其登录权限。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | 管理员 JWT 令牌 | |
| id int | 必填 | 用户ID |
GET api.php?action=admin_user_unban&access_token=eyJ...&id=1
{\n "code": 200,\n "message": "用户已解封",\n "data": null\n}
永久删除指定用户(需确认参数)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token string | 必填 | 管理员 JWT 令牌 | |
| id int | 必填 | 用户ID | |
| confirm string | 必填 | 确认删除:传入 "1" |
GET api.php?action=admin_user_delete&access_token=eyJ...&id=1&confirm=1
{\n "code": 200,\n "message": "用户已删除",\n "data": null\n}
维护
1 个接口获取系统当前维护状态,用于判断是否开放注册、登录等操作。
GET api.php?action=maintenance_status
{\n "code": 200,\n "data": {\n "maintenance": false,\n "message": "系统运行正常",\n "features": {\n "register": true,\n "login": true,\n "api": true\n }\n }\n}
统计
1 个接口获取今日注册量、登录量、启动量、在线用户数等统计。
GET api.php?action=stats_today
{\n "code": 200,\n "data": {\n "date": "2026-08-11",\n "today_registrations": 15,\n "today_logins": 120,\n "today_launches": 350,\n "online_users": 45,\n "active_users": 80\n }\n}
父子用户体系
3 个接口通过邮箱验证码注册新用户账号。如传入 parent_api_token,则自动建立父子关系。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username string | 必填 | 用户名(3-20位) | |
| email string | 必填 | 邮箱地址 | |
| password string | 必填 | 密码(至少6位) | |
| code string | 必填 | 邮箱验证码 | |
| parent_api_token string | 可选 | 父用户 API Token(建立父子关系) |
GET api.php?action=register&username=subuser&email=sub@example.com&password=123456&code=123456&parent_api_token=PARENT_TOKEN
{\n "code": 200,\n "message": "注册成功",\n "data": {\n "user_id": 2,\n "username": "subuser",\n "parent_id": 1,\n "api_token": "NEW_TOKEN"\n }\n}
获取用户统计数据:今日新增用户、总用户数、启动数、在线数等。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token |
GET api.php?action=api_user_stats&api_token=PARENT_TOKEN
{\n "code": 200,\n "data": {\n "today_users": 12,\n "total_users": 150,\n "today_launches": 380,\n "online_users": 45,\n "active_users": 80\n }\n}
获取当前用户详细信息,含金币、会员、子用户数量等。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token |
GET api.php?action=api_user_info&api_token=TOKEN
{\n "code": 200,\n "data": {\n "user_id": 1,\n "username": "testuser",\n "email": "user@example.com",\n "coins": 500,\n "balance": 100.00,\n "is_member": true,\n "member_expires": "2026-09-11 23:59:59",\n "subuser_count": 5,\n "created_at": "2026-01-01 00:00:00"\n }\n}
子用户管理
10 个接口获取当前父用户下的所有子用户列表。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| page int | 可选 | 页码,默认 1 | |
| page_size int | 可选 | 每页数量 |
GET api.php?action=api_subuser_list&api_token=PARENT_TOKEN&page=1&page_size=20
{\n "code": 200,\n "data": {\n "list": [\n {\n "user_id": 2,\n "username": "subuser1",\n "email": "sub1@example.com",\n "status": "active",\n "coins": 100,\n "is_member": false,\n "created_at": "2026-08-11 10:00:00"\n }\n ],\n "total": 5,\n "page": 1,\n "page_size": 20\n }\n}
创建新的子用户,自动关联到当前父用户。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| username string | 必填 | 用户名(3-20位) | |
| password string | 必填 | 密码(至少6位) | |
| email string | 可选 | 邮箱地址 |
POST api.php?action=api_subuser_create\napi_token=PARENT_TOKEN&username=newuser&password=123456&email=new@example.com
{\n "code": 200,\n "message": "创建成功",\n "data": {\n "user_id": 3,\n "username": "newuser",\n "api_token": "NEW_SUB_TOKEN"\n }\n}
更新指定子用户的信息(昵称、密码等)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID | |
| username string | 可选 | 新用户名 | |
| password string | 可选 | 新密码 |
POST api.php?action=api_subuser_update\napi_token=PARENT_TOKEN&user_id=3&username=newname
{\n "code": 200,\n "message": "更新成功",\n "data": null\n}
永久删除指定子用户。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID |
GET api.php?action=api_subuser_delete&api_token=PARENT_TOKEN&user_id=3
{\n "code": 200,\n "message": "删除成功",\n "data": null\n}
封禁指定子用户,封禁期间无法登录。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID | |
| duration int | 必填 | 封禁时长(小时) | |
| reason string | 可选 | 封禁原因 |
GET api.php?action=api_subuser_ban&api_token=PARENT_TOKEN&user_id=3&duration=24&reason=违规
{\n "code": 200,\n "message": "封禁成功",\n "data": {\n "ban_until": "2026-08-18 10:00:00"\n }\n}
解除指定子用户的封禁状态。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID |
GET api.php?action=api_subuser_unban&api_token=PARENT_TOKEN&user_id=3
{\n "code": 200,\n "message": "解封成功",\n "data": null\n}
调整指定子用户的金币数量(正数增加,负数扣除)。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID | |
| coins int | 必填 | 变动数量(正=增加,负=扣除) | |
| reason string | 可选 | 操作原因 |
POST api.php?action=api_subuser_coins\napi_token=PARENT_TOKEN&user_id=3&coins=100&reason=奖励
{\n "code": 200,\n "message": "调整成功",\n "data": {\n "new_balance": 200\n }\n}
为指定子用户开通或延期会员。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID | |
| plan_key string | 必填 | 套餐:day/week/month/quarter/year/forever | |
| duration int | 必填 | 时长(天) |
POST api.php?action=api_subuser_member\napi_token=PARENT_TOKEN&user_id=3&plan_key=month&duration=30
{\n "code": 200,\n "message": "设置成功",\n "data": {\n "end_date": "2026-09-11 23:59:59"\n }\n}
为指定子用户绑定 QQ 号。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID | |
| qq_number string | 必填 | QQ 号码 |
POST api.php?action=api_subuser_bind_qq\napi_token=PARENT_TOKEN&user_id=3&qq_number=123456789
{\n "code": 200,\n "message": "绑定成功",\n "data": null\n}
为指定子用户绑定邮箱地址。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | 父用户 API Token | |
| user_id int | 必填 | 子用户ID | |
| email string | 必填 | 邮箱地址 |
POST api.php?action=api_subuser_bind_email\napi_token=PARENT_TOKEN&user_id=3&email=sub@example.com
{\n "code": 200,\n "message": "绑定成功",\n "data": null\n}
卡密管理
3 个接口通过 API Token 创建卡密,可用于分销或批量生成。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token | |
| type string | 必填 | 类型:day/week/month/quarter/year/forever | |
| count int | 必填 | 生成数量 | |
| price float | 可选 | 每张卡密价格(可选) |
POST api.php?action=api_card_create\napi_token=TOKEN&type=month&count=10&price=25
{\n "code": 200,\n "message": "创建成功",\n "data": {\n "count": 10,\n "cards": [\n "CARD-XXXX-XXXX-XXXX",\n "CARD-YYYY-YYYY-YYYY"\n ]\n }\n}
获取当前用户创建的卡密列表。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token | |
| page int | 可选 | 页码,默认 1 | |
| page_size int | 可选 | 每页数量 | |
| type string | 可选 | 按类型筛选 | |
| status string | 可选 | 按状态筛选:unused/used/expired |
GET api.php?action=api_card_list&api_token=TOKEN&page=1&page_size=20
{\n "code": 200,\n "data": {\n "list": [\n {\n "id": 1,\n "code": "CARD-XXXX-XXXX-XXXX",\n "type": "month",\n "status": "unused",\n "price": 25.00,\n "created_at": "2026-08-11 10:00:00"\n }\n ],\n "total": 50,\n "page": 1,\n "page_size": 20\n }\n}
删除指定卡密,已使用的卡密不可删除。
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| api_token string | 必填 | API Token | |
| id int | 必填 | 卡密ID |
GET api.php?action=api_card_delete&api_token=TOKEN&id=1
{\n "code": 200,\n "message": "删除成功",\n "data": null\n}