小程序API接入说明
小程序API介绍
小程序API是为开发者提供的面向小程序应用场景的API,目前主要用于消息广播的用途,由开发者的小程序后台服务发起调用(注意:必须是一个小程序后台服务)。小程序API的通信方式为HTTPS。
HTTPS 方式
一、域名
正式环境域名:https://apiext.huya.com
二、生成签名
按照统一鉴权说明生成对应的鉴权sToken(即JWT token)
注意:其中Payload需要做以下调整:
payload参数:
| 参数名称 | 类型 | 备注 |
|---|---|---|
| iat | number | token生成时间戳(秒) |
| exp | number | 过期时间戳(秒) |
| appId | string | 小程序开发者appid |
| extUuid | string | 小程序uuid |
| creator | string | 创建者,token生成方:SYS平台,DEV开发者(可选) |
| role | string | 用户身份:U用户,P主播(可选) |
| profileId | string | 主播unionId(可选) |
| roomId | string | 主播房间号(可选) |
| userId | string | 用户unionId(可选) |
payload样例
{
"iat": 1555921691,
"exp": 1555928891,
"appId": "appId",
"extUuid": "extUuid",
"creator": "SYS",
"role": "U",
"profileId": "unImSOHlQBsY",
"roomId": "1134",
"userId": "uneNiaInYX/41",
}
三、发送请求
- 通过https方式发送请求
- 上面生成的签名通过设置http Header参数authorization进行传输
Header参数:
| 参数名称 | 类型 | 备注 |
|---|---|---|
| authorization | string | 请求的签名凭证 |