HeyAuth API路由

此文档也可以点击此处获取。启用Debug模式的 HeyAuth 访问 /docs 或者 /redoc 也可以获取。

用户路由 /api/user

POST 用户登录 /api/user/login

此API用于用户登录。

参数名	参数解释
username	用户名
password	密码

响应代码	示例响应	解释
200	{ "code": 200, " msg": "登录成功", "status": "ok" }	登录成功
400(40006)	{ "code": 40006, "msg": "账号或密码不能为空", "status": "error" }	错误的请求，可能的情况： 账号或密码为空
401(40005)	{ "code": 40005, "msg": "用户名或密码错误", "status": "error" }	未通过用户登录，可能的情况为： 用户名或密码错误
403(40001)	{ "code": 40001, "msg": "账号已被封禁", "status": "error" }	服务器拒绝访问，可能的情况为： 账号已被封禁、账号未验证
404(40004)	{ "code": 40004, "msg": "账号不存在", "status": "error" }	未找到，可能的情况为： 账号不存在
403(40003)	{ "code": 40003, "msg": "账号异常", "status": "error" }	请求格式正确，但是由于 语义错误，无法响应

GET 用户注销 /api/user/logout

此API用于用户退出登录。

响应代码	示例响应	解释
200	{ 'code': 200, 'msg': '注销成功', 'status': 'ok' }	退出登录成功

GET 获取当前用户所有授权信息 /api/user/auth

此API用于用户授权，需要登录后才可使用

响应代码	示例响应	解释
200	{ "code": 200, "data": [ { "product_name": "海枫授权系统", "product_id": 1, "domain": "auth.yxqi.cn", "status": "ok", "key": "114514", "time": "2024-09-20 23:32:15" }, { "product_name": "DiskNext 客户端", "product_id": 2, "domain": "xiaoqiu.in", "status": "ok", "key": "1919810", "time": "2024-10-01 21:57:03" } ], "msg": "" }	product_name: 产品名称 product_id: 产品ID domain: 授权域名 status: 授权状态 ok: 正常 ban: 被封禁 key: 授权码 默认为32位 time: 授权有效期

站点信息 /api/site

GET 站点心跳 /api/site/ping

此API用于检查您的站点是否正常运行，以及您的应用程序是否能够正常连接到海枫授权系统。

响应代码	示例响应	解释
200	{ "code": 200, "data": { "domain": "127.0.0.1", "client_ip": "127.0.0.1" }, "msg": "Pong" }	domain: 授权系统真实域名 client_ip: 客户端IP

更多内容补充中，前往 HeyAuth 开发文档 获取更多信息，亦可启动Debug模式的HeyAuth进行查看：