自建应用接入概览
本组页面写给为场馆开发应用的工程师:场馆自己的技术团队,或场馆委托的外包、服务商。应用部署在你们自己的服务器上,通过 Betly 开放的接口读取数据、让员工和会员用 Betly 账号登录、接收业务事件。
应用能做什么
| 能力 | 用途 | 详见 |
|---|---|---|
| 应用凭证调接口 | 服务端读取本组织的订单、员工、门店等数据 | 用应用凭证调用开放接口 |
| 员工、会员登录 | 员工用 Betly 后台账号、会员用手机号验证码登录你的应用,不用另建账号 | 员工与会员登录 |
| 权限项与后台菜单 | 在 Betly 角色里控制谁能进应用、谁能点某个按钮;在 Betly 后台侧栏放应用入口 | 权限项与后台菜单入口 |
| 事件推送 | 订单支付、会员卡开卡、签到等发生时,Betly 主动通知你的应用 | 接收事件推送 |
应用可以只用其中一部分。例如只做数据看板,用应用凭证就够了;做“会员提申请、员工审核”这类应用,就需要登录、权限项和菜单入口。
几条基本约定
- 一个应用只属于一个组织。同一套程序给多家场馆用,要在每家场馆各登记一次,各自拿到独立的凭证。
- 应用能读什么,由场馆管理员授权决定。登记应用不等于获得数据,管理员在 Betly 后台勾选权限范围、启用授权后才生效,随时可以暂停或吊销。
- Betly 不托管你的用户体系。应用可以有自己的账号、数据库和登录方式;Betly 只负责证明“这个人是本组织的哪位员工 / 哪位会员”。
- 所有身份以 Betly 的编号为准。员工和会员各有一个本组织内唯一的编号(下文的
sub)。同一个人既是员工又是会员时,是两个不同的编号。
接入流程
- 场馆管理员在 Betly 后台登记应用,把凭证交给你(登记应用与获取凭证)。
- 管理员勾选权限范围、选择谁可以登录,并启用授权。
- 你用应用凭证调接口、实现登录回调、配置事件回调。
- 管理员按需给角色分配应用的权限项,并在后台侧栏挂上应用入口。
环境地址
| 用途 | 地址 |
|---|---|
| 开放接口 | https://api.mx5.cn/api/v1 |
| 接口文档(可在线调试) | https://api.mx5.cn/api/v1/docs |
| 登录授权入口 | https://admin.mx5.cn/oauth/authorize |
| 换取令牌 | https://supa.mx5.cn/auth/v1/oauth/token |
联调用的测试环境地址,请向 Betly 申请。
用编程助手开发
用 AI 编程助手开发应用时,先让它阅读 给编程助手的集成说明,或直接把 https://docs.mx5.cn/developers/llms-full.txt 交给它,里面是整个开发者指南的纯文本合集。
