社区提供的接口说明
1.授权用户
接口地址
- /tenant/authorization
简要描述
- 授权租户下的用户到社区
参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| token | 是 | string | 授权令牌 |
| avatar | 否 | string | 头像URL |
| nick | 是 | string | 昵称 |
| uid | 是 | string | 用户ID |
| tenantId | 是 | string | 租户ID |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JSONObject | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040201 余额不足
2.发送会员钱包信息(接入方->社区方)
接口地址
- /tenant/event
简要描述
- 发送会员钱包信息,如现金，彩金，NBC币，积分余额
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | member_balance.sync |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| cash | 是 | string | 现金余额 |
| bonus | 是 | string | 彩金余额 |
| nbc | 是 | string | nbc币余额 |
| score | 是 | string | 积分余额 |
| uid | 是 | string | 会员uid |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonOjbect | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040201 余额不足
3.发送会员打开转盘事件(接入方->社区方)
接口地址
- /tenant/event
简要描述
- 发送会员打开转盘事件,传递打开转盘时消耗类型，会员终端类型，会员分层id
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | turntable.open |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| consumeType | 是 | string | 消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金 |
| terminalType | 是 | string | 会员终端类型 3--h5 4--android app 5--ios app 6--pwa |
| rankId | 是 | string | 会员分层id |
| depositAmount | 是 | string | 会员充值总额 |
| uid | 是 | string | 会员uid |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonOjbect | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040203 消耗类型不存在
4.发送租户分层列表事件(接入方->社区方)
接口地址
- /tenant/event
简要描述
- 发送租户分层列表事件,租户分层列表有变动时实时通知社区方
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | tenant.rank.sync |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| rankList | 是 | Array | 租户分层列表 [{"id":243143124,"name":"测试分层"}] |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonOjbect | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040204 分层列表数据为空
5.发送会员打开红包雨事件(接入方->社区方)
接口地址
- /tenant/event
简要描述
- 发送会员打开红包雨事件,传递打开红包雨时消耗类型，会员终端类型，会员分层id
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | redpacket.rain.open |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| consumeType | 是 | string | 消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金 |
| terminalType | 是 | string | 会员终端类型 3--h5 4--android app 5--ios app 6--pwa |
| rankId | 是 | string | 会员分层id |
| depositAmount | 是 | string | 会员充值总额 |
| uid | 是 | string | 会员uid |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonOjbect | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040203 消耗类型不存在
6.接收会员在社区组件中的奖信息事件(社区方->接入方)
接口地址
- 社区管理端后台配置的接入方回调地址
简要描述
- 接收会员转盘中奖信息，如中奖金额，打码量倍数，消耗类型，组件名，用户id
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | player.reward |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| consumeType | 是 | string | 消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金 |
| amount | 是 | string | 中奖金额 |
| betRate | 是 | string | 打码量倍数 |
| gameName | 是 | string | 参与的组件名(各组件要唯一) |
| uid | 是 | string | 会员uid |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonObject | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040206 游戏数据不正确
7.接收会员在社区组件中的消耗金额事件(社区方->接入方)
接口地址
- 社区管理端后台配置的接入方回调地址
简要描述
- 接收会员在社区组件中的消耗金额信息，如金额，消耗类型
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | player.consume |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| consumeType | 是 | string | 消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金 |
| amount | 是 | string | 中奖金额 |
| gameName | 是 | string | 参与的组件名(各组件要唯一) |
| uid | 是 | string | 会员uid |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonObject | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040207 消耗类型不存在
8.加减用户虚拟币余额
接口地址
- /tenant/event
简要描述
- 更新用户当前虚拟币余额
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | coin.balance.update |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| amount | 是 | string | 增减的金额(扣余额传负数金额) |
| userId | 是 | string | 会员id |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JSONObject | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040211 会员不存在
9.查询用户虚拟币余额
接口地址
- /tenant/event
简要描述
- 查询用户当前虚拟币余额
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | coin.balance |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| userId | 是 | string | 会员id |
返回示例
{
"success": true,
"code": 0,
"data": {}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JSONObject | 返回信息 |
备注
- code 错误码 0 成功 非0 不成功 如1040211 会员不存在
12.获取社区所有活动状态事件(接入方->社区方)
接口地址
- /tenant/event
简要描述
- 获取社区里转盘，红包雨，签到等各种活动的开启关闭状态，用于接入方判断是否显示社区活动
参数
| 参数名 | 必选 | 类型 | 说明 | 参数值 |
|---|---|---|---|---|
| type | 是 | string | 事件名 | activity.status |
| data | 是 | string | 事件数据 | 见data参数 |
| tenantId | 是 | string | 租户id |
data参数
返回示例
{
"success": true,
"code": 0,
"data": {"turntable":1,"redpacketRain":0,"sign":1"}
}返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| success | Boolean | 成功与否 |
| code | Integer | 错误码 |
| data | JsonOjbect | 返回信息 |
data参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| status | 是 | integer | 狀態 0:開啟,1:未開啟 |
备注
- code 错误码 0 成功 非0 不成功 如1040203 服务异常