接口概述
更新时间: 2024/08/07 09:46:40
接口频率说明
每个接口频率限制为 80 次/秒。
接口调用流程
请求说明
服务地址
网易云信点播服务使用的域名访问地址为:vcloud.163.com
。
通信协议
网易云信点播服务的所有接口均通过 HTTPS 进行通信,提供高安全性的通信通道。
获取上传加速节点和断点续传查询断点接口除外,只支持 HTTP 通信。
请求方法
所有接口都只支持 POST 请求。
获取上传加速节点和断点续传查询断点接口除外,为 GET 请求。
字符编码
所有接口均使用 UTF-8 编码。
公共参数
所有接口均需要放置以下公共参数在请求头中,用于标识用户和接口鉴权。后续的接口说明不再对这些参数进行说明,但每次发起请求均需要携带。
参数 | 类型 | 必需 | 说明 |
---|---|---|---|
AppKey | String | 是 | 开发者平台分配的 AppKey |
Nonce | String | 是 | 随机数(随机数,最大长度 128 个字符) |
CurTime | String | 是 | 当前 UTC 时间戳,从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到现在的秒数 |
CheckSum | String | 是 | 服务端认证校验凭证,SHA1(AppSecret+Nonce+CurTime),16 进制字符小写 |
获取上传加速节点、文件数据上传、断点续传查询断点三个接口,不使用上述公共参数。
接口鉴权
接口通过请求头中的公共参数进行鉴权。登录 网易云信控制台,单击应用名称 > 右侧[App Key 管理],即可查看 AppKey 和 AppSecret,通过该安全凭证进行 SHA1(AppSecret+Nonce+CurTime) 计算。
本文中提供的所有接口均面向开发者服务器端调用,用于计算 CheckSum 的 AppSecret 开发者应妥善保管,可在应用的服务器端存储和使用,但不应存储或传递到客户端,也不应在网页等前端代码中嵌入。
计算 CheckSum 的 Java 代码举例如下:
Javaimport java.security.MessageDigest;
public class CheckSumBuilder {
public static String getCheckSum(String appSecret, String nonce, String curTime) {
return encode("sha1", appSecret + nonce + curTime);
}
private static String encode(String algorithm, String value) {
if (value == null) {
return null;
}
try {
MessageDigest messageDigest = MessageDigest.getInstance(algorithm);
messageDigest.update(value.getBytes());
return getFormattedText(messageDigest.digest());
} catch (Exception e) {
throw new RuntimeException(e);
}
}
private static String getFormattedText(byte[] bytes) {
int len = bytes.length;
StringBuilder buf = new StringBuilder(len * 2);
for (int j = 0; j < len; j++) {
buf.append(HEX_DIGITS[(bytes[j] >> 4) & 0x0f]);
buf.append(HEX_DIGITS[bytes[j] & 0x0f]);
}
return buf.toString();
}
private static final char[] HEX_DIGITS = { '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', 'a', 'b', 'c', 'd', 'e', 'f' };
}
返回说明
所有接口返回类型为 JSON。返回字段如下:
名称 | 类型 | 说明 |
---|---|---|
code | Int | 返回结果的状态码 |
ret | String | 返回的结果集 |
msg | String | 当返回结果的状态码不为 200 时,包含的错误信息 |
获取上传加速节点、文件数据上传、断点续传查询断点三个接口除外。
此文档是否对你有帮助?