Asset Compute Service HTTP API

API的使用僅限於開發目的。 在開發自定義應用程式時，API被作為上下文提供。 Adobe Experience Manager 作為 Cloud Service 使用API將處理資訊傳遞給自定義應用程式。 有關詳細資訊，請參見 使用資產微服務和處理配置檔案。

任何客戶 Asset Compute Service HTTP API必須遵循此高級流：

1. 將客戶端設定為 Adobe Developer Console IMS組織的項目。 每個獨立的客戶端（系統或環境）都需要自己的獨立項目來分隔事件資料流。

2. 客戶端使用 JWT（服務帳戶）身份驗證。

3. 客戶端呼叫 /register 只檢索一次日誌URL。

4. 客戶端呼叫 /process 要為其生成格式副本的每個資產。 呼叫是非同步的。

5. 客戶定期輪詢日誌 接收事件。 在成功處理格式副本時，它會接收每個請求格式副本的事件(rendition_created 事件類型)或如果出現錯誤(rendition_failed 事件類型)。

的 @adobe/asset-compute-client 模組使Node.js代碼中的API易於使用。

驗證和授權

所有API都需要訪問令牌驗證。 請求必須設定以下標頭：

1. Authorization 帶有承載令牌的頭，即技術帳戶令牌，通過 JWT交換 從AdobeDeveloper Console項目。 的 作用域 下面記錄。

2. x-gw-ims-org-id IMS組織ID的頭。

3. x-api-key 從 Adobe Developers Console 項目。

範圍

確保訪問令牌的以下作用域：

• openid
• AdobeID
• asset_compute
• read_organizations
• event_receiver
• event_receiver_api
• adobeio_api
• additional_info.roles
• additional_info.projectedProductContext

這些要求 Adobe Developer Console 要訂閱的項目 Asset Compute。 I/O Events, I/O Management API 服務。 單個作用域的細分為：

• 基本

  • 範圍： openid,AdobeID

• asset compute

  • 元目錄： asset_compute_meta
  • 範圍： asset_compute,read_organizations

• Adobe I/O 事件

  • 元目錄： event_receiver_api
  • 範圍： event_receiver,event_receiver_api

• Adobe I/O 管理API

  • 元目錄： ent_adobeio_sdk
  • 範圍： adobeio_api,additional_info.roles,additional_info.projectedProductContext

註冊

每個客戶端 Asset Compute service — 獨特 Adobe Developer Console 訂閱服務的項目 — 必須 註冊 在發出處理請求之前。 註冊步驟返回唯一事件日誌，該日誌是從格式副本處理中檢索非同步事件所必需的。

在其生命週期結束時，客戶機 註銷。

註冊請求

此API調用設定 Asset Compute 提供事件日誌URL。 這是冪等操作，只需為每個客戶端調用一次。 可以再次調用它以檢索日誌URL。

註冊響應

HTTP狀態代碼為：

• 200次成功:請求成功時。 它包含 journal 通過以下方式觸發的非同步處理結果的通知的URL /process （作為事件類型） rendition_created 成功時，或 rendition_failed 失敗時)。

  {
      "ok": true,
      "journal": "https://api.adobe.io/events/organizations/xxxxx/integrations/xxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "requestId": "1234567890"
  }
  

• 401未授權:請求無效時發生 認證。 示例可能是無效的訪問令牌或無效的API密鑰。

• 《小行星403》:請求無效時發生 授權。 示例可能是有效的訪問令牌，但Adobe開發者控制台項目（技術帳戶）未訂閱所有必需的服務。

• 429請求過多:當系統由此客戶端或其他客戶端過載時發生。 客戶端應使用 指數退避。 屍體是空的。

• 4xx錯誤:出現任何其他客戶端錯誤時，註冊失敗。 通常會返回JSON響應，但並不保證所有錯誤都會返回：

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

• 5xx錯誤:出現任何其他伺服器端錯誤並註冊失敗時發生。 通常會返回JSON響應，但並不保證所有錯誤都會返回：

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

註銷請求

此API調用取消註冊 Asset Compute 客戶端。 此後，將無法再呼叫 /process。 對未註冊的客戶端或尚未註冊的客戶端使用API調用將返回 404 錯誤。

註銷響應

狀態代碼為：

• 200次成功:在找到並刪除註冊和日記帳時發生。

  {
      "ok": true,
      "requestId": "1234567890"
  }
  

• 401未授權:請求無效時發生 認證。 示例可能是無效的訪問令牌或無效的API密鑰。

• 《小行星403》:請求無效時發生 授權。 示例可能是有效的訪問令牌，但Adobe開發者控制台項目（技術帳戶）未訂閱所有必需的服務。

• 找不到404:當給定憑據沒有當前註冊時發生。

  {
      "ok": true,
      "requestId": "1234567890"
  }
  

• 429請求過多:在系統過載時發生。 客戶端應使用 指數退避。 屍體是空的。

• 4xx錯誤:出現任何其他客戶端錯誤並註銷失敗時發生。 通常會返回JSON響應，但並不保證所有錯誤都會返回：

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

• 5xx錯誤:出現任何其他伺服器端錯誤並註冊失敗時發生。 通常會返回JSON響應，但並不保證所有錯誤都會返回：

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

處理請求

的 process 操作根據請求中的說明提交將源資產轉換為多個格式副本的任務。 成功完成的通知（事件類型） rendition_created)或任何錯誤（事件類型） rendition_failed)被發送到必須使用 /register 在進行任意數量 /process 請求。 錯誤格式的請求立即失敗，錯誤代碼為400。

