Skip to content

社区提供的接口说明

1.授权用户

接口地址

  • /tenant/authorization
简要描述
  • 授权租户下的用户到社区
参数
参数名必选类型说明
tokenstring授权令牌
avatarstring头像URL
nickstring昵称
uidstring用户ID
tenantIdstring租户ID
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJSONObject返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040201 余额不足

2.发送会员钱包信息(接入方->社区方)

接口地址

  • /tenant/event
简要描述
  • 发送会员钱包信息,如现金,彩金,NBC币,积分余额
参数
参数名必选类型说明参数值
typestring事件名member_balance.sync
datastring事件数据见data参数
tenantIdstring租户id
data参数
参数名必选类型说明
cashstring现金余额
bonusstring彩金余额
nbcstringnbc币余额
scorestring积分余额
uidstring会员uid
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJsonOjbect返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040201 余额不足

3.发送会员打开转盘事件(接入方->社区方)

接口地址

  • /tenant/event
简要描述
  • 发送会员打开转盘事件,传递打开转盘时消耗类型,会员终端类型,会员分层id
参数
参数名必选类型说明参数值
typestring事件名turntable.open
datastring事件数据见data参数
tenantIdstring租户id
data参数
参数名必选类型说明
consumeTypestring消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
terminalTypestring会员终端类型 3--h5 4--android app 5--ios app 6--pwa
rankIdstring会员分层id
uidstring会员uid
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJsonOjbect返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040203 消耗类型不存在

4.发送租户分层列表事件(接入方->社区方)

接口地址

  • /tenant/event
简要描述
  • 发送租户分层列表事件,租户分层列表有变动时实时通知社区方
参数
参数名必选类型说明参数值
typestring事件名tenant.rank.sync
datastring事件数据见data参数
tenantIdstring租户id
data参数
参数名必选类型说明
rankListArray租户分层列表 [{"id":243143124,"name":"测试分层"}]
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJsonOjbect返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040204 分层列表数据为空

5.发送会员打开红包雨事件(接入方->社区方)

接口地址

  • /tenant/event
简要描述
  • 发送会员打开红包雨事件,传递打开红包雨时消耗类型,会员终端类型,会员分层id
参数
参数名必选类型说明参数值
typestring事件名redpacket.rain.open
datastring事件数据见data参数
tenantIdstring租户id
data参数
参数名必选类型说明
consumeTypestring消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
terminalTypestring会员终端类型 3--h5 4--android app 5--ios app 6--pwa
rankIdstring会员分层id
uidstring会员uid
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJsonOjbect返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040203 消耗类型不存在

6.接收会员在社区组件中的奖信息事件(社区方->接入方)

接口地址

  • 社区管理端后台配置的接入方回调地址
简要描述
  • 接收会员转盘中奖信息,如中奖金额,打码量倍数,消耗类型,组件名,用户id
参数
参数名必选类型说明参数值
typestring事件名player.reward
datastring事件数据见data参数
tenantIdstring租户id
data参数
参数名必选类型说明
consumeTypestring消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
amountstring中奖金额
betRatestring打码量倍数
gameNamestring参与的组件名(各组件要唯一)
uidstring会员uid
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJsonObject返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040206 游戏数据不正确

7.接收会员在社区组件中的消耗金额事件(社区方->接入方)

接口地址

  • 社区管理端后台配置的接入方回调地址
简要描述
  • 接收会员在社区组件中的消耗金额信息,如金额,消耗类型
参数
参数名必选类型说明参数值
typestring事件名player.consume
datastring事件数据见data参数
tenantIdstring租户id
data参数
参数名必选类型说明
consumeTypestring消耗余额类型 1-彩金 2-nbc币 3-积分 4-现金
amountstring中奖金额
gameNamestring参与的组件名(各组件要唯一)
uidstring会员uid
返回示例
  {
    "success": true,
    "code": 0,
    "data": {}
}
返回参数说明
参数名类型说明
successBoolean成功与否
codeInteger错误码
dataJsonObject返回信息
备注
  • code 错误码 0 成功 非0 不成功 如1040207 消耗类型不存在