调用GetWebofficeURL获取Weboffice的访问凭证_智能媒体管理(IMM)-阿里云帮助中心

获取Weboffice的访问凭证。Weboffice提供文档的在线协作功能，包括预览、编辑、协作等。

接口说明

此接口已不再维护，建议使用新版（2020-09-30 版本）接口 GenerateWebofficeToken 。关于新版与旧版 API 的对比，请参见新旧版本使用指引中的新版与旧版 API 对应关系说明章节。
此 API 不受单用户每秒调用次数不能超过十次的限制。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
imm:GetWebofficeURL		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
Project	string	是	项目名称。	immdoctest
SrcType	string	否	文件的后缀类型。默认按照 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	doc
FileID	string	是	文件唯一标识，可以由字母和数字组成且不超过 32 个字符。	mytest
User	string	是	用户信息，以 JSON 格式表示。用户信息包括如下选项：每个选项的类型均为 String。 ID（必选）：用户唯一标识，可以由字母和数字组成，且不超过 15 个字符。 Name（必选）：用户名，不超过 32 个字符。 Avatar（可选）：头像地址。	{"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"}
Permission	string	是	用户权限控制，以 JSON 格式表示。用户权限包括如下选项：每个选项的类型均为 Boolean，默认值均为 false，可选值为 true 和 false。 Readonly（可选）：预览模式。 Rename（可选）：重命名文件权限，只提供消息通知功能，重命名事件会发送到轻量消息队列（原 MNS）中。 History（可选）：查看历史版本的权限。 Copy（可选）：拷贝权限。 Export（可选）：导出 PDF 权限。 Print（可选）：打印权限。	{"Rename": true, "Readonly": false, "History": true}
File	string	是	文件信息，以 JSON 格式表示。文件信息包括如下选项： Modifier（必选）：最近一次编辑文件的用户，类型为 User。 Creator（必选）：创建文件的用户，类型为 User。 Name（必选）：文件名称，类型为 String。 Version（必选）：文件版本号，类型为 Integer。 SrcUri（必选）：文件的 OSS 地址，类型为 String。OSS 地址规则为`oss://bucket/object`，其中 bucket 为和当前项目处于同一区域的 OSSBucket 名称，object 为文件路径。 TgtUri（必选）：文件编辑后保存到的 OSS 地址，可以和 SrcUri 相同，类型为 String。	[{"Modifier": {"Avatar": "http://example.com/?id=user1", "ID": "user1", "Name": "test-user1"}, "Name": "mytest.doc", "Creator": {"Avatar": "http://example.com/?id=user1", "ID": "user1", "Name": "test-user1"}, "SrcUri": "oss://test-bucket/mytest.doc", "Version": 3, "TgtUri": "oss://test-bucket/mytest.doc"}]
NotifyEndpoint	string	是	异步反向通知的 Endpoint，重命名、用户上线等事件可以通过该 Endpoint 异步通知给调用者。使用此功能需要先开通轻量消息队列（原 MNS）服务，新建 topic 和 queue，并配置订阅关系。具体操作，请参见消息服务 MNS 快速入门。说明轻量消息队列（原 MNS）服务和智能媒体管理必须处于同一地域，异步反向通知的 Endpoint 必须是内网访问地址。	http://1111111111.mns.cn-hangzhou-internal.aliyuncs.com
NotifyTopicName	string	否	异步反向通知的 TopicName。	topic1
Watermark	string	否	水印，以 JSON 格式表示。包括以下信息： Type：水印类型。0：无水印，1：文字水印。 Rotate：文字水印的旋转度，单位为弧度。 Vertical：文字水印垂直间距，单位为 px。 Value：文字水印的文字。当 WatermarkType 设置为 1 时，才能设置此参数。 FillStyle：文字水印的透明度，默认值为 rgba(192,192,192,0.6)。 Horizontal：文字水印水平间距，单位为 px。 Font：文字水印的字体，默认值为 bold 20px Serif，即默认字体加粗，字体大小为 20 px，字体格式为 Serif。支持的字体格式为宋体、楷体、Serif（默认）、Arial、Georgia、Tahoma、Comic Sans MS、Times New Roman、Courier New、Verdana。	{"Rotate": -0.7853982, "Vertical": 100, "Value": "hatlonely", "FillStyle": "rgba(192, 192, 192, 0.6)", "Horizontal": 50, "Font": "bold 20px Serif", "Type": 1}
Hidecmb	boolean	否	是否隐藏编辑控件。取值范围如下： true（默认）：是。 false：否。	true

返回参数

名称	类型	描述	示例值
	object
RefreshToken	string	凭证过期时使用 RefeshToken 刷新凭证。	4cdfb7fac3564268aff15360ac********
RequestId	string	当次请求的 Request ID。	CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
AccessToken	string	访问文档预览服务器的凭证。	96c77f96d4c2487aba86549222********
RefreshTokenExpiredTime	string	刷新凭证的过期时间，有效时间为 1 天。	2020-12-26T07:13:38.322018529Z
WebofficeURL	string	文档协作地址。	https://office-cn-hangzhou.imm.aliyuncs.com/office/w/7c7bb3419a0918203026217468a8e9fe375723ae?_w_tokentype=1
AccessTokenExpiredTime	string	凭证的过期时间，有效时间为 30 分钟。	2020-12-25T07:43:38.322018529Z

示例

正常返回示例

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"
}

错误码

访问错误中心查看更多错误码。