使用URL(如AmazonAWSS3預簽名的URL或Azure Blob儲存SAS URL)引用二進位檔案，以便讀取 source 資產(A)GET URL)和寫入格式副本(PUT URL)。 客戶端負責生成這些預簽名的URL。

進程請求JSON

請求正文 /process 是具有此高級架構的JSON對象：

{
    "source": "",
    "renditions" : []
}

可用欄位包括：

的 source 可以是 <string> 可視為URL，或可以是 <object> 的子菜單。 以下變型相似：

"source": "http://example.com/image.jpg"

"source": {
    "url": "http://example.com/image.jpg"
}

源對象欄位

完整 process 請求示例

{
    "source": "https://www.adobe.com/content/dam/acom/en/lobby/lobby-bg-bts2017-logged-out-1440x860.jpg",
    "renditions" : [{
            "name": "image.48x48.png",
            "target": "https://some-presigned-put-url-for-image.48x48.png",
            "fmt": "png",
            "width": 48,
            "height": 48
        },{
            "name": "image.200x200.jpg",
            "target": "https://some-presigned-put-url-for-image.200x200.jpg",
            "fmt": "jpg",
            "width": 200,
            "height": 200
        },{
            "name": "cqdam.xmp.xml",
            "target": "https://some-presigned-put-url-for-cqdam.xmp.xml",
            "fmt": "xmp"
        },{
            "name": "cqdam.text.txt",
            "target": "https://some-presigned-put-url-for-cqdam.text.txt",
            "fmt": "text"
    }]
}

進程響應

的 /process 請求立即返回，並基於基本請求驗證成功或失敗。 實際資產處理非同步進行。

狀態代碼：

• 200次成功:如果請求已成功提交。 響應JSON包括 "ok": true:

  {
      "ok": true,
      "requestId": "1234567890"
  }
  

• 400無效請求:如果請求格式不正確，例如請求JSON中缺少必需欄位。 響應JSON包括 "ok": false:

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

• 401未授權:當請求無效時 認證。 示例可能是無效的訪問令牌或無效的API密鑰。

• 《小行星403》:當請求無效時 授權。 示例可能是有效的訪問令牌，但Adobe開發者控制台項目（技術帳戶）未訂閱所有必需的服務。

• 429請求過多:當系統由此客戶端或通常過載時。 客戶端可以使用 指數退避。 屍體是空的。

• 4xx錯誤:出現任何其他客戶端錯誤時。 通常會返回JSON響應，但並不保證所有錯誤都會返回：

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

• 5xx錯誤:當存在任何其他伺服器端錯誤時。 通常會返回JSON響應，但並不保證所有錯誤都會返回：

  {
      "ok": false,
      "requestId": "1234567890",
      "message": "error message"
  }
  

大多數客戶端可能傾向於使用 指數退避 在任何錯誤 除 配置問題（如401或403）或無效請求（如400）。 除了通過429個響應來限制正常速率外，臨時服務中斷或限制可能導致5xx錯誤。 建議在一段時間後重試。

所有JSON響應（如果存在）包括 requestId 與 X-Request-Id 標題。 建議從頭讀取，因為它始終存在。 的 requestId 在與處理請求相關的所有事件中也返回為 requestId。 客戶端不能對此字串的格式作任何假設，它是不透明的字串標識符。

選擇加入後處理

的 asset computeSDK 支援一組基本影像後處理選項。 通過設定欄位，自定義工作人員可以明確選擇後處理 postProcess 格式副本對象上 true。

支援的使用案例包括：

• 將格式副本裁剪到其限制由crop.w、crop.h、crop.x和crop.y定義的矩形。它由 instructions.crop 的子菜單。
• 使用寬度、高度或兩者調整影像大小。 它由 instructions.width 和 instructions.height 的子菜單。 要僅使用寬度或高度調整大小，請僅設定一個值。 計算服務可降低縱橫比。
• 設定JPEG影像的質量。 它由 instructions.quality 的子菜單。 最佳質量由 100 而較小的值表示質量下降。
• 建立隔行掃描影像。 它由 instructions.interlace 的子菜單。
• 設定DPI以通過調整應用於像素的比例來調整呈現大小以用於案頭發佈。 它由 instructions.dpi 的子菜單。 但是，要調整影像大小以使其以不同的解析度大小相同，請使用 convertToDpi 的下界。
• 調整影像的大小，使其渲染的寬度或高度在指定目標解析度(DPI)下保持與原始影像相同。 它由 instructions.convertToDpi 的子菜單。

水印資產

的 asset computeSDK 支援向PNG、JPEG、TIFF和GIF影像檔案添加水印。 水印將按照 watermark 格式副本上的對象。

在格式副本後處理期間執行水印。 要對資產進行水印，自定義工作人員 後處理 設定欄位 postProcess 格式副本對象上 true。 如果工作程式不選擇加入，則不應用水印，即使在請求中的格式副本對象上設定了水印對象。

格式副本說明

這些是 renditions 陣列 /進程。

公用欄位

格式副本特定欄位

有關當前支援的檔案格式的清單，請參見 支援的檔案格式。

特定於水印的欄位

PNG格式用作水印。

非同步事件

一旦完成格式副本的處理或出錯，事件將發送到 Adobe I/O 事件日記帳。 客戶端必須偵聽通過提供的日誌URL /register。 日誌響應包括 event 陣列，每個事件包含一個對象，其中 event 欄位包含實際事件負載。

的 Adobe I/O 所有事件的事件類型 Asset Compute Service 是 asset_compute。 日記帳僅自動訂閱此事件類型，並且不再需要根據 Adobe I/O 事件類型。 服務特定事件類型可在 type 事件的屬性。

事件類型

事件屬性

中繼資料

錯誤原因

Business.Adobe.com資源