获取Weboffice的访问凭证。Weboffice提供文档的在线协作功能,包括预览、编辑、协作等。
接口说明
注意事项
此API不受单用户每秒调用次数不能超过十次的限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Project | string | 是 | 项目名称。 | immdoctest |
SrcType | string | 否 | 文件的后缀类型。默认按照File.Name对应的文件后缀名确定源数据的类型。 pdf文件仅支持预览,不支持编辑,需要将Permission字段中的Readonly设置为true。 目前支持的文件类型有:
| doc |
FileID | string | 是 | 文件唯一标识,可以由字母和数字组成且不超过32个字符。 | mytest |
User | string | 是 | 用户信息,以JSON格式表示。 用户信息包括如下选项: 每个选项的类型均为String。
| {"ID": "user1","Name": "test-user1","Avatar": "http://example.com?id=user1"} |
Permission | string | 是 | 用户权限控制,以JSON格式表示。 用户权限包括如下选项: 每个选项的类型均为Boolean,默认值均为false,可选值为true和false。
| {"Rename": true, "Readonly": false, "History": true} |
File | string | 是 | 文件信息,以JSON格式表示。 文件信息包括如下选项:
| [{"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格式表示。 包括以下信息:
| {"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 |
返回参数
示例
正常返回示例
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"
}
错误码
访问错误中心查看更多错误码。