服务端 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_idtruestringLinkV 分配的app_id
nonce_strtruestring随机字符串,前八位和后八位为随机字符串,中间为秒级时间戳
signtruestring生成的签名串 签名生成
userIdtruestring用户 Id,支持大小写英文字母、数字、部分特殊符号 + = - _ 的组合方式,最大长度 64 字节。是用户在 App 中的唯一标识,必须保证在同一个 App 内不重复,重复的用户 Id 将被当作是同一用户。
nametrue/falsestring用户名称,最大长度 128 字节。用来在 开播时显示用户的名称。(注册必传)
portraitUritrue/falsestring用户头像 URI,最大长度 1024 字节。(注册必传)
emailfalsestring用户邮箱
countryCodefalsestring用户国家码 如:US
birthdayfalsestring用户生日。2010-01-01
sexfalsestring性别 -1:未知,1:男,0:女
  • 返回字段说明
返回字段字段类型说明
statusint返回结果状态。200:正常。
msgstring返回状态信息
dataobject
    tokenstring用户 live_token,可以保存应用内,长度在 256 字节以内。
    userIdstring用户 Id,与参数 userId 相同。
    openIdstringLinkV互动娱乐生成的唯一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系统错误联系我们

Saas钱包方案相关API

完成订单

充值完成后增加金币。

  • 请求URL: /open/finanv0/orderSuccess
  • 支持格式: 表单参数
  • 请求方式: POST(application/x-www-form-urlencoded)
  • 请求参数:
参数必选类型说明
app_idtruestringLinkV 分配的live_app_id
nonce_strtruestring随机字符串,前八位和后八位为随机字符串,中间为秒级时间戳
signtruestring生成的签名串 签名生成
uidtruestring通过接口获取到的 live_open_id
request_idtruestring32位长度随机字符串,用来进行幂等。推荐算法(uuid)
typetruestring1.订单增加金币;2.订单删除金币
valuetruestring要变化的金币数量
order_idtruestring通过互动娱乐SDK获取的order_id
expriationtrueint过期时间戳 例: $expiration = (time() / 86400 + 91) * 86400 ;
moneytrueint充值美元(单位/分)
channeltruestringLinkV 分配的live_app_alias
platformtruestring支付平台:h5;ios;android
  • 返回字段说明
返回字段字段类型说明
statusint返回结果状态。200:正常。
msgstring返回状态信息
dataobject
    tokensstring用户剩余金币
  • 返回示例
// 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_idtruestringLinkV 分配的live_app_id
nonce_strtruestring随机字符串,前八位和后八位为随机字符串,中间为秒级时间戳
signtruestring生成的签名串 签名生成
uidtruestring通过接口获取到的 live_open_id
request_idtruestring32位长度随机字符串,用来进行幂等。推荐算法(uuid)
typetruestring1.订单增加金币;2.订单删除金币
valuetruestring要变化的金币数量
expriationtrueint过期时间戳 例: $expiration = (time() / 86400 + 91) * 86400 ;
reasonfalsestring本次操作原因
  • 返回字段说明:
返回字段字段类型说明
statusint返回结果状态。200:正常。
msgstring返回状态信息
  • 返回示例:
// 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_idtruestringLinkV 分配的live_app_id
nonce_strtruestring随机字符串,前八位和后八位为随机字符串,中间为秒级时间戳
signtruestring生成的签名串 签名生成
uidtruestring通过接口获取到的 live_open_id
  • 返回字段说明:
返回字段字段类型说明
statusint返回结果状态。200:正常。
msgstring返回状态信息
dataobject
    tokensstring用户剩余金币
  • 返回示例:
// success
{
    "data": {
        "tokens": "123",
    },
    "msg": "",
    "status": "200"
}
// error
{
    "status": "403",
    "msg": "sign err"
}
  • 错误码说明:
错误码描述解决方案
400参数错误 /
参数长度错误
确认必传参数是否缺少 /
确认userId长度是否超过64位
403签名错误参照签名生成进行签名生成
500系统错误联系我们

非钱包方式,透传方案

  1. 方案介绍
  2. 方案步骤
  3. 注意事项
  4. 接口说明

方案介绍

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

方案步骤

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

注意事项

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

接口说明

扣款接口

  • 请求URL: [可自定义]
  • 支持格式: 表单参数
  • 请求方式: POST(application/x-www-form-urlencoded)
  • 请求参数:
参数必选类型说明
app_idtruestringLinkV 分配的live_app_id
request_idtruestring32位长度随机字符串,用来进行幂等。推荐算法(uuid)
noncetruestring随机字符串,前八位和后八位为随机字符串,中间为秒级时间戳
user_idtruestring送礼人id
goldtruestring扣金币数
expriationtrueint超时时间戳 例: $expiration = (time() / 86400 + 91) * 86400 ;
typetruestring"扣款类型1. 送礼"
reasontruestring"扣款内容json 数据体 不同扣款类型不同"
gift_idtruestring礼物id
send_numtrueint送礼数量
receiver_idtruestring收礼人id
vtypetruestring"直播间类型 1: 普通直播间 8: 多人直播间"
resource_idtruestring直播间id
signtruestring生成的签名串 签名生成 中的 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'
}
  • 返回字段说明:
返回字段字段类型说明
statusint返回结果状态。200:正常。
msgstring返回状态信息
goldint现有金币数
  • 返回示例:
// success
{
    "staus":200,
    "msg": "",
    "gold": 120
}
// error
{
    "status": 500,
    "msg": "sign err"
}
  • 错误码说明:
错误码描述解决方案
400参数错误请查看参数请求格式
500系统错误联系我们