调用GetWebofficeURL接口获取Weboffice的访问凭证。Weboffice提供文档的在线协作功能,包括预览、编辑、协作等。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetWebofficeURL

操作接口名称,固定取值为GetWebofficeURL。

File String [{"Modifier": {"Avatar": "http://xxx.cn/?id=user1", "ID": "user1", "Name": "test-user1"}, "Name": "mytest.doc", "Creator": {"Avatar": "http://xxx.cn/?id=user1", "ID": "user1", "Name": "test-user1"}, "SrcUri": "oss://test-bucket/mytest.doc", "Version": 3, "TgtUri": "oss://test-bucket/mytest.doc"}]

文件信息,以JSON格式表示。

文件信息包括如下选项:

  • Modifier(必选):最近一次编辑文件的用户,类型为User。
  • Creator(必选):创建文件的用户,类型为User。
  • Name(必选):文件名称,类型为String。
  • Version(必选):文件版本号,类型为Integer。
  • SrcUri(必选):文件的OSS地址,类型为String。

    OSS地址规则为oss://bucket/object,其中bucket为和当前项目处于同一区域的OSSBucket名称,object为文件路径。

  • TgtUri(必选):文件编辑后保存到的OSS地址,可以和SrcUri相同,类型为String。
FileID String mytest

文件唯一标识,可以由字母和数字组成且不超过32个字符。

NotifyEndpoint String http://1111111111.mns.cn-hangzhou.aliyuncs.com

异步反向通知的Endpoint,重命名、用户上线等事件可以通过该Endpoint异步通知给调用者。使用此功能需要先开通MNS服务,新建topic和queue,并配置订阅关系。具体操作,请参见消息服务MNS快速入门

说明 MNS服务和智能媒体管理必须处于同一地域。
Permission String {"Rename": true, "Readonly": false, "History": true}

用户权限控制,以JSON格式表示。

用户权限包括如下选项:

每个选项的类型均为Boolean,默认值均为false,可选值为true和false。

  • Readonly(可选):预览模式。
  • Rename(可选):重命名文件权限,只提供消息通知功能,重命名事件会发送到MNS中。
  • History(可选):查看历史版本的权限。
  • Copy(可选):拷贝权限。
  • Export(可选):导出PDF权限。
  • Print(可选):打印权限。
Project String immdoctest

项目名称。

User String {"ID": "user1","Name": "test-user1","Avatar": "http://xxx.cn/?id=user1"}

用户信息,以JSON格式表示。

用户信息包括如下选项:

每个选项的类型均为String。

  • ID(必选):用户唯一标识,可以由字母和数字组成,且不超过15个字符。
  • Name(必选):用户名,不超过32个字符。
  • Avatar(可选):头像地址。
RegionId String cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com,例如当RegionId为cn-hangzhou时,地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

SrcType String doc

文件的后缀类型。默认按照File.Name对应的文件后缀名确定源数据的类型。

pdf文件仅支持预览,不支持编辑,需要将Permission字段中的Readonly设置为true。

目前支持的文件类型有:

  • 表格文件: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
  • pdf文件:pdf
NotifyTopicName String topic1

异步反向通知的TopicName。

Watermark String {"Rotate": -0.7853982, "Vertical": 100, "Value": "hatlonely", "FillStyle": "rgba(192, 192, 192, 0.6)", "Horizontal": 50, "Font": "bold 20px Serif", "Type": 1}

水印,以json格式表示。

包括以下信息:

  • Type 水印类型。 0:无水印 1:文字水印。
  • Rotate 文字水印的旋转度,单位为弧度。
  • Vertical 文字水印垂直间距,单位为px。
  • Value 文字水印的文字。当WatermarkType设置为1时,才能设置此参数。
  • FillStyle 文字水印的透明度,默认值为rgba(192, 192, 192, 0.6)。
  • Horizontal 文字水印水平间距,单位为px。
  • Font 文字水印的字体,默认值为bold 20px Serif。
Hidecmb Boolean true

是隐藏编辑控件

返回数据

名称 类型 示例值 描述
AccessToken String 96c77f96d4c2487aba86549222********

访问文档预览服务器的凭证。

AccessTokenExpiredTime String 2020-12-25T07:43:38.322018529Z

凭证的过期时间,有效时间为30分钟。

RefreshToken String 4cdfb7fac3564268aff15360ac********

凭证过期时使用RefeshToken刷新凭证。

RefreshTokenExpiredTime String 2020-12-26T07:13:38.322018529Z

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

RequestId String CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6

当次请求的Request ID。

WebofficeURL String https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1

文档协作地址。

示例

请求示例

http(s)://[Endpoint]/?Action=GetWebofficeURL
&File=[{"Modifier": {"Avatar": "http://xxx.cn/?id=user1", "ID": "user1", "Name": "test-user1"}, "Name": "mytest.doc", "Creator": {"Avatar": "http://xxx.cn/?id=user1", "ID": "user1", "Name": "test-user1"}, "SrcUri": "oss://test-bucket/mytest.doc", "Version": 3, "TgtUri": "oss://test-bucket/mytest.doc"}]
&FileID=mytest
&NotifyEndpoint=http://1111111111.mns.cn-hangzhou.aliyuncs.com
&Permission={"Rename": true, "Readonly": false, "History": true}
&Project=immdoctest
&User={"ID": "user1","Name": "test-user1","Avatar": "http://xxx.cn/?id=user1"}
&<公共请求参数>

正常返回示例

XML格式

<RefreshToken>4cdfb7fac3564268aff15360ac********</RefreshToken>
<RequestId>CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6</RequestId>
<AccessToken>96c77f96d4c2487aba86549222********</AccessToken>
<RefreshTokenExpiredTime>2020-12-26T07:13:38.322018529Z</RefreshTokenExpiredTime>
<WebofficeURL>https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1</WebofficeURL>
<AccessTokenExpiredTime>2020-12-25T07:43:38.322018529Z</AccessTokenExpiredTime>

JSON格式

{
    "RefreshToken": "4cdfb7fac3564268aff15360ac********",
    "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
    "AccessToken": "96c77f96d4c2487aba86549222********",
    "RefreshTokenExpiredTime": "2020-12-26T07:13:38.322018529Z",
    "WebofficeURL": "https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1",
    "AccessTokenExpiredTime": "2020-12-25T07:43:38.322018529Z"
}