文档

WebOffice旧版迁移至新版常见问题

更新时间:

本文介绍使用智能媒体管理过程中文档在线预览编辑从旧版迁移到新版可能遇到的问题。

迁移到新版

如何迁移

您可以按如下步骤迁移:

  1. 创建新版项目(通过新版控制台、新版API均可)。

    说明
  2. 调用新版同功能对应接口GenerateWebofficeToken获取文档在线预览凭证。具体操作,请参见GenerateWebofficeToken - 获取Weboffice凭证

  3. 调用新版同功能对应接口RefreshWebofficeToken刷新文档在线预览凭证。具体操作,请参见RefreshWebofficeToken - 刷新Weboffice凭证

  4. 将您的业务切换到新版接口。

    • SDK/API版本。

      • 新版使用新版SDK,API版本为2020-09-30。

      • 旧版使用旧版SDK,API版本为2017-09-06。

    • 使用创建的新版项目。

说明

关于新版文档在线预览编辑的更多信息,请参见WebOffice服务交互流程

新版与旧版API对应关系说明

API对比

关于新版与旧版API的对应关系,请参见下表。

功能

新版API

旧版API

说明

获取预览或编辑凭证

GenerateWebofficeToken - 获取Weboffice凭证

GetOfficePreviewURL - 获取文档预览URL

新版将获取预览凭证和编辑凭证合并为一个接口,您只需设置参数的值即可选择获取预览凭证或编辑凭证。

GetWebofficeURL - 获取Weboffice的访问凭证

刷新预览或编辑凭证

RefreshWebofficeToken - 刷新Weboffice凭证

RefreshOfficePreviewToken - 刷新文档预览凭证

新版将刷新预览凭证和编辑凭证合并为一个接口。

RefreshWebofficeToken - 刷新Weboffice的访问凭证

新增功能

新版文档预览和编辑新增了以下参数及功能。

参数

功能

说明

PreviewPages

设置预览的文档页数。

新版支持设置预览的文档页数。

您可以指定预览文档的前几页,默认不限制,最大取值为5000。

Password

预览或编辑有密码的文档。

新版支持预览或编辑有密码的文档。

当待预览或编辑的文档有密码时,您可以填写该密码用于打开文档。

ExternalUploaded

文档版本管理。

新版支持将编辑后的文档直接上传至OSS,并作为新版本保存。

默认不上传编辑后的版本,如需上传,请将此参数值设置为true

说明

此功能需要开启OSS的版本控制功能。关于OSS版本控制功能的更多信息,请参见版本控制概述

参数变更

旧版API的以下参数不再适用。

参数

功能

说明

File

文档信息。

新版API无此类参数。

FileID

文档的唯一标识。

新版API无此类参数。

注意事项

  • 新版参数Filename与旧版参数SrcType均表示待预览或编辑文档的类型,但二者取值不同。

    • 新版参数Filename需填写包含文件扩展名的文件名称,例如test-object.docx

    • 旧版参数SrcType需填写文件的扩展名,例如docx。

  • 新版不再支持将编辑后的文档保存到指定的OSS地址(即删除了参数File中的TgtUri选项),您可以通过设置新版参数ExternalUploaded将文档保存为多个版本,便于管理。

  • 新版参数User不再作为必填参数。

    • 不填写时,用户信息会默认显示为Unknown

    • 需要填写时,您可以填写具体的用户信息,包括用户ID(Id)、用户名(Name)和用户头像URL地址(Avatar),或者填写为Unknown。

      重要

      当填写具体的用户信息时,参数Id、NameAvatar首字母均需大写。

迁移中常见的问题

调用API时报错“The specified resource acs:imm::1*******:project/TestProjectName is not found.”

现象描述

调用API时,返回如下错误信息:

The specified resource acs:imm::1*******:project/TestProjectName is not found..

解决方案

  1. 登录智能媒体管理控制台,查看是否为新版控制台。

    • 是,执行步骤2。

    • 否,在页面左下角单击体验新版,切换至新版控制台后执行步骤2。

  2. 确认控制台地域与项目地域是否相同。

    • 是,执行步骤3。

    • 否,在页面左上角将地域切换至与项目相同的地域后执行步骤3。

  3. 确认当前地域项目是否存在,如果项目不存在请创建项目。

存储在OSS中的文档没有后缀可以预览吗?

可以预览,需要填写带后缀的Filename参数。

  • 当文档没有后缀,且填写了带后缀的Filename参数时,会根据Filename参数的后缀判断文件格式。

  • 当文档有后缀,且没有填写Filename参数时,会根据OSS文档的后缀判断文件格式。

  • 当文档没有后缀,且没有填写Filename参数时,无法判断文档类型,会导致预览失败。

  • 本页导读 (1)