接口介绍
本文阅读对象:系统集成傲析视频解析接口API涉及的技术架构师,研发工程师,测试工程师,系统运维工程师。
协议规则
传输方式:HTTP或HTTPS
字符编码:UTF-8
请求方式:接口支持GET和POST请求方式,推荐使用POST方式。如果使用GET请求方式,拼接视频链接的时候,先对视频链接进行UrlEncode编码,然后再拼接到接口地址里。
方式对比:直链方式一个链接内附加视频链接就可以进行解析,简单易用,但安全性稍差;API调用方式有觉完善的签名和验证机制,安全性较高,但需要一定的开发能力。
[方式1:直链]
接口链接附加 clientSecretKey 和 link 即可完成认证和解析,输出解析结果。
参数说明:
字段名称 | 字段类型 | 必填 | 说明 |
---|---|---|---|
clientSecretKey | string(32) | Y | 客户端密钥 |
link | string(255) | Y | 视频分享链接 |
注意:clientSecretKey可以在管理后台查看,请妥善保管;
注意:拼接链接:http://vipapi.ax166.com/api/api.php?clientSecretKey=XXX&link=XXX
直链解析PHP演示代码:
$clientSecretKey = "4e426e4d1de2475763057c8383fb62a2"; //分配的客户密钥,用户后台https://api.ax166.com/openapi.html 查看
$link = "http://v.XXXX.com/hq8aoA/";
$url = "http://vipapi.ax166.com/api/api.php?clientSecretKey=".clientSecretKey."&link=".$link;
$result = file_get_contents($url,false);
$data_arr = json_decode(trim($data), true);
print_r($data_arr);
注意:retCode成功时为200,失败时一般为401;retDesc成功时为ok,失败时为失败原因(中文);
注意:测试的话直接浏览器粘贴链接,替换自己的clientSecretKey和要测试的视频分享链接link访问即可;
[方式2:API]签名算法
接口调用需加上接口签名(sign)字段,服务器用该字段值鉴定接口确实由授权客户端发起。
签名计算方式:sign = md5(link + timestamp + clientSecretKey)
参数说明:
字段名称 | 字段类型 | 必填 | 说明 |
---|---|---|---|
link | string(255) | Y | 视频分享链接 |
timestamp | string(13) | Y | 当前时间戳,包括毫秒 |
clientSecretKey | string(32) | Y | 客户端密钥 |
注意:clientSecretKey可以在管理后台查看,请妥善保管;
签名算法PHP演示代码:
//必要的参数
$link = "http://v.XXXX.com/hq8aoA/"; //视频分享地址
$timestamp = time() * 1000; //时间戳
$clientSecretKey = "4e426e4d1de2475763057c8383fb62a2"; //分配的客户密钥,用户后台https://api.ax166.com/openapi.html 查看
$sign = md5($link . $timestamp . $clientSecretKey); //签名
echo($sign);
[方式2:API]解析接口
接口地址:http://vipapi.ax166.com/api/api.php
接口方式:POST、GET
接口形式:JSON、Array、String
请求参数说明:
字段名称 | 字段类型 | 必填 | 说明 |
---|---|---|---|
link | string(255) | Y | 视频分享链接 |
clientId | string(16) | Y | 客户ID |
timestamp | string(13) | Y | 当前时间戳 |
sign | string(32) | Y | 接口签名值 详见签名算法 |
接口示例:
{
"link": "http://v.xxxx.com/hq8aox/",
"clientId": "114164da47b8f2fd",
"timestamp": 1561799269000,
"sign": "024190bc0b1911a070ca8b5a82292cf0"
}
注意:clientId可以在管理后台查看,sign按签名方法进行签名(sign = md5(link + timestamp + clientSecretKey));
请求返回:
接口输出:
字段名称 | 字段类型 | 必填 | 说明 |
---|---|---|---|
retCode | int(11) | Y | 输出结果码 |
retDesc | string(255) | N | 输出结果消息 |
data | 对象 | Y | 处理结果数据 |
data.link | string(255) | Y | 视频分享地址 |
data.title | string(255) | N | 视频标题 |
data.cover | string(255) | N | 视频封面URL |
data.video | string(255) | Y(成功时) | 视频文件URL |
data.count | int(11) | Y | 剩余次数 |
解析接口PHP演示代码:
//配置信息开始
$AX166_API_URL = "http://vipapi.ax166.com/api/api.php"; //傲析解析接口地址
$clientId = "58d4259475f52a55"; //分配的客户ID,用户后台https://api.ax166.com/openapi.html 查看
$clientSecretKey = "4e426e4d1de2475763057c8383fb62a2"; //分配的客户密钥,用户后台https://api.ax166.com/openapi.html 查看
//配置信息结束
//必要的参数
$link = "http://v.XXXX.com/hq8aoA/"; //视频分享地址
$timestamp = time() * 1000; //时间戳
$sign = md5($link . $timestamp . $clientSecretKey); //签名
function file_get_contents_post($url, $post) {
$options = array(
"http"=> array(
"method"=>"POST",
"header" => "Content-type: application/x-www-form-urlencoded",
"content"=> http_build_query($post)
),
);
$result = file_get_contents($url,false, stream_context_create($options));
return $result;
}
$data = file_get_contents_post($AX166_API_URL, array("link" => $link, "timestamp" => $timestamp, "sign" => $sign, "clientId" => $clientId));
$data_arr = json_decode(trim($data), true);
print_r($data_arr);
注意:retCode成功时为200,失败时一般为401;retDesc成功时为ok,失败时为失败原因(中文);
接口示范脚本SDK下载
接口SDK下载(含PHP和JAVA):下载