文章详情
晓风聚合支付系统首页接口文档 v1.4
文档版本:v1.4|更新日期:2026-05-18
一、公开接口列表
| 序号 | 接口路径 | 请求方式 | 认证要求 | 功能说明 |
|---|---|---|---|---|
| 1 | /api/meta/site |
GET | 无需认证 | 获取网站元数据配置信息 |
| 2 | /api/auth/me |
GET | 无需认证 | 获取当前用户认证状态 |
| 3 | /api/meta/announcements?ann_type=site_popup |
GET | 无需认证 | 获取弹窗公告信息 |
| 4 | /api/meta/announcements?ann_type=normal |
GET | 无需认证 | 获取普通公告列表 |
| 5 | /api/auth/login-captcha |
GET | 无需认证 | 获取登录行为验证码 |
| 6 | /api/auth/email-code |
POST | 无需认证 | 发送邮箱验证码(注册) |
| 7 | /api/auth/login |
POST | 无需认证 | 用户登录 |
| 8 | /api/auth/merchant/register |
POST | 无需认证 | 商户注册 |
| 9 | /api/pay/public-test |
POST | 无需认证 | 首页创建测试订单 |
| 10 | /api/pay/cashier/{trade_no} |
GET | 无需认证 | 获取收银台详情 |
| 11 | /api/pay/result?trade_no={trade_no} |
GET | 无需认证 | 查询支付结果 |
二、网站元数据接口 GET · 公开
接口路径:/api/meta/site
响应示例
{
"code": 0,
"msg": "ok",
"data": {
"cashier_templates": [
{"code": "template1", "name": "简洁风格"},
{"code": "template2", "name": "标准风格"}
],
"home_pay_types": "alipay,wxpay,usdt,qqpay",
"monitor_download_android_url": "https://cyjl.ljwx.site/...",
"site_name": "晓风聚合支付系统",
"site_logo": "/uploads/site/logo_1775839580321427391.png",
"system_pay_pid": "M20260411c37ad0d84a"
}
}
字段说明
| 字段名 | 类型 | 说明 |
|---|---|---|
| cashier_templates | 数组 | 收银台模板列表 |
| cashier_templates[].code | 字符串 | 模板编码 |
| cashier_templates[].name | 字符串 | 模板名称 |
| home_pay_types | 字符串 | 首页支付类型逗号分隔 |
| monitor_download_android_url | 字符串 | 安卓监控APP下载地址 |
| site_name | 字符串 | 站点名称 |
| site_logo | 字符串 | 站点Logo路径 |
| system_pay_pid | 字符串 | 系统演示商户PID |
三、用户认证状态接口 GET · 公开
接口路径:/api/auth/me
已登录响应
{
"code": 0,
"msg": "ok",
"data": {
"role": "merchant",
"user_id": 2,
"username": "m_0e23d3b4bf"
}
}
未登录响应
{
"code": 0,
"msg": "ok",
"data": null
}
四、弹窗公告接口 GET · 公开
接口路径:/api/meta/announcements?ann_type=site_popup
{
"code": 0,
"msg": "ok",
"data": {
"list": [
{
"id": 1,
"ann_type": "site_popup",
"title": "晓风聚合支付系统",
"content": "晓风聚合支付系统,基于 Go 语言纯自主研发...",
"is_enabled": 1,
"created_at": "2026-04-11 06:58:25",
"updated_at": "2026-05-15 17:12:07"
}
]
}
}
五、普通公告接口 GET · 公开
接口路径:/api/meta/announcements?ann_type=normal
{
"code": 0,
"msg": "ok",
"data": {
"list": [
{
"id": 5,
"ann_type": "normal",
"title": "严禁违规业务",
"content": "本支付系统严禁违规业务...",
"is_enabled": 1,
"created_at": "2026-04-11 07:01:48",
"updated_at": "2026-04-11 07:01:48"
}
]
}
}
六、登录验证码接口 GET · 公开
接口路径:/api/auth/login-captcha
{
"code": 0,
"msg": "ok",
"data": {
"captcha_id": "63a0bd8fdb3b27d7",
"captcha_svg": "<svg xmlns=\"http://www.w3.org/2000/svg\" ...>",
"prompt": "请按顺序点击:石 → 树 → 火"
}
}
七、发送邮箱验证码接口 POST · 公开
接口路径:/api/auth/email-code
请求Body
{
"email": "test@example.com",
"purpose": "register"
}
响应
{
"code": 0,
"msg": "ok",
"data": null
}
八、用户登录接口 POST · 公开
接口路径:/api/auth/login
请求Body
{
"email": "3295564195@qq.com",
"password": "123456",
"captcha_id": "3e702cf04dc14487",
"captcha_points": [[100, 50], [150, 75], [200, 100]]
}
登录成功返回
{
"code": 0,
"msg": "ok",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"user_id": 2,
"username": "m_0e23d3b4bf",
"role": "merchant"
}
}
登录失败返回
{
"code": 1,
"msg": "验证码错误",
"data": null
}
九、商户注册接口 POST · 公开
接口路径:/api/auth/merchant/register
请求Body
{
"username": "",
"password": "test123456",
"email": "newtestuser@example.com",
"email_code": "123456",
"mobile": ""
}
十、创建测试订单接口 POST · 公开
接口路径:/api/pay/public-test
请求Body
{
"pay_type": "alipay",
"amount": 1
}
响应返回
{
"code": 0,
"msg": "ok",
"data": {
"trade_no": "T202605181901479191997b",
"cashier_url": "/cashier/T202605181901479191997b",
"channel": "alipay",
"amount": 1.06
}
}
十一、收银台详情接口 GET · 公开
接口路径:/api/pay/cashier/{trade_no}
{
"code": 0,
"msg": "ok",
"data": {
"trade_no": "T202605181855419a3a67da",
"out_trade_no": "PUBT1779101741189",
"amount": 1.02,
"subject": "首页测试支付",
"qrcode_url": "https://qr.alipay.com/bax02997ybchsc0eqaer254c",
"pay_url": "https://qr.alipay.com/bax02997ybchsc0eqaer254c",
"status": 0,
"expire_at": "2026-05-18 19:00:41",
"channel_code": "alipay_face",
"channel_id": 3,
"cashier_template": "template2"
}
}
十二、查询支付结果接口 GET · 公开
接口路径:/api/pay/result?trade_no={trade_no}
{
"code": 0,
"msg": "ok",
"data": {
"trade_no": "T202605181901037e5c56e8",
"out_trade_no": "PUBT1779102063401",
"amount": 1.05,
"original_amount": 1,
"notify_money": 1,
"notify_status": 0,
"status": 0,
"return_redirect_url": ""
}
}
订单状态说明:0=待支付,1=已支付,2=已退款,3=已取消
十三、商户侧接口(需签名认证)
13.1 挂机心跳接口 POST
签名规则:sign = MD5(key + pid + join(sorted(channel_ids), “,”) + timestamp)
路径:/api/merchant/channels/heartbeat
13.2 APP/PC 支付回调接口 POST
签名规则:sign = MD5(key + pid + channel_id + amount + timestamp)
路径:/api/pay/app/callback
13.3 页面跳转支付 /submit.php POST(无需认证)
13.4 API返回支付信息 /mapi.php POST(无需认证)
13.5 订单查询 /api.php?act=query GET(无需认证)
13.6 异步通知Webhook
支付完成后平台POST推送商户notify_url,商户返回字符串 success 代表接收成功。
接口变更记录
| 版本 | 日期 | 变更说明 |
|---|---|---|
| v1.4 | 2026-05-18 | 新增商户注册接口 /api/auth/merchant/register |
| v1.3 | 2026-05-18 | 新增测试支付、登录、查询支付结果接口 |
| v1.2 | 2026-05-18 | 新增收银台、发送邮箱验证码接口 |
| v1.1 | 2026-05-18 | 新增公告、登录验证码接口 |
| v1.0 | 2026-05-18 | 初始版本,首页公开接口+商户基础接口 |
版权:
转载请注明出处:https://g.ao9.cc/index.php/2026/06/21/api/