点播
服务端
新手接入指南
产品简介
产品介绍
功能特性
产品优势
基本概念
创建应用
开通点播服务
配置CDN分发加速
什么是 CDN 分发加速
添加加速域名
配置CNAME
配置CDN缓存
防盗链
配置HTTPS安全加速
配置刷新预热
内容安全审核
功能概述
使用说明
最佳实践
CDN 加速对象存储资源
服务端 API
接口概述
媒资上传
视频处理
视频编辑
媒资管理
回调管理
视频安全
视频加密
安全通
移动端终端用户管理
数据统计
常见问题

接口概述

更新时间: 2021/11/29 11:14:02

接口概述

请求说明

服务地址

网易云信点播服务使用的域名访问地址为: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代码举例如下:

import 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时,包含的错误信息

**重要提示:获取上传加速节点、文件数据上传、断点续传查询断点三个接口除外。

接口频率说明

目前每个接口频率限制为80次/秒。

接口调用流程示意

此文档是否对你有帮助?
有帮助
我要吐槽
  • 接口概述
  • 请求说明
  • 服务地址
  • 通信协议
  • 请求方法
  • 字符编码
  • 公共参数
  • 接口鉴权
  • 返回说明
  • 接口频率说明
  • 接口调用流程示意