GenerateWebofficeToken - 获取Weboffice凭证_智能媒体管理-阿里云帮助中心

获取 Weboffice 访问凭证。Weboffice 提供文档的在线协作功能，包括文档预览、文档编辑，多人协作等，支持协作记录，支持多版本，支持版本回滚等。

接口说明

Weboffice提供文档的在线协作功能，包括预览、编辑、协作等。关于WebOffice的详细使用说明，请参见快速入门。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称。	immtest
SourceURI	string	是	待预览或编辑文档的OSS地址。 OSS地址规则为`oss://bucket/object`，其中`bucket`为和当前项目处于同一地域的OSS Bucket名称，`object`为包含文件扩展名的文件完整路径。	oss://imm-test/test.pptx
Filename	string	否	文件名称，必须包含文件扩展名。默认为参数SourceURI的最后一级。	test.pptx
CachePreview	boolean	否	缓存预览标识。暂不支持该参数。	false
Referer	string	否	OSS防盗链。说明如果访问文档所在的Bucket设置了Referer，请设置此参数。	*
UserData	string	否	用户自定义数据，在消息通知中原样返回。	{"file_id": "abc"}
PreviewPages	long	否	预览前几页。	5
Password	string	否	文档的打开密码。说明如果需要预览或编辑有密码的文档，请设置此参数。	123456
ExternalUploaded	boolean	否	是否支持直接上传文档到OSS。可取值如下： true：支持，上传的文档将覆盖原文档生成新版本。 false（默认）：不支持，上传文档是非预期行为，会返回错误。	false
NotifyTopicName	string	否	异步反向通知的TopicName。	topic1
Hidecmb	boolean	否	是否隐藏工具栏，文档预览模式下支持设置此参数。可取值如下： false（默认）：不隐藏工具栏。 true：隐藏工具栏。	false
Permission	WebofficePermission	否	用户权限信息，以JSON格式表示。用户权限包括如下选项：每个选项的类型均为Boolean，默认值均为false，可选值为true和false。 Readonly（可选）：预览模式。 Rename（可选）：重命名文件权限，只提供消息通知功能，重命名事件会发送到MNS中。 History（可选）：查看历史版本的权限。 Copy（可选）：拷贝权限。 Export（可选）：导出PDF权限。 Print（可选）：打印权限。
User	WebofficeUser	否	用户信息。该参数目前为必填，可以传业务的用户信息，WebOffice页面会进行显示，如无特殊要求可填入"Unknown"。
Watermark	WebofficeWatermark	否	水印信息。
CredentialConfig	CredentialConfig	否	链式授权配置，非必填。更多信息，请参见使用链式授权访问其他实体资源。
Notification	Notification	否	消息通知配置，支持使用MNS、RocketMQ接收异步消息通知。

返回参数

名称	类型	描述	示例值
	object	文档转换任务
RequestId	string	请求ID。	1759315A-CB33-0A75-A72B-62D7********
WebofficeURL	string	文档预览或编辑地址。说明获取的WebofficeURL无法通过浏览器直接打开，需要配合Weboffice JS-SDK使用。更多信息，请参见快速入门。	https://office-hl.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1
AccessToken	string	访问文档预览或编辑服务器的凭证。	2d73dd5d87524c5e8a194c3eb5********
RefreshToken	string	凭证过期时使用RefeshToken刷新凭证。	e374995ec532432bb678074d36********
AccessTokenExpiredTime	string	凭证的过期时间，有效时间为30分钟。	2021-08-30T13:13:11.347146982Z
RefreshTokenExpiredTime	string	刷新凭证的过期时间，有效时间为1天。	2021-08-31T12:43:11.347146982Z

常见错误

ProjectName对应的项目未找到，请到新版本IMM控制台检查地域下该项目是否存在。

{
    "Code": "ResourceNotFound",
    "Message": "The specified resource acs:imm::xxx:project/xxx is not found"
}

User参数是必填参数，请检查该参数是否填写。

{
    "Code": "InvalidArgument.User",
    "Message": "The parameter User is required but not provided"
}

User参数不正确，请检查该参数值是否是正确的JSON格式。

{
    "Code": "InvalidJSON parsing error, User",
    "Message": "Specified parameter JSON parsing error, User is not valid."
}

Permission参数不正确，请检查该参数值是否是正确的JSON格式。

{
    "Code": "InvalidJSON parsing error, Permission",
    "Message": "Specified parameter JSON parsing error, Permission is not valid."
}

Watermark参数不正确，请检查该参数值是否是正确的JSON格式。

{
    "Code": "InvalidJSON parsing error, Watermark",
    "Message": "Specified parameter JSON parsing error, Watermark is not valid."
}

PreviewPages参数格式不正确，请检查PreviewPages参数值。

{
    "Code": "InvalidPreviewPages",
    "Message": "Specified parameter PreviewPages is not valid."
}

SourceURI对应的OSS文件不存在，请检查Bucket下该文件是否存在。

{
    "Code": "ResourceNotFound",
    "Message": "The specified resource oss://xx is not found"
}

示例

正常返回示例

JSON格式

{
  "RequestId": "1759315A-CB33-0A75-A72B-62D7********",
  "WebofficeURL": "https://office-hl.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1",
  "AccessToken": "2d73dd5d87524c5e8a194c3eb5********",
  "RefreshToken": "e374995ec532432bb678074d36********",
  "AccessTokenExpiredTime": "2021-08-30T13:13:11.347146982Z",
  "RefreshTokenExpiredTime": "2021-08-31T12:43:11.347146982Z"
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-03-09

OpenAPI 入参发生变更

变更项	变更内容
入参	OpenAPI 入参发生变更
	新增入参：Notification