全部產品
Search
文件中心

:GenerateWebofficeToken - 擷取Weboffice憑證

更新時間:Jan 27, 2026

擷取文檔預覽編輯憑證

介面說明

  • 請確保在使用該介面前,已充分瞭解Intelligent Media Management產品的收費方式和價格

  • 訪問憑證到期時間為 30 分鐘,重新整理憑證到期時間為 1 天。

  • 返回的到期時間為 UTC 時間,和北京時間有 8 小時的時差。

  • 支援的輸入檔案格式:

    • 文字文檔(Word):doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf。

    • 示範文檔(PPT):ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps。

    • 表格文檔(Excel):et、xls、xlt、xlsx、xlsm、xltx、xltm、csv

    • PDF 文檔:pdf。

  • 支援最大的檔案 200MB。

  • 支援最大的文檔頁數 5000 頁。

  • 2023-12-01 之前建立的專案,按照文檔開啟次數計費。當前按照 API 介面調用次數計費。如需切換成新的計費模式,建立新的專案即可,但需要注意,一次 API 呼叫只能給一個使用者使用,若重複使用,則只有最後一個使用者可以正常訪問,其餘使用者的存取權限將被回收。

  • 在與Intelligent Media Management相同的地區下開通 MNS 服務,建立主題和隊列,並配置訂閱關係,可以通過 NotifyTopicName 參數傳入 MNS 主題名稱來接收檔案儲存的訊息通知。關於 MNS SDK 的更多資訊,請參見接收和刪除訊息。 檔案儲存訊息通知 Message 欄位 JSON 格式樣本請參考 WebOffice 訊息通知格式

說明

若要使用多版本功能,必須先在 OSS 中開通多版本功能,然後將 ”History“參數設定為 true。

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

imm:GenerateWebofficeToken

none

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

請求參數

名稱

類型

必填

描述

樣本值

ProjectName

string

專案名稱,擷取方式請參見建立專案

test-project

SourceURI

string

待預覽或編輯文檔的 OSS 地址。

OSS 地址規則為oss://${Bucket}/${Object},其中Bucket為和當前專案處於同一地區的 OSS Bucket 名稱,Object為包含副檔名的檔案完整路徑。

oss://test-bucket/test-object.docx

Filename

string

檔案名稱,必須包含副檔名。預設為參數 SourceURI 的最後一級。

支援的副檔名(其中 PDF 只支援預覽):

  • 文字文檔(Word):doc、docx、txt、dot、wps、wpt、dotx、docm、dotm、rtf

  • 示範文檔(PPT):ppt、pptx、pptm、ppsx、ppsm、pps、potx、potm、dpt、dps

  • 表格文檔(Excel):et、xls、xlt、xlsx、xlsm、xltx、xltm、csv

  • PDF 文檔:pdf

test-Object.pptx

CachePreview

boolean

緩衝預覽標識:

  • true:開啟後,文檔預覽時將不再更新協同編輯內容,適用於僅預覽的情境。

  • false:關閉時,預設採用協同預覽,及預覽時候可以同步更新協同編輯內容。

重要 緩衝預覽和非緩衝預覽的單價不同,詳情請查看計費項目說明。
重要 緩衝預覽時不支援文檔內容搜尋,不支援列印。
重要 緩衝預覽暫不支援更新緩衝內容。

true、false

Referer

string

OSS 防盜鏈。IMM 需要從 OSS 中擷取源檔案,如果 OSS 進行了防盜鏈設定,IMM 需要將對應的頭部傳給 OSS 才能擷取源檔案。

說明

如果訪問文檔所在的 Bucket 設定了 Referer,請設定此參數。

*

UserData

string

使用者自訂資訊,必須填寫 Notification 參數傳入 MNS 配置時才會生效,在非同步訊息通知中會為您返回,用於方便您系統內對訊息通知進行關聯處理。最大長度為 2048 位元組。

{ "id": "test-id", "name": "test-name" }

PreviewPages

integer

限制只能預覽前幾頁,預設不限制。最大不能超過 5000

5

Password

string

文檔的開啟密碼。

說明

如果需要預覽或編輯有密碼的文檔,請設定此參數。

123456

ExternalUploaded

boolean

OSS 上傳同名檔案是否是預期行為。可取值如下:

  • true:OSS 上傳同名檔案是預期行為,上傳的文檔將覆蓋原文檔產生新版本。在設定為 true 後,仍需先關閉當前正在編輯的文檔,然後等待約 5 分鐘後重新開啟,才能載入新的文檔。僅當文檔處於關閉狀態時上傳才有效,文檔處於開啟狀態時,新的儲存會覆蓋掉上傳的檔案。

  • false(預設):OSS 上傳同名檔案不是預期行為,該介面會返回錯誤。

false

NotifyTopicName

string

