在线文档预览API接口

概述

IDocV接口包含上传、修改、预览、下载和删除文档等操作。这些接口遵循RESTful风格,一般返回JSON数据。所有接口的根路径为:http://api.idocv.com/,如果是第三方服务安装,则为第三方IP地址或域名。

TOKEN参数是与第三方应用账号相关联的,并且在大部分接口调用中均会使用到。我们为免费调用我们网站接口的用户提供统一的token:testtoken。由于访问量巨大,免费调用时单个文档大小有一定限制,上传文档会根据我们的云存储压力不定期删除,访问高峰时期偶尔会出现预览失败的情况,如要更安全、稳定、可靠地预览文档,建议将我们的在线文档预览服务安装到您自己的服务器,详询客服。


上传文档

POST http://api.idocv.com/doc/upload
上传您要在线预览的文档。

请求参数:
token - 您的应用token
mode - 访问模式,私有(private)或公开(public),默认(可配置)是公开(public)。
name - 文件名(可选参数,包含文件扩展名)。在上传网络文档(url上传)时,建议提供此参数。

以下参数之一:
file - 文件作为multi-part POST请求参数,用于上传本地文档
url - 文档URL,用于预览网络文档。此URL应为编码(UTF-8 URL-encoded)后的URL。

示例请求: curl -F "token=<TOKEN>" -F "mode=public" -F "file=@test.doc" http://api.idocv.com/doc/upload

返回参数:
code - 返回代码,1成功,其他失败
desc - 描述信息
uuid - 文档唯一标识

您应该将文档的uuid保存到数据库中,因为在接下来的预览、下载和删除等操作中会用到。

示例返回: { "code":"1", "desc":"success", "uuid": "abcdef" }


设置访问模式

POST http://api.idocv.com/doc/mode/<UUID>/<MODE>
设置文档访问模式,私有(private)或公开(public)
public - 公开文档可以分享给任何人,并可以在任何时间任何地点查看。参见预览了解如何预览文档。
private - 私有文档必须通过会话ID来预览,会话ID会在一定时间后失效(默认一个小时,可配置),私密文档可以设置为这种模式。参见会话了解如何获取一个会话ID。

请求参数:
token - 您的应用token
mode - 访问模式,私有(private)或公开(public)。

示例请求: curl -d "token=<TOKEN>" http://api.idocv.com/doc/mode/<UUID>/public

返回参数:
code - 返回代码,1成功,其他失败
desc - 描述信息

示例返回: { "code":"1", "desc":"success" }


获取会话(只适用私有文档)

POST http://api.idocv.com/session/<UUID>
获取一个私有文档的会话ID(公开文档可以通过uuid直接访问,不需要会话ID)。

请求参数:
token - 您的应用token
uuid - 文档唯一标识

示例请求: curl -d "token=<TOKEN>" http://api.idocv.com/session/<UUID>

返回参数:
code - 返回代码,1成功,其他失败
desc - 描述信息
session - 会话ID,参见预览了解如何使用会话ID。

示例返回: { "code":"1", "desc":"success", "session": "513d50352a8824ff316ee28c" }


预览文档

公开文档预览:GET http://api.idocv.com/view/<UUID>
私有文档预览:GET http://api.idocv.com/view/<SESSION>

对于网络文档,可通过以下方式直接预览(不需要调用上传接口):

http://api.idocv.com/view/url?url=<UTF-8 Encoded URL>&name=<可选文件名>

如果原始文档在预览服务器上,我们提供更加高效简化的预览接口,详询客服。

请求参数:
以下参数之一:
uuid - 文档唯一标识,用于公开文档预览
session - 会话ID,用于私有文档预览,参见会话了解如何获取一个会话

示例请求(web浏览器直接访问): http://api.idocv.com/view/<UUID>

返回:
正常返回文档预览页面,错误时提示错误信息。


下载文档

GET http://api.idocv.com/doc/download/<UUID>
下载原始文档。
该接口触发保存文件对话框,如需直接输出文件流,可在末尾添加参数type=stream

请求参数:
uuid - 文档唯一标识

示例请求(web浏览器直接访问): http://api.idocv.com/doc/download/<UUID>

返回:
直接返回文件。


删除文档

GET http://api.idocv.com/doc/delete/<UUID>
永久删除文档。

请求参数:
token - 您的应用token
uuid - 文档唯一标识

示例请求: curl --data "token=<TOKEN>" http://api.idocv.com/doc/delete/<UUID>

返回:
成功则返回布尔值true.

示例返回: { "code":"1", "desc":"success" }


其他接口

以上接口不一定能满足所有的业务场景,对于特殊需求,请联系我们的客服,为您提供定制化接口和解决方案!


收缩

QQ在线客服

  • 点击这里给我发消息

QQ在线客服

  • 010-80761668
  • 400-000-7644