DOC ⽂档 2019-09-12 ⽬录 Baidu 百度智能云⽂档 ⽬录 ⽬录 产品描述 2 4 产品定价 5 API参考 7 简介 核⼼概念 优势 特性 应⽤场景 按需计费 4 4 4 5 5 5 概述 使⽤须知 错误返回 公共头域 ⽂档接⼝ 7 7 8 11 12 通知接⼝ 29 JavaSDK 35 注册⽂档 根据BOS Object创建⽂档 发布⽂档 重新发布⽂档 查询⽂档 使⽤图⽚服务处理⽂档封⾯图 ⽂档列表 阅读⽂档 禁⽤阅读Token 下载⽂档 查询⽂档转码结果图⽚列表 删除⽂档 OPTIONS 通知类型及格式 创建通知 查询通知 通知列表 删除通知 13 14 16 16 17 20 20 23 24 24 26 26 27 29 30 31 32 34 DOC-Java-SDK-简介 安装DOC-Java-SDK 35 35 开发者指南 38 安装SDK包 安装DocClient 快速⼊⻔ ⽂档处理 ⽂档通知 ⽂档⽇志 v0.10.16 35 35 38 39 40 41 43 阅读器Web-SDK 43 阅读器iOS-SDK 45 简介 ⽂档阅读器Web-SDK开发指南 简介 ⽂档阅读器iOS-SDK开发指南 开发环境 ⽂档参数定义 阅读器接⼝ 加载在线⽂档 下载⽂档 版本更新记录 v2.3.1 v2.3.0 v2.2.1 v2.2.0 v2.1.0 v2.0.0 阅读器Andriod-SDK 简介 ⽂档阅读器Android-SDK开发指南 开发环境 ⽂档在线播放 加载⽂档 阅读设置 ⽂档下载 43 43 45 46 46 46 47 52 52 54 54 54 54 54 54 54 54 54 55 55 55 56 56 57 2 Baidu 百度智能云⽂档 常⻅问题 ⽀持哪些源⽂档格式？ 如何上传源⽂档？ 源⽂档的转码是实时的吗？ ⽀持对⽂档字号、背景⾊、是否允许复制等设置吗？ ⽂档转码结果是什么格式？ ⽂档在线浏览时⽀持加速吗？ ⽀持监听浏览进度并精确定位到某⼀⻚吗？ 在线浏览时的操作事件⽀持监听并插⼊业务逻辑吗？ 如何实现⽂档的在线浏览？ ⽀持离线下载、浏览⽂档吗？ ⽬录 59 59 60 60 60 60 60 60 60 60 60 3 产品描述 百度智能云⽂档服务DOC（Document Service）是百度智能云 BCE (Baidu Cloud Engine) 提供的⾯向⽂档 处理的 PaaS (Platform as a Service) 服务平台，为开发者提供Office、WPS等多种格式的⽂档存储、管理 及在线浏览服务。您⽆需了解⽂档存储、转码、分发、在线浏览等技术细节，即可快速搭建安全可靠、⾼ 可定制的⽂档处理平台和应⽤，助⼒在线教育、企业⽹盘等业务的转型升级。 ⽂档转码 DOC将源⽂档⽂件转换成适合PC、WAP、APP等多终端环境在线浏览的HTML5⽂件的计算服务称为⽂ 档转码。 ⽂档存储 DOC存储源⽂档⽂件、转码后的⽂件，以备在线浏览使⽤，称为⽂档存储。 缩略图 为满⾜⽂档预览需求，从⽂档中截取⼀⻚内容⽣成图⽚，称为缩略图。 ⽂档分发 将⽂档内容分发⾄全国所有的节点，缩短⽤户查看内容的延迟，提⾼⽤户访问⽹站的响应速度与⽹站的 可⽤性，解决⽹络带宽⼩、⽤户访问量⼤、⽹点分布不均等问题称为⽂档分发。 ⽂档状态 ⽂档在DOC整个⽣命周期中的各种状态称为⽂档状态，包含： ⽂档状态 状态名 描述 UPLOADING 上传中 ⽂档正在上传中 PROCESSING 处理中 系统正在对⽂档进⾏后台处理。⽂档上传成功⾃动进⼊此状态 PUBLISHED 已发布 FAILED 处理失 败 ⽂档已完成处理，可以正常播放。系统完成对⽂档的后台处理后进⼊此状 态 系统处理⽂档时发⽣异常 领先的⽂档处理技术 基于百度⽂库强⼤的⽂档转码、渲染技术，将源⽂档转换成HTML5，在线浏览时最⼤程度保留源⽂档样 式。 丰富的⽂档处理功能 提供⽂档元信息提取、缩略图⽣成、转码成功回调、离线浏览等丰富功能。 多端⽀持 ⽀持PC/WAP浏览器、Android、iOS主流平台，⽂档内容根据不同终端，⾃适应流式重排。 ⽆缝对接 提供上传端、播放端全套SDK，您可以根据实际业务需求将⽂档服务⽆缝对接到⾃⼰的业务系统中。 弹性计算，有效降低计算成本 采⽤低成本、低配置的云服务器来保证业务的持续性，搭配使⽤弹性伸缩服务，在业务⾼峰期⾃动增加 云服务器的数量来保正业务的正常运转。 海量⽂档存储 DOC提供海量的⽂件存储服务，服务可⽤性99.9%，数据可靠性达99.999999999%，并通过同城热备和 异地灾备⽅案，使海量⽂档永久存储，安全⽆忧。 ⾼可扩展 DOC所依赖的存储、计算和⽹络等资源均可弹性伸缩，百度智能云超⼤规模资源池满⾜复杂业务⽆缝扩 展需求。 快速流畅的⽂档浏览体验 优质的 BGP 带宽带来更低的播放延迟； 覆盖全国的上百个 CDN 节点，为⽂档分发提供加速服务，带来更快速、更流畅的⽂档浏览体验。 ⽀持多格式 源⽂档⽀持doc、docx、ppt、pptx、xls、xlsx、vsd、pot、pps、rtf、wps、et、dps、pdf、txt、epub 多种格式。 ⽀持播放器配置 ⽀持播放器宽度、字号、背景⾊等设置，⽀持分⻚及⽤户操作事件监听。 ⽀持离线下载及浏览 Android、iOS端⽀持转码后⽂档的离线下载，断⽹环境下浏览。 丰富的API和SDK 提供全套API和SDK，⽀持⽂档的上传、回调、查询、下载等功能，⽀持JAVA/C#等多种语⾔。 ⽂档服务可以内嵌于客户应⽤系统中，让您零成本实现⽂档资料的在线浏览，增强⽤户体验，适⽤于在线 教育、企业OA、企业⽹盘等各个领域。 在线教育 实现课件、随堂讲义等⽂档的在线浏览，降低学⽣使⽤⻔槛，增强体验。并可离线下载⽂档，断⽹情况 下学习。 企业OA 帮助企业实现PC、APP多端下，内部⽂档资料的在线管理和分享。 产品定价 DOC 根据⽤户的实际使⽤量采⽤按需计费，具体规则如下： 计费公式 费⽤=存储容量×单价+转码成功次数×单价+外⽹下⾏流量×单价 计费项 存储容量 按⽉累计阶梯 单价 -- 0.005元/GB/天 0~1500次 0.15元/次 1501~3000次 0.12元/次 3001~30000次 0.1元/次 30001次以上 0.08元/次 -- 0.5元/GB 转码成功次数 外⽹下⾏流量 计费项 按⽉累计阶梯 单价 存储容量 -- 0.005元/GB/天 转码成功次数 0~1500次 0.15元/次 转码成功次数 1501~3000次 0.12元/次 转码成功次数 3001~30000次 0.1元/次 转码成功次数 30001次以上 0.08元/次 外⽹下⾏流量 -- 0.5元/GB 说明： 存储容量包括原始⽂档、转码后的⽂件、封⾯图等占⽤的总容量。 转码成功次数按⾃然⽉累计，⽉初1号0点清零。转码成功次数按阶梯实时计费，举例，第1500次成 功转码价格为0.15元，第1501次成功转码价格为0.12元。 外⽹下⾏流量，指的是阅读⽂档产⽣的下⾏流量。 购买前需保证账户⽆⽋款。 DOC 按分钟计费，按⼩时扣费，即北京时间整点扣费并⽣成账单。出账单时间是当前计费周期结束后1⼩ 时内。例如，10:00-11:00的账单会在12:00之前⽣成，具体以系统出账时间为准。 余额不⾜提醒和⽋费处理 余额不⾜提醒： 根据您最近3天的账单⾦额来判断您的账户余额（含可⽤代⾦券）是否⾜够⽀付未来3天的费⽤， 若不⾜以⽀付，系统发送续费提醒。 根据您最近1天的账单⾦额来判断您的账户余额（含可⽤代⾦券）是否⾜以⽀付未来1天的费⽤， 若不⾜以⽀付，系统发送续费提醒。 ⽋费处理： 北京时间整点检查您的账户余额是否⾜以⽀付本次 DOC 账单的费⽤（如北京时间11点整检查账户 余额是否⾜以⽀付10点⾄11点的账单费⽤），若不⾜以⽀付，即为⽋费，⽋费时系统会发送⽋费 通知。 ⽋费后⽴即停服，系统会发送⽋费停服通知。数据为您保留15天，期间不收取费⽤，15天内未充 值则清除数据，数据清除前1天和清除数据时系统都会发送数据清除通知。 API参考 百度智能云⽂档服务DOC（Document Service）是百度智能云 BCE (Baidu Cloud Engine) 提供的⾯向⽂档 处理的 PaaS (Platform as a Service) 服务平台，为开发者提供Office、WPS等多种格式⽂档的存储、管理 及在线浏览服务。您⽆需了解⽂档存储、转码、分发、在线浏览等技术细节，即可快速搭建安全可靠、⾼ 可定制的⽂档处理平台和应⽤，助⼒在线教育、企业⽹盘等业务的转型升级。 本⽂档介绍 DOC API 的⽤法，主要包括： 使⽤须知 错误返回 公共头域 ⽂档接⼝ 通知接⼝ DOC核⼼概念 API认证机制 AK/SK DOC服务域名 DOC 为全局服务，服务域名是 doc.bj.baidubce.com 。 DOC API⽀持HTTP和HTTPS两种协议。为了 提升数据的安全性，建议使⽤HTTPS协议。 单个原始⽂档⼤⼩限制 200MB。建议您的⽂档⻚数控制在1000⻚以内⽅便系统进⾏处理。 系统限制 编码⻛格 所有 HTTP API 均为 REST ⻛格。 ⽇期与时间 ⽇期与时间的表示有多种⽅式。为统⼀起⻅，除⾮约定俗成或有相应规范，凡是HTTP标准中规定的表示 ⽇期和时间字段⽤GMT，其他⽇期时间表示的地⽅⼀律采⽤UTC时间，遵循ISO 8601，并做以下约束： 表示⽇期⼀律采⽤ YYYY-MM-DD ⽅式，例如 2016-07-07 表示2016年7⽉7⽇。 表示时间⼀律采⽤ hh:mm:ss ⽅式，并在最后加⼀个⼤写字⺟Z表示UTC时间。例如 23:00:10Z 表 示UTC时间23点0分10秒。 凡涉及⽇期和时间合并表示时，在两者中间加⼤写字⺟T，例如 2016-07-07T23:00:10Z 表示UTC 时间2016年7⽉7⽇23点0分10秒。 排版约定 排版格式 含义 <> 变量 [] 可选项 {} 必选项 ¦ 互斥关系 等宽字体Courier New 屏幕输出 错误返回格式 通⽤错误返回格式如下： { "requestId": "<bce-request-id>", "code":"<error-code>", "message":"<error-message>", "success"