自有账号系统积分接口--企业直播-火山引擎

文档中心

立即注册

导航

自有账号系统积分接口

最近更新时间：2023.09.22 17:59:45首次发布时间：2021.09.02 12:01:21

企业直播支持与您的积分系统对接，实现观众兑换积分礼物打赏主播的操作。本文介绍您需要自行开发的接口的相关规范，请按照规范完成接口的开发。

说明

如果在对接过程中遇到问题，请联系客户经理或技术支持。

背景信息

观众可以消耗积分兑换礼物，对主播实时进行打赏。为实现该功能，您需要开发以下两个接口，并在直播间的营销互动 > 礼物打赏页面选择积分消费方式后完成以下接口配置。更多有关积分礼物打赏的功能介绍，详见礼物打赏。

积分查询接口

接口说明：企业直播可通过调用该接口，从您的自有账号系统中获取用户的剩余积分，并在企业直播观看页上同步展示。
请求方式：GET

请求参数

Query 参数

参数	类型	是否必选	描述
UserId	String	是	您自有账号系统的用户 ID。
UserName	String	是	您自有账号系统的用户名称。
Ts	Integer	是	接口调用时，系统时间的 Unix 秒级时间戳。
ActivityId	Integer	是	直播间的活动 ID。
Sign	String	是	校验值。该参数值获取方法如下：将以上所有参数和参数值基于参数名称按字典序排列。按照`参数名称参数值参数名称参数值`的格式进行拼接。首尾加上 `accountSecret` 的值。联系技术支持获取 `accountSecret` 的值。将字符串进行 MD5 加密并转化为 32 位小写密文。例如： `{ "UserId": "8erwwdfthf6e**", "UserName": "UserA", "Ts": 1650778541, "ActivityId": "172982551195" }` `accountSecret`的值为`abc`，则拼接后的字符串为`abcActivityId172982551195Ts1650778541UserId8erwwdfthf6eUserNameUserAabc`，将字符串进行 MD5 加密并转化为 32 位小写密文，`Sign` 的值为 `2625701639ccf0081d3862ab6815**`。

返回参数

Body 参数

参数	类型	是否必选	描述
Code	Integer	是	HTTP 状态码。
Status	Integer	是	服务状态。 `0`：成功 `1`：积分不足 `2`：其他错误
Message	String	是	当 `Status` 的值为 `2` 时，返回的错误信息。
Data	Integer	是	用户的剩余积分。

示例

请求示例

GET https://test.com/get?UserId=8erwwdfthf6e****&UserName=UserA&Ts=1650778541&ActivityId=172982551195****&Sign=2625701639ccf0081d3862ab6815****

返回示例

{
        "Code": 200, 
        "Status": 0, 
        "Message": "", 
        "Data": 123 
    }

积分更新接口

接口说明：企业直播可通过调用该接口，将用户兑换礼物消耗的积分从企业直播同步更新至您的自有账号系统中。
请求方式：POST

请求参数

Body 参数

参数	类型	是否必选	描述
UserId	String	是	您自有账号系统的用户 ID。
UserName	String	是	您自有账号系统的用户名称。
Ts	Integer	是	接口调用时，系统时间的 Unix 秒级时间戳。
GiftName	String	是	积分兑换的礼物名称。
GiftPrice	Integer	是	积分兑换的礼物价格。
GiftCount	Integer	是	积分兑换的礼物数量。
Amount	Integer	是	总共兑换的积分。
ActivityId	Integer	是	直播间的活动 ID。
Sign	String	是	校验值。该参数值获取方法如下：将以上所有参数和参数值基于参数名称按字典序排列。按照`参数名称参数值参数名称参数值`的格式进行拼接。首尾加上 `accountSecret` 的值。联系技术支持获取 `accountSecret` 的值。将字符串进行 MD5 加密并转化为 32 位小写密文。例如： `{ "UserId": "8erwwdfthf6e**", "UserName": "UserA", "Ts": 1650778541, "GiftName": "小心心", "GiftPrice": 1, "GiftCount": 100, "Amount": 100, "ActivityId": "172982551195" }` `accountSecret`的值为`abc`，则拼接后的字符串为`abcActivityId172982551195Amount100GiftCount100GiftName小心心GiftPrice1Ts1650778541UserId8erwwdfthf6eUserNameUserAabc`，将字符串进行 MD5 加密并转化为 32 位小写密文，`Sign` 的值为`3d3436e952701b7cbb72853e709b**`。

返回参数

Body 参数

参数	类型	是否必选	描述
Code	Integer	是	HTTP 状态码。
Status	Integer	是	服务状态。 `0`：成功 `1`：积分不足 `2`：其他错误
Message	String	是	当 `Status` 的值为 `2` 时，返回的错误信息。
Data	Integer	是	用户的剩余积分。

示例

请求示例

POST https://test.com/post
            header Content-Type: application/json; charset=utf-8
            body {
                 "UserId": "8erwwdfthf6e****",
                 "UserName": "UserA",
                 "Ts": 1650778541,
                 "GiftName": "小心心",
                 "GiftPrice": 1,
                 "GiftCount": 100,
                 "Amount": 100,
                 "ActivityId": "172982551195****",
                 "Sign": "3d3436e952701b7cbb72853e709b****"
                 }

返回示例

{
       "Code": 200, 
       "Status": 0, 
       "Message": "", 
       "Data": 123 
   }