支援將一些事件以 MNS 訊息的方式通知給客戶。該參數為 MNS 非同步訊息通知的 topic。

test-topic

Hidecmb

boolean

是否隱藏工具列,文檔預覽模式下支援設定此參數。可取值如下:

  • false(預設):不隱藏工具列。

  • true:隱藏工具列。

false

Permission WebofficePermission

使用者權限資訊,以 JSON 格式表示。

使用者權限包括如下選項:

每個選項的類型均為 Boolean,預設值均為 false,可選值為 true 和 false。

  • Readonly(可選):預覽模式。

  • Rename(可選):重新命名檔案許可權,只提供訊息通知功能,重新命名事件會發送到 MNS 中。

  • History(可選):查看歷史版本的許可權。

  • Copy(可選):拷貝許可權。

  • Export(可選):匯出 PDF 許可權。

  • Print(可選):列印許可權。

說明

PDF 僅支援預覽功能,因此必須將” Readonly“參數設定為 true。

說明

PDF 檔案不支援匯出。

說明

若要使用多版本功能,必須先在 OSS 中開通多版本功能,然後將 ”History“參數設定為 true。

重要 緩衝預覽時不支援列印。
重要 編輯模式可以查看歷史版本,預覽模式不支援查看歷史版本。

User WebofficeUser

使用者資訊。可傳入業務側的使用者資訊,WebOffice 頁面將顯示該資訊。

系統通過 User.Id 區分不同使用者,User.Name 僅用於前端展示。如果未傳入 User.Id,後端將自動產生一個隨機 ID。不同 ID 的使用者視為不同主體,無法互相修改或刪除評論。

預設格式為:Unknown_隨機字串。若未傳入 User.Id,使用者資訊將預設顯示為 "Unknown"。

Watermark WebofficeWatermark

浮水印資訊。該浮水印在前端產生,並沒有寫入到來源文件中,同一個文檔傳入不同的參數會得到不同的浮水印。

CredentialConfig CredentialConfig

如無特殊需求,請保持留空即可。

鏈式授權配置,非必填。更多資訊,請參見使用鏈式授權訪問其他實體資源

Notification Notification

Notification 訊息通知配置,目前僅支援 MNS,非同步通知訊息格式請參考 WebOffice 訊息通知格式

說明

檔案儲存和檔案重新命名時會有訊息通知。

典型情境舉例

對於如下樣本的參數結構,對一些經典的情境樣本說明:

預覽唯讀檔案(如果是預覽 pdf 檔案,必須這樣設定)

文檔預覽模式,文檔只能預覽不可編輯規則:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.pdf",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

預覽檔案尾碼為大寫的檔案

預覽檔案尾碼為大寫的檔案,需要設定 Filename 參數尾碼為小寫:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.DOCX",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

對指定文檔只預覽前 5 頁

文檔一共 10 頁,只顯示前 5 頁規則:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "PreviewPages" : "5",
    "Permission" : "{'Readonly':'true'}"
}

對指定文檔預覽添加密碼

文檔預覽時設定密碼,或者源檔案設定了密碼預覽時直接開啟不要求輸入密碼規則:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Password" : "123456",
    "Permission" : "{'Readonly':'true'}"
}
對指定的文檔預覽添加浮水印

文檔預覽時添加浮水印規則:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Watermark" : "{'Type':'1','Value':'浮水印值','Font':'bold 20px Serif'}",
    "Permission" : "{'Readonly':'true'}"
}
對指定的文檔預覽時隱藏工具列

文檔預覽時隱藏工具列規則:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Hidecmb" : "true",
    "Permission" : "{'Readonly':'true'}"
}
對指定的文檔進行線上編輯,查看歷史版本,拷貝,列印,匯出 PDF 許可權

文檔線上編輯,查看歷史版本,拷貝,列印,匯出 PDF 許可權規則:

 {
    "ProjectName"   : "test-project",
    "SourceURI" : "oss://test-bucket/test-object.docx",
    "Filename" : "test-object.docx",
    "Permission" : "{'Readonly':'false','History':'true','Copy':'true','Print':'true','Export':'true'}"
}

返回參數

名稱

類型

描述

樣本值

object

Weboffice 訪問憑證。

RequestId

string

請求 ID。

1759315A-CB33-0A75-A72B-62D7********

WebofficeURL

string

Weboffice 入口 URL。線上預覽或者編輯文檔。

說明

無法通過瀏覽器直接開啟,需要配合 Weboffice JS-SDK,和訪問憑證(AccessToken)一起才可以預覽或編輯文檔。更多資訊,請參見快速入門

https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1

AccessToken

string

Weboffice 訪問憑證。

2d73dd5d87524c5e8a194c3eb5********

RefreshToken

string

Weboffice 重新整理憑證。

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-cn-shanghai.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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情