文档在线编辑

本文档描述网盘与相册服务的文档在线编辑功能,您可以通过PDS提供的默认客户端使用文档在线编辑,也可以参考该文档调用API实现文档在线编辑。

文件在线编辑属于增值功能,网盘与相册服务开发版中默认未开启,使用前请先联系我们开通

网盘与相册服务开发版,对增值服务会进行单独收费,请见增值服务计费项

网盘与相册服务开发版,启用在线编辑后,界面功能和企业版一致,界面使用可参考企业版在线编辑功能

支持格式

表格文件

文字文件

演示文件

et,xls,xlt,xlsx,xlsm,xltx,xltm,csv

doc,docx,txt,dot,wps,wpt,dotx,docm,dotm,rtf

ppt,pptx,pptm,ppsx,ppsm,pps,potx,potm,dpt,dps

功能限制

  • 可多人在线协作编辑,最多支持365人,同时在线编辑人数超过50人时可能会有卡顿情况。

  • 支持200MB以内的文件进行在线编辑,若该文件大小超过限值,无法进行在线编辑。

  • 协作记录保留180天。

API 调用流程及示例

(1)流程说明

版本

说明:

  • 调用方先通过获取在线编辑地址接口,获取在线编辑的URL和token,然后对接、打开在线编辑页面。

  • 在线编辑token具有时效性,需要调用刷新在线编辑token接口,通过refresh_token获取新的token。

  • 在线编辑页面对接是通过前端技术实现,推荐直接使用PDS提供的Javascript SDK,来实现文件在线编辑。可以参考Javascript SDK的文件增值服务页面中,getOfficeEditUrl和refreshOfficeEditToken方法的描述,并参考“文档预览方法举例”小节的对接说明。

(2)获取在线编辑地址

POST /v2/file/get_office_edit_url

请求参数:

名称

位置

类型

必选

说明

Authorization

header

string

access_token

x-share-token

header

string

分享token,分享下使用,此时不需要传入Authorization

drive_id

body

string

drive ID,drive ID和 share ID互斥,必须且只能传一个

share_id

body

string

分享ID,分享下使用,此时不能传入drive_id

file_id

body

string

需要编辑的文件ID

option

body

json

编辑控制选项

option参数

名称

位置

类型

必选

说明

copy

body

bool

是否允许复制内容

readonly

body

bool

是否为只读,在线编辑时,设置为false

返回参数:

字段名称

必选

类型

描述

edit_url

string

在线协同地址

office_access_token

string

访问凭证,有效时间为30分钟

office_refresh_token

string

刷新凭证,有效时间为1天

请求示例:

{
	"drive_id": "1",
	"file_id": "xxxxxx",
	"option": {
		"readonly": false,
		"copy": true
	}
}

返回示例:

{
	"edit_url": "xxxxxx",
	"office_access_token": "xxxxxx",
	"office_refresh_token": "xxxxxx"
}

(3)刷新在线编辑token

POST /v2/file/refresh_office_edit_token

请求参数:

名称

位置

类型

必选

说明

Authorization

header

string

access_token

x-share-token

header

string

分享token,分享下使用,此时不需要传入Authorization

share_id

body

string

分享ID,分享下使用

office_access_token

body

string

访问凭证

office_refresh_token

body

string

刷新凭证

返回参数:

字段名称

必选

类型

描述

office_access_token

string

新的访问凭证,有效时间为30分钟

office_refresh_token

string

新的刷新凭证,有效时间为1天

请求示例:

{
	"office_access_token": "xxxxxx",
	"office_refresh_token": "xxxxxx"
}

返回示例:

{
	"office_access_token": "xxxxxx",
	"office_refresh_token": "xxxxxx"
}

(4)对接在线编辑页面

在线编辑页面对接是通过前端技术实现,推荐直接使用PDS提供的Javascript SDK,来实现文件在线编辑。请参考Javascript SDK的文件增值服务页面。

如果不使用PDS Javascript SDK,PDS文档的预览对接的是阿里云IMM的文档预览功能,可以参考IMM快速入门,前端JS-SDK使用部分的描述。其中:获取tokenInfo替换为调用PDS获取在线编辑地址接口;获取refreshToken替换为调用PDS刷新在线编辑token接口。

常见问题

(1)文档在线编辑需要什么权限

Web客户端、桌面客户端的文档在线编辑功能,需要对文件有更新权限。

(2)拥有在线编辑的权限,但是文档无法编辑

可按照以下步骤排查:

<1> 在线编辑是增值功能,请确认是否开通此功能。

<2> 请确认文档类型,是否为在线编辑支持的类型。

<3> 请确认文档大小,是否超过支持的大小限制,目前是200MB。

<4> 请网盘的超级管理员,在管理控制台-->企业设置-->文件设置界面,查看“上传文件设置”。如果限制上传文档类型的文件,无法对文档进行在线编辑。如果限制了单文件上传的大小,超过限制大小的文档,在线编辑无法保存成功。

使用文档在线编辑功能过程中,遇到问题请联系我们

阿里云首页 网盘与相册服务 相关技术圈