开放平台 · 开发者文档
给外部系统(商城 / 自助机 / 第三方 SaaS)调用门店能力的入口。门店管理员在场馆后台开通凭据后, 外部系统按下面两份文档接入即可。所有调用走 HTTPS + HMAC-SHA256 签名,访问范围严格限定在被授权门店。
https://www.gymker.com/api/open/v1 -
凭据创建与管理
开放平台凭据(AppId / AppSecret / AesKey)的创建、配置、轮换与排错——对接前的第一步。
-
加密与签名接入
极客场馆开放平台 AppId / AppSecret / AesKey 凭据、HMAC-SHA256 签名规范、AES 加密通道,附 Java / Node / Python 代码与自检清单。
-
通用约定与错误码
极客场馆开放平台统一响应结构、错误码表、幂等键、重试策略、限流约定,以及连通性自检接口 `/ping`。所有 scope 接口共用。
-
会员接口
会员相关接口:按 ID / 手机号查会员、全店会员列表 + 资产(余额 / 剩余节数 / 剩余周期)。统一 scope `member:read`。
-
订单接口
订单相关接口:查充值订单(列表 / 详情)、按会员查全部订单(含会籍 / 私教节数 / 私教周期 / 团课)。统一 scope `order:read`。
-
钱包接口
储值钱包相关接口:余额查询、流水(FIFO 本金 / 赠送)、小额扣款(单笔 ≤ 500 元,幂等)、扣款冲正。scope `wallet:read` / `wallet:deduct`。
-
约课接口
约课记录接口:按时段拉取会员约课记录,合并团课/小班预约(class)与私教排课(private)。统一 scope `booking:read`。
-
签到与消费接口
上课核销(签到/消课)记录与储值消费记录。统一 scope `attendance:read`。
-
课程·排课·场地接口
课程清单(course:read)、排课清单 / 教练排课 / 场地与场地使用情况(schedule:read)。
开通流程
- 登录极客场馆后台,进入「场馆管理 · 开放平台」新建凭据。
- 选择
sandbox(联调)或prod(上线)。 - 一次性下发
AppId / AppSecret / AesKey给对接方,AppSecret 不再可见,请妥善保存。 - 对接方按上方两份文档接入。
对接遇到问题请联系商务或加我们的对接群。每个 AppId 硬绑定一家门店,多门店对接需分别申请凭据。