本文介绍微演示PPT文档在线转换接口的使用方法和流程,用于批量自动化转换时的系统对接。个人使用者可以到微演示网站手工上传转换。
本地文件上传
上传本地文件并等待转换开始。
接口
POST https://api.whytouch.com/api/uploadfile.php?token={token}&参数列表
curl使用例子:
curl -F doc=@"fox.pptx" "http://api.whytouch.com/api/uploadfile.php?token=123456&mode=-8&fn=新文件名.pptx&charset=GBK"
参数说明
字段 | 说明 |
---|---|
token | 您的用户唯一标识,从后台获取 |
doc | 上传的本地文件地址 |
mode | 转换模式。 0为普通演示模式。当mode为-8时,会生成缩略图和文档描述文件。 |
fn | 非必须。 生成目标使用的文件名。文件名会在html的title部分显示。注意使用fn参数时,必须添加与源文件相同的后缀名。系统首先根据fn的后缀名判定文件类型。 |
charset | 非必须 fn的文字编码。在windows系统下使用curl命令行直接上传文件,且fn为中文的场合,请设置charset=GBK。系统默认是utf8时不需要此参数。 |
返回值
成功时返回形如 “ok:{uuid}” 的字符串,该uuid在后续下载查询等场合使用。例如:
ok:de0ec0eeb2dd0f4412a57411edaafb9a
失败时返回失败理由。
在线文件上传
当文件已存在于您的OSS空间,且我们的转换服务器可以访问时,可以直接将文件地址提交到服务器并等待转换开始。
接口
POST https://api.whytouch.com/api/uploadurl.php?token={token}&参数列表
curl使用例子:
curl -d "url=http://www.test.com/2014/2014.pptx" "https://api.whytouch.com/api/uploadurl.php?token=123456&mode=-8&fn=新文件名.pptx&charset=GBK"
参数说明
字段 | 说明 |
---|---|
token | 您的用户唯一标识,从后台获取 |
**url ** | 提交的在线文件网址 |
mode | 转换模式。 0为普通演示模式。当mode为-8时,会生成缩略图和文档描述文件。 |
fn | 非必须。 生成目标使用的文件名。文件名会在html的title部分显示。注意使用fn参数时,必须添加与源文件相同的后缀名。系统首先根据fn的后缀名判定文件类型。 |
charset | 非必须 fn的文字编码。在windows系统下使用curl命令行直接上传文件,且fn为中文的场合,请设置charset=GBK。系统默认是utf8时不需要此参数。 |
返回值
成功时返回形如 “ok:{uuid}” 的字符串,该uuid在后续下载查询等场合使用。例如:
ok:de0ec0eeb2dd0f4412a57411edaafb9a
失败时返回失败理由。
转换结果下载
调用接口下载转换结果zip包。文件下载解压到本地后执行 ppt{uuid}\index.html 可看到完整效果。
接口
https://api.whytouch.com/api/export.php?token={token}&id={uuid}
curl使用例子:
curl "https://api.whytouch.com/api/export.php?token=123456&id=de0ec0eeb2dd0f4412a57411edaafb9a"
参数说明
字段 | 说明 |
---|---|
token | 您的用户唯一标识,从后台获取 |
id | 待下载文件的uuid |
返回值
执行成功时,下载内容为对应项目的zip包。执行失败时返回失败原因。通常可以通过判断下载内容的大小来判断是否发生了错误。正常压缩包大小超过1k,而错误字符长不超过64个字节。
转换回调接口
由于转换需要一定时间,而这个时间难以预估。通常我们建议调用者提供一个回调地址。转换完毕时服务器会发送回调通知。然后调用者执行下载操作。
回调地址可在用户登陆系统后设定。
接口
https://回调接口[?|&]uuid={uuid}&suc={0|1}&device={服务器代码}
参数说明
字段 | 说明 |
---|---|
uuid | 对应文件的uuid |
suc | 0代表成功,非0代表失败 |
转换状态查询
除了回调接口,我们也提供查询接口来查询转换状态。
接口
https://api.whytouch.com/api/querytask.php?token={token}&id={uuid}
curl使用例子:
curl "https://api.whytouch.com/api/querytask.php?token=123456&id=de0ec0eeb2dd0f4412a57411edaafb9a"
参数说明
字段 | 说明 |
---|---|
token | 您的用户唯一标识,从后台获取 |
id | 待查询文件的uuid |
返回值
返回值为数值。具体含义如下:
0, 正在排队等待
10, 正在转换
20, 转换完成,已提交回调
30, 转换成功
31, 转换失败
40或以上,其他原因处理失败。具体原因请咨询客服
接口使用具体规则请查看网站说明,有问题联系微信:wx_weiyanshi 或 QQ: 2543775048