服务端 API 汇总

更新时间：2021-05-25

接口列表

帐号绑定（第三方->LinkV）

获取SDK运行中需要的用户shop_open_id 及 shop_token，进行帐号打通串联（绑定）。

时序图

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

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce	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	用户 shop_token，可以保存应用内，长度在 256 字节以内。
userId	string	用户 Id，与参数 userId 相同。
aid	string	用户 aid，与参数 aid 相同。
openId	string	LinkV电商直播生成的唯一shop_open_id 。用户开播校验

返回示例

// success
{
    "data": {
        "token": "asdsaddfa3234234ada2adsf",
        "user_id": "534961119",
        "shop_user_id": "115213496111983232934",
    },
    "msg": "",
    "status": "200"
}

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

错误码说明

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

查询直播信息（第三方->LinkV）

查询直播间相关信息（封面、title、主播名称、观看人数、分享数、评论数、点赞数）

时序图

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

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
video_id	true	string	直播 id

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
data	object
title	string	标题
video_id	string	直播id
user_id	string	主播id
video_type	string	视频类型(live.直播,record.回放)
room_state	string	房间状态
capture	string	封面
watch_num	string	看播数
share_num	string	分享数
like_num	string	点赞数
comment_num	string	评论数
hot_num	string	热力值

返回示例

// success
{
    "status": 200,
    "msg": "success",
    "data": {
        "title": "迎來到我的直播間",
        "video_id": "16155317893741151949",
        "user_id": "1198928120401502208",
        "online": "0",
        "room_state": "0",
        "capture": "http://esx.esxscloud.com/big/xxxxx/poster/43d68bece94a5dfbfc865049fb1a214c_icon.jpeg",
        "watch_num": "20",
        "share_num": "3",
        "like_num": "5",
        "comment_num": "10"
    }
}

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

错误码说明

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

商品信息更新（第三方->LinkV）

SDK中的购物袋部分展示的商品信息、详情，主播端配置商品上下架的数据更新。

时序图

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

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
product_id	true	string	商品id

返回字段

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

返回示例

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

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

错误码说明

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

开播通知（LinkV->第三方）

主播开播时接到开播通知的接口。（自定义feed流时使用）

时序图

URL：http://xxx/video_open_notify
支持格式：表单参数
HTTP请求方式：POST（application/x-www-form-urlencoded）
请求参数

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
video_id	true	string	直播id

返回字段

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

返回示例

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

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

错误码说明

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

关播通知（LinkV->第三方）

主播关播时接到关播通知的接口。（自定义feed流时使用）

时序图

URL：http://xxx/video_close_notify
支持格式：表单参数
HTTP请求方式：POST（application/x-www-form-urlencoded）
请求参数

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
video_id	true	string	直播id

返回字段

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

返回示例

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

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

错误码说明

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

商品查询（LinkV->第三方）

主播关播时接到关播通知的接口。（自定义feed流时使用）

时序图

URL：http://xxx/get_product_desc
支持格式：表单参数
HTTP请求方式：POST（application/x-www-form-urlencoded）
请求参数

参数	必选	类型	说明
app_id	true	string	LinkV 分配的app_id
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
product_id	true	string	商品id

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
data	object
product_id	string	商品id
title	string	商品名称
img	array	商品图片
currency	string	货币符号
curprice	string	售价
oldprice	string	原价
url	string	商品地址
species	array	商品规格
name	string	规格名称
tid	string	规格代号
items	object	商品列表
```	array	某一个规格的具体代号(species 字段中 tid的值)
type_name	string	某一个规格的子类型名称
type_gid	string	某一个规格的子类型对应的规格代号

返回示例

// success
{
    "status": 200,
    "msg": "success",
    "data": {
        "list": [
            {
                "product_id": "100341",
                "title": "(測試不出貨) PANTONE色票行李箱 20吋 (雙館)",
                "img": ["https://xxx.com/Files/market/100341/image/MAI_145934347_X400X400.jpg"],
                "currency": "NT$",
                "curprice": "2",
                "oldprice": "6000",
                "url": "https://xxx.com.tw/product/100341?utm_source=supertaste_app&utm_medium=index",
                "species": [{
                    "name": "颜色",
                    "tid": "xxx"
                },{
                    "name": "尺码",
                    "tid": "yyy"
                }],
                "items": {
                    "xxx": [{
                        "type_name": "薄荷綠",
                        "type_gid": "100871"
                    },{
                        "type_name": "蜜桃紅",
                        "type_gid": "100872"
                    }],
                    "yyy": [{
                        "type_name": "38",
                        "type_gid": "100873"
                    },{
                        "type_name": "39",
                        "type_gid": "100874"
                    }]
                }
            }
        ]
    }
}

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

错误码说明

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

优惠券获取（LinkV->第三方）

直播间发红包优惠券时调用的数据接口。

时序图

URL：http://xxx/get_coupon
支持格式：表单参数
HTTP请求方式：POST（application/x-www-form-urlencoded）
请求参数

参数	必选	类型	说明
app_id	true	string	LinkV 分配的shop_app_id
nonce	true	string	随机字符串，前八位和后八位为随机字符串，中间为秒级时间戳
sign	true	string	生成的签名串签名生成
action_id	true	string	领取优惠事件id (1.关注，2.进入直播间一定时间，3.主播发放)
user_id	true	string	第三方用户id
anchor_id	true	string	主播的第三方用户id

返回字段

返回字段	字段类型	说明
status	int	返回结果状态。200：正常。
msg	string	返回状态信息
data	object
desc	string	优惠券描述
title	string	优惠券名称
img	array	优惠券图片

返回示例

// success
{
    "status": 200,
    "msg": "success",
    "data": {
        "title": "我是一张优惠券",
        "desc": "我可以用来买东西",
        "img": "http://xxx/xxxx.jpg"
    }
}

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

错误码说明

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

服务端签名说明

电商直播