有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

简介

本文档提供关于数据万象海报合成的 API 概览以及 SDK 示例代码。
注意:
COS Javascript SDK 版本需要大于等于 v1.3.1。
API
操作描述
上传一个海报合成模板
创建一个海报合成任务
查询指定的海报合成任务结果

提交海报合成模板

功能说明

上传海报合成模板功能可 解析保存 PSD 文件模板,异步返回合成后的模板信息。
注意:
使用此接口前,请确保海报模板符合 相关制作规则

示例代码

var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000' /* 存储桶,必须 */,
Region: 'COS_REGION' /* 存储桶所在地域,必须字段 */,
};
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/posterproduction/template';
var url = 'https://' + host;
var body = COS.util.json2xml({
Request: {
Input:{
Object:'***.psd' //COS 桶中 PSD 文件,大小限制100M
}
Name:'***', //模板名称
//CategoryIds: '', // 模板分类 ID,支持传入多个,以 , 符号分割字符串
},
});
cos.request(
{
Method: 'POST',
Key: 'posterproduction/template',
Url: url,
Body: body,
ContentType: 'application/xml',
},
function (err, data) {
console.log(err || data);
}
);


提交海报合成任务

功能说明

海报合成功能可以将您的素材、文案和 Logo 等信息快速生成海报,以提交任务的方式进行海报合成,异步返回合成后的文件。

示例代码

var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000' /* 存储桶,必须 */,
Region: 'COS_REGION' /* 存储桶所在地域,必须字段 */,
};
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/pic_jobs';
var url = 'https://' + host;
var body = COS.util.json2xml({
Request: {
Tag: 'PosterProduction', // 必须
Input:{
Object:'***.jpg' //待操作的媒体文件名
}
Operation: {
PosterProduction: {
TemplateId: 't10461fe2bd5a649db9022452ec71exxxx', // 海报合成任务模板 ID
Info: {
main: 'https://test-12*******.cos.ap-chongqing.myqcloud.com/***.jpg',
text_te: '***',
}, //模板可替换信息
},
Output: {
Bucket: config.Bucket, // 保存合成后文件的存储桶
Region: config.Region, // 保存合成后文件的存储桶地域
Object: 'output/out.jpg', // 合成后文件的文件名
},
UserData: '',
},
// CallBack: 'http://callback.demo.com', // 任务回调的地址
// CallBackFormat: 'JSON', // 任务回调格式
// CallBackType: 'Url', // 任务回调类型,Url 或 TDMQ,默认 Url
},
});
cos.request(
{
Method: 'POST',
Key: 'pic_jobs',
Url: url,
Body: body,
ContentType: 'application/xml',
},
function (err, data) {
console.log(err || data);
}
);

API 文档请参见 提交海报合成任务

查询海报合成任务结果

功能说明

查询一个文件处理任务,根据任务 ID 查询任务详情。

示例代码

var config = {
// 需要替换成您自己的存储桶信息
Bucket: 'examplebucket-1250000000' /* 存储桶,必须 */,
Region: 'COS_REGION' /* 存储桶所在地域,必须字段 */,
};
var jobId = 'xxxxxx'; // 提交海报合成任务后会返回当前任务的 jobId
var host = config.Bucket + '.ci.' + config.Region + '.myqcloud.com/pic_jobs/' + jobId;
var url = 'https://' + host;
cos.request(
{
Method: 'GET',
Key: 'pic_jobs/' + jobId,
Url: url,
},
function (err, data) {
console.log(err || data);
}
);
API 文档请参见 查询海报合成任务