Open Platform · Developer Docs
Lets external systems (storefronts, self-service kiosks, third-party SaaS) call studio capabilities. Gym admins issue credentials in the console; partners integrate via the two guides below. All calls go over HTTPS + HMAC-SHA256, scoped to the authorized gym.
Note · API docs are currently maintained in Chinese only. An English edition is planned.
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）。
Onboarding
- Sign in to the Gymker console → "Gym Management · Open Platform" → create a credential set.
- Pick
sandbox(integration) orprod(live). - Hand off
AppId / AppSecret / AesKeyto your partner once. AppSecret is shown only once. - Partner integrates following the two guides above.
Each AppId is hard-bound to one gym; multi-gym integrations need separate credentials per gym.
