日本熟妇hd丰满老熟妇,中文字幕一区二区三区在线不卡 ,亚洲成片在线观看,免费女同在线一区二区

GenerateWebofficeToken - 獲取Weboffice憑證

獲取文檔預覽編輯憑證。

接口說明

  • 請確保在使用該接口前,已充分了解智能媒體管理產品的收費方式和價格。

  • 訪問憑證過期時間為 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 調用只能給一個用戶使用,若重復使用,則只有最后一個用戶可以正常訪問,其余用戶的訪問權限將被回收。

  • 在與智能媒體管理相同的地域下開通 MNS 服務,創建主題和隊列,并配置訂閱關系,可以通過 NotifyTopicName 參數傳入 MNS 主題名稱來接收文件保存的消息通知。關于 MNS SDK 的更多信息,請參見接收和刪除消息。 文件保存消息通知 Message 字段 JSON 格式示例請參考 WebOffice 消息通知格式

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

調試

您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。

授權信息

當前API暫無授權信息透出。

請求參數

名稱類型必填描述示例值
ProjectNamestring

項目名稱,獲取方式請參見創建項目

test-project
SourceURIstring

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

OSS 地址規則為oss://${Bucket}/${Object},其中Bucket為和當前項目處于同一地域的 OSS Bucket 名稱,Object為包含文件擴展名的文件完整路徑。

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

文件名稱,必須包含文件擴展名。默認為參數 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
CachePreviewboolean

緩存預覽標識:

  • true:開啟后,文檔預覽時將不再更新協同編輯內容,適用于僅預覽的場景。
  • false:關閉時,默認采用協同預覽,及預覽時候可以同步更新協同編輯內容。

注意 緩存預覽和非緩存預覽的單價不同,詳情請查看計費項說明。
注意 該參數設置后,Pemission.copy 參數不生效。>
注意 緩存預覽時不支持打印。

true、false
Refererstring

OSS 防盜鏈。IMM 需要從 OSS 中獲取源文件,如果 OSS 進行了防盜鏈設置,IMM 需要將對應的頭部傳給 OSS 才能獲取源文件。

說明 如果訪問文檔所在的 Bucket 設置了 Referer,請設置此參數。
*
UserDatastring

用戶自定義信息,必須填寫 Notification 參數傳入 MNS 配置時才能生效,在異步消息通知中會為您返回,用于方便您系統內對消息通知進行關聯處理。最大長度為 2048 字節。

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

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

5
Passwordstring

文檔的打開密碼。

說明 如果需要預覽或編輯有密碼的文檔,請設置此參數。
123456
ExternalUploadedboolean

是否支持直接上傳文檔到 OSS??扇≈等缦拢?/p>

  • true:支持,上傳的文檔將覆蓋原文檔生成新版本。在開啟后,仍需先關閉當前正在編輯的文檔,然后等待約 5 分鐘后重新打開,才能加載新的文檔。僅當文檔處于關閉狀態時才可上傳,文檔處于打開狀態時,新的保存會覆蓋掉上傳的文件。
  • false(默認):不支持,上傳文檔是非預期行為,會返回錯誤。
false
NotifyTopicNamestring

支持將一些事件以 MNS 消息的方式通知給客戶。該參數為 MNS 異步消息通知的 topic。

test-topic
Hidecmbboolean

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

  • false(默認):不隱藏工具欄。

  • true:隱藏工具欄。

false
PermissionWebofficePermission

用戶權限信息,以 JSON 格式表示。

用戶權限包括如下選項:

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

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

  • Rename(可選):重命名文件權限,只提供消息通知功能,重命名事件會發送到 MNS 中。

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

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

  • Export(可選):導出 PDF 權限。

  • Print(可選):打印權限。

說明 PDF 僅支持預覽功能,因此必須將” Readonly“參數設置為 true。
說明 若要使用多版本功能,必須先在 OSS 中開通多版本功能,然后將 ”History“參數設置為 true。

注意 緩存預覽時不支持打印。

UserWebofficeUser

用戶信息??梢詡鳂I務的用戶信息,WebOffice 頁面會進行顯示,如果不傳入此字段,用戶信息會默認顯示為“Unknown”。

WatermarkWebofficeWatermark

水印信息。該水印在前端生成,并沒有寫入到源文檔中,同一個文檔傳入不同的參數會得到不同的水印。

CredentialConfigCredentialConfig

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

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

NotificationNotification

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 訪問憑證。

RequestIdstring

請求 ID。

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

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

說明 無法通過瀏覽器直接打開,需要配合 Weboffice JS-SDK,和訪問憑證(AccessToken)一起才可以預覽或編輯文檔。更多信息,請參見快速入門
https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1
AccessTokenstring

Weboffice 訪問憑證。

2d73dd5d87524c5e8a194c3eb5********
RefreshTokenstring

Weboffice 刷新憑證。

e374995ec532432bb678074d36********
AccessTokenExpiredTimestring

訪問憑證的過期時間。過期時間 30 分鐘。

2021-08-30T13:13:11.347146982Z
RefreshTokenExpiredTimestring

刷新憑證的過期時間。過期時間 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"
}

錯誤碼

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

變更歷史

變更時間變更內容概要操作
2023-08-30API 內部配置變更,不影響調用查看變更詳情
2023-03-09OpenAPI 入參發生變更查看變更詳情

相關文檔