分配或释放席位
POST/api/v1/seats/manage
在已购买容量内分配真实客户;收费数量变更通过 Funnel 的确认动作执行。
SDK 0.0.1更新于
发起请求
在已购买容量内分配真实客户;收费数量变更通过 Funnel 的确认动作执行。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
billing:write
base URL 和 App ID 来自 SDK 接入页。示例使用占位值,不会执行请求。服务端 Key 不可放入浏览器。
Web Beta 的结账需要明确配置 Stripe Sandbox 测试账号与已发布价格映射。跳转完成不等于支付确认。
1curl -X POST "$GROOVE_BASE_URL/api/v1/seats/manage" \2 -H "Authorization: Bearer $GROOVE_SECRET_KEY" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "customerId": "00000000-0000-4000-8000-000000000001",8 "requestId": "00000000-0000-4000-8000-000000000001",9 "action": "assign",10 "poolId": "00000000-0000-4000-8000-000000000001",11 "memberCustomerId": "00000000-0000-4000-8000-000000000001"12}'
响应选项卡列出字段类型,不是响应示例;实际值由客户状态决定。
请求参数
JSON 请求体
customerIduuid | uuid | uuid必填Indiana 客户 ID。服务端从已验证身份关联;客户 Token 调用时省略并使用 Token 绑定的客户。
requestIduuid | uuid | uuid必填你的业务请求 UUID;同一次操作重试复用,新的操作生成新值。
action"assign" | "assign_entity" | "release"必填本次业务动作。不同动作的目标字段和数量要求不同,见请求结构与示例。
poolIduuid | uuid | uuid必填当前范围内的积分池 UUID。
memberCustomerIduuid可选本次操作的 memberCustomerId 值,类型和约束见字段标注。
entityIduuid可选当前客户范围内的实体 ID;只用于已配置的实体和许可功能。
slotIduuid可选本次操作的 slotId 值,类型和约束见字段标注。
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果;可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID,排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对,不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围:sandbox 或 live。
查看允许值
"sandbox""live"
seatsobject必填本次操作的 seats 值,类型和约束见字段标注。
展开子字段
customerIduuid必填Indiana 客户 ID。服务端从已验证身份关联;客户 Token 调用时省略并使用 Token 绑定的客户。
poolsarray必填本次操作的 pools 值,类型和约束见字段标注。
maxItems: 2000
展开子字段
iduuid必填本次操作的 id 值,类型和约束见字段标注。
membershipIduuid必填本次操作的 membershipId 值,类型和约束见字段标注。
entityIduuid | null必填当前客户范围内的实体 ID;只用于已配置的实体和许可功能。
keystring必填本次操作的 key 值,类型和约束见字段标注。
namestring必填客户或对象的展示名称,不作为身份唯一键。
entitlementVersionIduuid必填本次操作的 entitlementVersionId 值,类型和约束见字段标注。
memberProductVersionIduuid必填本次操作的 memberProductVersionId 值,类型和约束见字段标注。
includedQuantityinteger必填本次操作的 includedQuantity 值,类型和约束见字段标注。
min: 0 · max: 9007199254740991
quantityinteger必填业务数量按字段标注类型传入;积分操作用十进制字符串,避免浮点误差。quote/reserve/confirm/refund 要求正数;consume 可记录零费用事件。
min: 0 · max: 9007199254740991
maximumQuantityinteger必填本次操作的 maximumQuantity 值,类型和约束见字段标注。
min: 0 · max: 9007199254740991
assignedQuantityinteger必填本次操作的 assignedQuantity 值,类型和约束见字段标注。
min: 0 · max: 9007199254740991
availableQuantityinteger必填本次操作的 availableQuantity 值,类型和约束见字段标注。
min: 0 · max: 9007199254740991
accessEnabledboolean必填本次操作的 accessEnabled 值,类型和约束见字段标注。
requireAssignmentboolean必填本次操作的 requireAssignment 值,类型和约束见字段标注。
pendingChangeobject | null必填本次操作的 pendingChange 值,类型和约束见字段标注。
展开子字段
receiptIduuid必填本次操作的 receiptId 值,类型和约束见字段标注。
quantityinteger必填业务数量按字段标注类型传入;积分操作用十进制字符串,避免浮点误差。quote/reserve/confirm/refund 要求正数;consume 可记录零费用事件。
min: 0 · max: 10000
timingenum必填立即变更或在周期末变更;只用于契约允许的套餐变更动作。
查看允许值
"immediate""renewal"
statusenum必填本次操作的 status 值,类型和约束见字段标注。
查看允许值
"prepared""quoted""confirmed""pending""scheduled"
effectiveAtdate-time必填本次操作的 effectiveAt 值,类型和约束见字段标注。
periodobject必填本次操作的 period 值,类型和约束见字段标注。
展开子字段
startsAtdate-time必填本次操作的 startsAt 值,类型和约束见字段标注。
endsAtdate-time | null必填本次操作的 endsAt 值,类型和约束见字段标注。
slotsarray必填本次操作的 slots 值,类型和约束见字段标注。
maxItems: 10000
展开子字段
iduuid必填本次操作的 id 值,类型和约束见字段标注。
poolIduuid必填当前范围内的积分池 UUID。
positioninteger必填本次操作的 position 值,类型和约束见字段标注。
max: 9007199254740991
memberCustomerIduuid | null必填本次操作的 memberCustomerId 值,类型和约束见字段标注。
entityIduuid | null必填当前客户范围内的实体 ID;只用于已配置的实体和许可功能。
assignedAtdate-time必填本次操作的 assignedAt 值,类型和约束见字段标注。
releasedAtdate-time | null必填本次操作的 releasedAt 值,类型和约束见字段标注。
limitedboolean必填本次操作的 limited 值,类型和约束见字段标注。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key,或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key,或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引