全部产品

阿里云Vlog开放API

1、服务介

1.1 产品简介

阿里云Vlog:以游客为中心,提供含智能采集,智能生产,智能分发的一站式解决方案,可实现在在采集点拍摄后,自动生成“人+景”的Vlog短视频。

1.2 产品组成

Vlog产品组成

阿里云Vlog包含三大核心基础设施:

1)智能采集,拍摄游客最美瞬间,解锁旅程中的“高光”时刻,提升分享意愿。

2)智能生产,汇集片段优选、自动生产、视觉特效等AI能力的一体机,实现秒级生成。

3)智能分发,通过“取Vlog机”一键下载短视频,抓住用户分享的黄金瞬间。

1.3 服务说明

本服务仅适用于已部署上述阿里云Vlog基础设施的场景,开发者可以基于此API自定义面向C端用户的小程序、APP等,完成业务闭环。

2、接口说明

2.1 服务开通及秘钥获取

本服务需完成以下前置准备:

1)准备一个认证完成的阿里云账号,如果没有阿里云账号,可访问链接进行注册。

2)登陆数字商业引擎平台,按照流程填写信息并申请入驻,审批通过后进行下一步操作。

3)创建景区实例,作为景区之间的隔离维度,比如一个景区创建一个实例,一个数字商业引擎可管理多个实例。

第一步:填写景区信息。创建项目

第二步:添加“阿里云Vlog”服务。添加能力

4)能力开通后即可按照步骤激活部署阿里云Vlog基础设施。

激活流程

5)基础设施激活后,可通过实例总览页右方的秘钥调用本服务。

秘钥

2.2 接入方式

SDK依赖

本例提供java sdk pom依赖示例,更多语言SDK详情请参考API调用对接指引

<dependency>
<groupId>com.aliyun.api.gateway</groupId>
<artifactId>sdk-core-java</artifactId>
<version>1.1.0</version>
</dependency>

示例代码

HttpClientBuilderParams builderParams =newHttpClientBuilderParams();
builderParams.setAppKey("${appKey}");// 请填写正确的AppKey
builderParams.setAppSecret("${appSecret}");// 请填写正确的AppSecret
ApacheHttpClient apacheHttpClient =newApacheHttpClient(builderParams);
IoTApiRequest request =newIoTApiRequest();
//设置api的版本
request.setApiVer("1.0.0");
//如果需要登录,设置当前的会话的token
//设置参数
request.putParam("model","xxxxxx");
request.putParam("projectId","yyyyy");

Map<String,Object> param =newHashMap<>(8);
param.put("startTime","2019-01-01");
param.put("endTime","2019-01-31");
param.put("limit",10);

request.putParam("paramJson",JSONObject.toJSONString(param));
//请求参数域名、path、request
String host ="api.link.aliyun.com";
String path ="/tourism/statistics/query";
System.out.println(JSON.toJSONString(request));
ApiRequest apiRequest =newApiRequest(HttpScheme.HTTP, host,
HttpMethod.POST_BODY, path, JSON.toJSONBytes(request));
apiRequest.setHttpConnectionMode(HttpConnectionModel.MULTIPLE_CONNECTION);
ApiResponse response = apacheHttpClient.sendSyncRequest(apiRequest);
System.out.println(request.getId());
System.out.println(
"response code = "+ response.getCode()+" response message = "+ response.getMessage()
+" response content = "+newString(response.getBody(),
"utf-8"));

2.3 接口调用流程说明

本服务共包含5个接口,请按照以下流程进行业务流程编写和调用,5个接口需全部对接完成才可以完成业务最小闭环。

实际调用前,请务必保证现场已经有Vlog基础设施布置。

接口调用流程

2.4 接口说明

1)注册用户

path:/vlog/open/user/register

入参

参数名称

类型

是否必填

参数说明

nickName

String(20)

昵称

userId

String(64)

用户id

phone

String(11)

手机号

outUserId

String(64)

外部应用id,例如微信用户id,支付宝用户id

userType

String

ALIPAY-支付宝小程序,WECHAT-微信小程序,OTHER-其他

gender

integer

0-男,1-女

出参

字段名

类型

备注

code

String

异常码

message

String

异常原因

localizedMsg

String

2) 查询景区列表

path:/vlog/open/case/list

入参:

参数名称

类型

是否必填

参数说明

pageNo

Integer

页号

pageSize

Integer

页大小

出参

字段名

类型

备注

code

String

异常码

message

String

异常原因

localizedMsg

String

data

JSON

-total

Long

-pageNo

Integer

-pageSize

Integer

-items

List

--caseId

String

景区id

--name

String

景区名称

--address

String

景区地址

--description

String

景区描述信息

--coverImgUrl

String

景区封面图

--showVideoUrl

String

景区展示宣传视频

3)生成vlog

path:/vlog/open/create

入参

参数名称

类型

是否必填

参数说明

caseId

String

userId

String

用户id

faceImgData

String

人脸base64编码

出参

字段名

类型

备注

code

String

异常码

message

String

异常原因

localizedMsg

String

data

String

任务id

4)查询vlog生成情况

path:/vlog/open/status/query

入参

参数名称

类型

是否必填

参数说明

jobId

String

任务id

userId

String

用户id

出参

字段名

类型

备注

code

String

异常码

message

String

异常原因

localizedMsg

String

data

List

-productId

String

作品id

-status

String

composing合成中

done完成

failed失败

-videoUrl

String

vlog视频地址

-templateId

String

作品使用的模板id

-thumbImageUrl

String

封面图地址

-duration

Long

vlog时长,单位毫秒

5)埋点服务

path:/vlog/open/data/backflow

入参

参数名称

类型

是否必填

参数说明

userId

string

终端用户id

action

string

APP_ACCESS:用户访问应用的时候使用,

VLOG_VIEW:用户打开vlog视频时使用,

VLOG_DOWNLOAD:用户下载vlog使用,

VLOG_PAY:为vlog付费时使用,

VLOG_SHARE:vlog被分享时使用

time

Long

用户操作时间(毫秒级时间戳)

出参

字段名

类型

备注

code

String

异常码

message

String

异常原因

localizedMsg

String