介绍
本示例实现了一个请求直播间广播小程序API的简单demo。
代码示例(JAVA)
具体的可在代码仓库中查看详细代码。
package hyext.ebs.examples.apiext;
import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import org.apache.http.HttpEntity;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.config.RequestConfig;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
import com.alibaba.fastjson.JSONObject;
import com.auth0.jwt.JWT;
import com.auth0.jwt.algorithms.Algorithm;
/**
* 小程序api调用样例 （调用直播间广播接口）
*/
public class ApiextClient {
/**
* 生效请求jwt凭证
* @param appId 开发者ID
* @param secret 开发者密钥
* @param extUuid 小程序uuid
* @param profileId 主播unionId（通过hyext.request接口请求到后台的Header里获取，详情可以看：http://dev.huya.com/docs#/sdk/hyExt.request）
* @return
*/
public static String getApiextJwtString(String appId, String secret, String extUuid, String profileId){
//获取时间戳（毫秒）
long currentTimeMillis = System.currentTimeMillis();
long expireTimeMillis = System.currentTimeMillis() + 10 * 60 * 1000; //超时时间:通常设置10分钟有效，即exp=iat+600，注意不少于当前时间且不超过当前时间60分钟
Date iat = new Date(currentTimeMillis);
Date exp = new Date(expireTimeMillis);
try {
Map<String, Object> header = new HashMap<String, Object>();
header.put("alg", "HS256");
header.put("typ", "JWT");
//生成JWT凭证
Algorithm algorithm = Algorithm.HMAC256(secret); //开发者密钥
String sToken = JWT.create()
.withHeader(header) //JWT声明
.withIssuedAt(iat) //jwt凭证生成时间
.withExpiresAt(exp) //jwt凭证超时时间
.withClaim("appId", appId) //开发者ID
.withClaim("extUuid", extUuid) //小程序ID
.withClaim("creator", "DEV") //创建者（token生成方：SYS平台，DEV开发者）
.withClaim("profileId", profileId) //主播unionId
.sign(algorithm);
return sToken;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
/**
* POST请求
* @param url
* @param headerMap
* @param paramMap
* @return
*/
public static String sendPost(String url, Map<String, Object> headerMap, Map<String, Object> paramMap) {
CloseableHttpClient httpClient = null;
CloseableHttpResponse httpResponse = null;
String result = "";
httpClient = HttpClients.createDefault();
HttpPost httpPost = new HttpPost(url);
// 配置请求参数实例
RequestConfig requestConfig = RequestConfig.custom().setConnectTimeout(3000)
.setConnectionRequestTimeout(3000)
.setSocketTimeout(3000)
.build();
httpPost.setConfig(requestConfig);
// 设置请求头
httpPost.addHeader("Content-Type", "application/json");
// 封装header参数
if (null != headerMap && headerMap.size() > 0) {
Set<Entry<String, Object>> entrySet = headerMap.entrySet();
Iterator<Entry<String, Object>> iterator = entrySet.iterator();
while (iterator.hasNext()) {
Entry<String, Object> mapEntry = iterator.next();
httpPost.addHeader(mapEntry.getKey(), mapEntry.getValue().toString());
}
}
// 封装post请求参数
if (null != paramMap && paramMap.size() > 0) {
String bodyJson = JSONObject.toJSONString(paramMap);
// 为httpPost设置封装好的请求参数，使用json字符串方式传参
httpPost.setEntity(new StringEntity(bodyJson, "UTF-8"));
}
try {
// httpClient对象执行post请求,并返回响应参数对象
httpResponse = httpClient.execute(httpPost);
// 从响应对象中获取响应内容
HttpEntity entity = httpResponse.getEntity();
result = EntityUtils.toString(entity);
} catch (ClientProtocolException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 关闭资源
if (null != httpResponse) {
try {
httpResponse.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != httpClient) {
try {
httpClient.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return result;
}
public static void main(String[] args) {
String appId = ""; //小程序开发者ID（成为开发者后，https://ext.huya.com可查）
String extUuid = ""; //小程序ID（创建小程序后，https://ext.huya.com可查）
String secret = ""; //小程序开发者密钥（成为开发者后，https://ext.huya.com可查）
String profileId = ""; //主播unionId（通过hyext.request接口请求到后台的Header里获取，详情可以看：https://dev.huya.com/docs#/miniapp/dev/sdk/hyExt.request）
//设置header参数
Map<String, Object> headerMap = new HashMap<String, Object>();
headerMap.put("authorization", ApiextClient.getApiextJwtString(appId, secret, extUuid, profileId));
//设置body参数
Map<String, Object> paramMap = new HashMap<String, Object>();
paramMap.put("profileId", profileId);
paramMap.put("event", "test_message");
paramMap.put("message", "{\"message\":\"测试消息\"}");
String url = "https://apiext.huya.com/message/deliverRoomByProfileId?appId="+appId+"&extUuid=" + extUuid;
String resString = ApiextClient.sendPost(url, headerMap, paramMap);
System.out.println("请求地址：" + url);
System.out.println("请求响应：" + resString);
}
}
代码示例(python)
具体的可在代码仓库中查看详细代码。
import urllib3
import json
import logging
from urllib.parse import urlencode
def send_post(url, post_data):
# 创建PoolManager对象生成请求, 由该实例对象处理与线程池的连接以及线程安全的所有细节
http = urllib3.PoolManager()
# 填入从接口返回的jwt
jwt = "test_jwt"
headers = {
"Content-Type": "application/json",
"authorization": jwt,
}
# json.dumps方法可以将python对象转换为json对象
post_data = json.dumps(post_data).encode()
try:
# response 包含status,data,header
response = http.request(method="POST", url=url, body=post_data, headers=headers,
timeout=urllib3.Timeout(connect=1.0, read=1.0))
print(response.status, response.data.decode('utf-8'))
return response.data.decode('utf-8')
except Exception as e:
logging.exception(e)
# 开发者ID（https://ext.huya.com成为开发者后自动生成）
appId = "testAppId"
# 小程序ID（https://ext.huya.com成为创建小程序后自动生成）
extUuid = "testExtUuid"
post_data = {
"profileId": "主播unionId",
"event": "test_event",
"message": "test_message",
}
query_param = {
"appId": appId,
"extUuid": extUuid,
}
url = "https://apiext.huya.com/message/deliverRoomByProfileId?"
url += urlencode(query_param)
send_post(url, post_data)
FAQ
Q：请求响应返回ip not authorize？
A：表示发送请求的服务器IP没有授权，接口权限需要在开发者中心提交请求IP白名单（增强套餐）申请，具体请参考权限管理说明。
Q：请求响应返回token fail？
A：表示发送请求时没有设置header中的凭证参数（authorization）具体的设置方式可以参考demo代码或小程序API接入说明。