闸机接口说明
第三方接口调用规范文档
返回闸机

第三方接口调用规范文档(闸机 Gate)

1. 基本信息

2. 通用返回结构

所有响应均为 JSON 对象,字段如下:

字段类型必填说明
codeint状态码:0 表示处理成功;非 0 表示处理失败
msgstring状态描述信息(成功或失败原因)
dataobject详细数据对象(成功时可包含业务数据;失败时可包含错误详情)

示例:

{"code":0,"msg":"成功","data":{"id":123,"order_no":"VIP17735800121793563"}}

失败示例:

{"code":1,"msg":"失败","data":{"err":"请刷新二维码"}}

3. 开门校验(第三方调用)

3.1 POST(推荐)

字段类型必填说明
keystring第三方传入的 key。当前系统按订单号处理(即:key=订单号)

请求示例:

POST /gate/api/gate/ HTTP/1.1
Host: 2026.aihelper365.cn
Content-Type: application/json; charset=utf-8

{"key":"VIP17735800121793563"}

成功响应:

{"code":0,"msg":"成功","data":{"id":123,"order_no":"VIP17735800121793563"}}

失败响应(未找到签到记录):

{"code":1,"msg":"失败","data":{"err":"请刷新二维码"}}

3.2 GET(兼容扫码/浏览器)

参数类型必填说明
keystring与 POST 的 key 含义一致(当前按订单号处理)

请求示例:

GET /gate/api/gate/?key=VIP17735800121793563 HTTP/1.1
Host: 2026.aihelper365.cn

返回结构与 POST 一致。

4. 状态码与错误说明

codemsgdata.err说明
0成功/开门成功-已通过校验,并记录开门日志
1失败请刷新二维码未签到或校验失败(需要刷新二维码/更换有效 key)
1参数无效key 无效 / 缺少 key 或 action参数缺失或不合法
1请求方法不支持必须使用POST或GET请求方法不符合要求
1请求格式错误Content-Type 必须为 application/jsonPOST 时 Content-Type 不正确
500服务器错误/系统错误server error/system error服务端异常

5. 业务规则说明

6. 频率与超时建议