签到与消费接口
上课核销(签到/消课)记录与储值消费记录。统一 scope `attendance:read`。
极客场馆开放平台 · 签到与消费接口
版本 v1 · 配套文档:加密与签名接入 · 通用约定与错误码 所有路径前缀
https://www.gymker.com/api/open/v1。响应/错误码/幂等/限流见通用约定。
1. 能力总览
| 能力 | scope | 典型用途 |
|---|---|---|
| 上课核销记录(签到/消课) | attendance:read | 看会员实际上课、课时消耗 |
| 储值消费/消课记录 | attendance:read | 看储值余额扣划流水 |
每个 AppId 只对应一家门店,所有接口自动按该门店过滤。两接口时间区间均按
createTime,单端不限制、两端跨度 ≤ 90 天。
2. 上课核销记录 · GET /attendances
会员实际上课的核销(签到 / 消课)记录。只透出对客口径字段,不暴露对内核算价值(actualValue / coachFee)。scope attendance:read。
| Query | 类型 | 必填 | 说明 |
|---|---|---|---|
memberId | long | 否 | 按会员过滤 |
startDate / endDate | yyyy-MM-dd | 否 | 按 createTime 过滤,两端跨度 ≤ 90 天 |
page / size | int | 否 | 默认 1 / 20,size ≤ 100 |
data:{ records[], total, current, size },records[] 单元素:
{
"id": 70001, "memberId": 12345, "scheduleId": 88001,
"orderType": "PRIVATE_TIMES",
"coachStaffId": 5001, "courseTypeId": 301,
"startTime": "2026-05-22T10:00:00", "endTime": "2026-05-22T11:00:00",
"standardValue": 300.00, // 单次标准扣划价值(对客)
"storedValueSelfDeduct": 0.00, // 自充余额实扣
"storedValueGiftDeduct": 0.00, // 赠送余额实扣
"status": 1, "createTime": "2026-05-22T11:05:00"
}
3. 储值消费/消课记录 · GET /consumptions
储值扣划主表流水。operationType(DEDUCT / FREEZE / RELEASE …)+ bizType(COURSE 即消课 …)标识消费场景。仅透出对客金额。scope attendance:read。
| Query | 类型 | 必填 | 说明 |
|---|---|---|---|
memberId | long | 否 | 按会员过滤 |
operationType | string | 否 | 按操作类型过滤(DEDUCT / FREEZE / RELEASE …) |
startDate / endDate | yyyy-MM-dd | 否 | 按 createTime 过滤,两端跨度 ≤ 90 天 |
page / size | int | 否 | 默认 1 / 20,size ≤ 100 |
data:{ records[], total, current, size },records[] 单元素:
{
"id": 60001, "memberId": 12345, "accountId": 9001,
"operationType": "DEDUCT", "bizType": "COURSE",
"bizNo": "WX20260522-0007", "bizId": 88001,
"totalAmount": 300.00, "selfAmount": 200.00, "giftAmount": 100.00,
"remark": "团课核销", "createTime": "2026-05-22T11:05:00"
}