服务端 API 汇总

更新时间：2021-05-25

本文档主要包括LinkV秀场直播SDK所涉及到的服务端API，如果服务端SDK中没有包含您所使用的语言，可按照本文档的说明来进行服务端的集成。

账号串联API

获取open_id及token

获取使用LinkV秀场直播SDK需要的live_open_id及live_token。

请求URL：/open/v0/thGetToken
支持格式：表单参数
请求方式：POST（application/x-www-form-urlencoded）
请求参数：

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce_str	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
userId	true	string	用户 Id，支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式，最大长度 64 字节。是用户在 App 中的唯一标识，必须保证在同一个 App 内不重复，重复的用户 Id 将被当作是同一用户。
name	true/false	string	用户名称，最大长度 128 字节。用来在开播时显示用户的名称。（注册必传）
portraitUri	true/false	string	用户头像 URI，最大长度 1024 字节。（注册必传）
email	false	string	用户邮箱
countryCode	false	string	用户国家码如：US
birthday	false	string	用户生日。2010-01-01
sex	false	string	性别 -1：未知，1：男，0：女

返回字段说明

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
data	object
token	string	用户 live_token，可以保存应用内，长度在 256 字节以内。
userId	string	用户 Id，与参数 userId 相同。
openId	string	LinkV互动娱乐生成的唯一live_open_id 。用户开播校验

返回示例

// success
{
    "data": {
        "token": "asdsaddfa3234234ada2adsf",
        "userId": "534961119",
        "openId": "115213496111983232934",
    },
    "msg": "",
    "status": "200"
}

// error
{
    "status": "403",
    "msg": "sign err",
    "data": []
}

错误码说明

错误码	描述	解决方案
400	参数错误 / 参数长度错误	确认必传参数是否缺少 / 确认userId长度是否超过64位
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们

钱包方案相关API

完成订单

充值完成后增加金币。

请求URL： /open/finanv0/orderSuccess
支持格式：表单参数
请求方式： POST（application/x-www-form-urlencoded）
请求参数：

参数	必选	类型	说明
app_id	true	string	LinkV 分配的live_app_id
nonce_str	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
uid	true	string	通过接口获取到的 live_open_id
request_id	true	string	32位长度随机字符串，用来进行幂等。推荐算法(uuid)
type	true	string	1.订单增加金币;2.订单删除金币
value	true	string	要变化的金币数量
order_id	true	string	通过互动娱乐SDK获取的order_id
expriation	true	int	过期时间戳例: $expiration = (time() / 86400 + 91) * 86400 ;
money	true	int	充值美元(单位/分)
channel	true	string	LinkV 分配的live_app_alias
platform	true	string	支付平台：h5;ios;android

返回字段说明

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
data	object
tokens	string	用户剩余金币

返回示例

// success
{
    "data": {
        "tokens": "123",
    },
    "msg": "",
    "status": "200"
}

// error
{
    "status": "403",
    "msg": "sign err"
}

错误码说明

错误码	描述	解决方案
400	参数错误 / 参数长度错误	确认必传参数是否缺少 / 确认userId长度是否超过64位
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们

修改金币

用户钱包金币的增、减操作。

请求URL： /open/finanv0/changeGold
支持格式：表单参数
请求方式： POST（application/x-www-form-urlencoded）
请求参数：

参数	必选	类型	说明
app_id	true	string	LinkV 分配的live_app_id
nonce_str	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
uid	true	string	通过接口获取到的 live_open_id
request_id	true	string	32位长度随机字符串，用来进行幂等。推荐算法(uuid)
type	true	string	1.订单增加金币;2.订单删除金币
value	true	string	要变化的金币数量
expriation	true	int	过期时间戳例: $expiration = (time() / 86400 + 91) * 86400 ;
reason	false	string	本次操作原因

返回字段说明：

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息

返回示例：

// success
{
    "msg": "",
    "status": "200"
}

// error
{
    "status": "403",
    "msg": "sign err"
}

错误码说明：

错误码	描述	解决方案
400	参数错误 / 参数长度错误	确认必传参数是否缺少 / 确认userId长度是否超过64位
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们

查询金币

查询用户钱包的金币余额。

请求URL： /open/finanv0/getUserTokens
支持格式：表单参数
请求方式： POST（application/x-www-form-urlencoded）
请求参数：

参数	必选	类型	说明
app_id	true	string	LinkV 分配的live_app_id
nonce_str	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
uid	true	string	通过接口获取到的 live_open_id

返回字段说明：

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
data	object
tokens	string	用户剩余金币

返回示例：

// success
{
    "data": {
        "tokens": "123",
    },
    "msg": "",
    "status": "200"
}

// error
{
    "status": "403",
    "msg": "sign err"
}

错误码说明：

错误码	描述	解决方案
400	参数错误 / 参数长度错误	确认必传参数是否缺少 / 确认userId长度是否超过64位
403	签名错误	参照签名生成进行签名生成
500	系统错误	联系我们

非钱包方式，透传方案

方案介绍

方案步骤

注意事项

接口说明

方案介绍

使用接入方的金币系统时, 需接入方开发扣款接口由LinkV送礼时调用

方案步骤

linkv sdk发起送礼
linkv 服务端调用接入方服务端的api接口（按照linkv 文档实现）完成扣款并送礼结束

注意事项

接入方需要保障接口稳定性及响应速度，失败与超时直接影响sdk内用户使用体验

接口说明

扣款接口

请求URL： [可自定义]
支持格式：表单参数
请求方式： POST（application/x-www-form-urlencoded）
请求参数：

参数	必选	类型	说明
app_id	true	string	LinkV 分配的live_app_id
request_id	true	string	32位长度随机字符串，用来进行幂等。推荐算法(uuid)
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
user_id	true	string	送礼人id
gold	true	string	扣金币数
expriation	true	int	超时时间戳例: $expiration = (time() / 86400 + 91) * 86400 ;
type	true	string	"扣款类型1. 送礼"
reason	true	string	"扣款内容json 数据体不同扣款类型不同"
gift_id	true	string	礼物id
send_num	true	int	送礼数量
receiver_id	true	string	收礼人id
vtype	true	string	"直播间类型 1: 普通直播间 8: 多人直播间"
resource_id	true	string	直播间id
sign	true	string	生成的签名串签名生成中的 3.计算签名值

请求参数示例

{
  app_id: 'LM6000167049877161121920',
  expriation: '1638156748',
  gold: '5',
  nonce: 'u06au4x31630294348ha2zeb15',
  reason: '{"gift_id":"10620","send_num":1,"resource_id":"16302940574638332063","vtype":"1","receiver_id":"1431136630483329025"}',
  request_id: 'bf612c514beb0712816ee60b708acaa6',
  sign: '97a808eebdc4ebd5791f476b53c6a7bb',
  type: '1',
  user_id: '19718472'
}

返回字段说明：

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
gold	int	现有金币数

返回示例：

// success
{
    "staus":200,
    "msg": "",
    "gold": 120
}

// error
{
    "status": 500,
    "msg": "sign err"
}

错误码说明：

错误码	描述	解决方案
400	参数错误	请查看参数请求格式
500	系统错误	联系我们

服务端签名说明

秀场直播