帮助中心

点播API调用说明

一、简介

本文档为了指导开发者更快使用微吼点播API,可实现对视频进行上传、存储、转码、播放等功能。主要提供如下接口:

二、向微吼申请开通权限

请点击 点播API权限申请 立即沟通申请,申请后客户经理会在线上与您直接联系,审核通过后会开通相关权限,开通后即可开始使用点播API开发应用。

三、申请开通后获取的授权信息

1.平台API的相关参数

useId:用于服务器与您的服务器进行通讯的时候的身份验证

readtoken:读令牌,用来从服务器上读取数据

writetoken:写令牌,用来向服务器上写入数据

secretkey:调用API接口做签名访问时要用到(默认不开通,如果有需要请联系客户经理)

调用平台API接口的时候,有时候会需要用到这四个参数中的一个或多个值。

四、回调通知

每次视频上传、编码、审核时,系统会通过get方法请求用户的接口,将参数回调通知给用户。

“回调URL”,请调用接口( editCallbackUrl)设置用户的接口URL(例如:http://demo.polyv.net/callback)。

1、上传完成/上传不合规格视频回调

上传完成后,系统会调用回调URL,会带来三个参数sign、type和vid

sign:系统签名,sign是由系统用”upload”这个字符串和vid、secretkey这两个参数的值按顺序组成的字符串做MD5计算得到(如,vid的值为e2e84a738302f20a4f6eb202976f5c63_e,secretkey的值为7UagtQOq2A,将字符串uploade2e84a738302f20a4f6eb202976f5c63_e7UagtQOq2A进行MD5计算,得到b245e3e65aa45b60dc02337b5cd914a7)

type:回调类型

upload:已上传

invalidVideo:不合规格视频(当上传的视频的信息无法被系统分析时,判断为不合规格视频)

vid:视频id

请求实例

http://demo.polyv.net/callback?sign=b245e3e65aa45b60dc02337b5cd914a7&type=upload&vid=e2e84a738302f20a4f6eb202976f5c63_e

2、编码完成/失败回调

同上传完成回调一样,编码完成之后,系统会调用回调URL:

sign:系统签名,sign是由系统用”encode”这个字符串和format、vid、df、secretkey这四个参数的值按顺序组成的字符串做MD5计算得到(如,format的值为flv,vid的值为e2e84a738302f20a4f6eb202976f5c63_e,df的值为1,secretkey的值为7UagtQOq2A,将字符串encodeflve2e84a738302f20a4f6eb202976f5c63_e17UagtQOq2A进行MD5计算,得到3c3eab358901ad19bc59b5df7704ed48)

type:回调类型

encode:已编码

encode_failed:处理失败

format:编码后的视频格式

vid:视频id

df:视频清淅度版本,1为流畅、2为高清、3为超清

请求实例

http://demo.polyv.net/callback?sign=3c3eab358901ad19bc59b5df7704ed48&type=encode&format=flv&vid=e2e84a738302f20a4f6eb202976f5c63_e&df=1

3、审核操作回调

那么审核完成,recieve的链接会收到一个调用,带来三个参数type、vid和df

sign:系统签名,sign是由系统用”manage”这个字符串和type、vid、secretkey这三个参数的值按顺序组成的字符串做MD5计算得到(如,type的值为pass,vid的值为e2e84a738302f20a4f6eb202976f5c63_e,secretkey的值为7UagtQOq2A,将字符串managepasse2e84a738302f20a4f6eb202976f5c63_e7UagtQOq2A进行MD5计算,得到8ebb91d444ce53fafa3256670fb65d84)

type:回调类型

pass:通过

nopass:未通过

del:删除

vid:视频id

请求实例

http://demo.polyv.net/callback?type=pass&vid=e2e84a738302f20a4f6eb202976f5c63_e&sign=8ebb91d444ce53fafa3256670fb65d84

4、以PHP为示例代码

<?php
$sign=$_GET["sign"];
$vid=$_GET["vid"];
$type=$_GET["type"];
$format=$_GET["format"];
$df=$_GET["df"];
$secretkey= "yourSecretkey"; 
 
if($type=="upload"){
    $verifySign = md5($type.$vid.$secretkey);
    if($verifySign==$sign){
        return "vid=".$vid." type=".$type;
    }
}
 
if($type=="encode"){
    $verifySign = md5($type.$format.$vid.$df.$secretkey);
    if($verifySign==$sign){
        return "vid=".$vid." type=".$type." format=".$format." df=".$df;
    }
}
 
if($type=="pass"){
    $verifySign = md5("manage".$type.$vid.$secretkey);
    if($verifySign==$sign){
        return "vid=".$vid." type=".$type;
    }
}
?>