积分开发指引

描述

1、与用户的积分系统对接，实现积分打赏、积分红包功能。
2、参照本文档提供的积分查询接口和积分更新接口，配置在POLYV后台的设置，使用系统生成的观看链接，配合外部授权、自定义授权或者白名单观看条件使用（目前在无限制观看条件和只有验证码观看条件时不能使用），观众在看直播时可消耗积分并打赏给主播。

积分查询接口

接口描述

1、保利威服务器通过传递观众的id和频道号等参数，对用户的积分查询接口URL 进行请求，获取学员在平台的积分

请求方式

GET

接口约束

1、如果您设置的积分查询接口URL 包含参数，直播系统调用接口时会将这些参数同时带上，并且这些参数会参与sign 的拼接加密生成

请求参数描述

注：通过Query方式传参

响应参数描述

响应示例

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":100.00
}

异常示例

请求失败：

{
    "code":403,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}

异常示例

积分不足：

{
    "code":400,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}

服务器示例请求

http://abc.com?viewerName=保利威-式廓告&viewerId=sadboy-7t8tuo&appId=frlr1zazn3&sign=18C0CB41C5D42DF2B782F2578350B1FC&sessionId=gd1mz4kqqi&channelId=2272655&ts=1665373665677

积分更新接口

接口描述

1、观众观看页选择了相应道具进行打赏时，请求积分更新接口URL修改在平台的积分
2、观众观看页领取了积分红包时，请求积分更新接口URL修改在平台的积分
3、注意：积分红包、任务奖励外部积分，积分更新请求体格式为appilcation/json

请求方式

POST

接口约束

1、如果您设置的积分更新接口URL 包含参数，直播系统调用接口时会将这些参数同时带上，并且这些参数会参与sign 的拼接加密生成

请求参数描述

注：通过Query方式传参

响应参数描述

响应示例

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":100.00
}

异常示例

积分不足（code为400）：

{
    "code":400,
    "status":"error",
    "message":"积分不足",
    "data":null
}

请求失败（code非200且非400）：

{
    "code":403,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}

服务器示例请求

http://abc.com?viewerId=sadboy-7t8tuo&goodName=皮卡丘&appId=frlr1zazn3&count=999.00&sign=6C63C4A570D63232E06E244CF0924820&sessionId=gd1mz4kqqi&goodPrice=999.00&channelId=2272655&ts=1665373695924&goodNum=1

获取频道可用积分上限接口

接口描述

1、保利威服务器通过传递appId，频道号等参数，对频道可用积分上限查询接口URL进行请求，获取频道在平台的可用积分上限

请求方式

GET

接口约束

1、如果您设置的积分查询接口URL 包含参数，直播系统调用接口时会将这些参数同时带上，并且这些参数会参与sign 的拼接加密生成

请求参数描述

注：通过Query方式传参

响应参数描述

响应示例

成功示例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":100.00
}

异常示例

请求失败：

{
    "code":403,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}

异常示例

积分不足：

{
    "code":400,
    "status":"error",
    "message":"相关错误信息",
    "data":null
}