Asset Compute Service HTTP API asset-compute-http-api

API的使用僅限於開發目的。 API在開發自訂應用程式時作為內容提供。 Adobe Experience Manager as a Cloud Service使用此API將處理資訊傳遞至自訂應用程式。 如需詳細資訊，請參閱使用資產微服務和處理設定檔。

Asset Compute Service HTTP API的任何使用者端都必須遵循此高階流程：

adobe-asset-compute-client模組可讓您在Node.js程式碼中輕鬆使用API。

驗證和授權 authentication-and-authorization

所有API都需要存取權杖驗證。 請求必須設定以下標頭：

範圍 scopes

確定以下存取權杖範圍：

這些範圍需要訂閱Asset Compute、I/O Events和I/O Management API服務的Adobe Developer Console專案。 個別範圍的劃分如下：

註冊 register

Asset Compute service的每個使用者端（訂閱此服務的唯一Adobe Developer Console專案）都必須註冊，才能提出處理要求。 註冊步驟會傳回從轉譯處理中擷取非同步事件所需的唯一事件日誌。

在其生命週期結束時，使用者端可以取消註冊。

註冊要求 register-request

此API呼叫會設定Asset Compute使用者端並提供事件日誌URL。 此程式是等冪操作，每個使用者端只需要呼叫一次。 可再次呼叫它以擷取日誌URL。

登入回應 register-response

HTTP狀態碼為：

取消註冊要求 unregister-request

此API呼叫會取消註冊Asset Compute使用者端。 此取消註冊發生後，就不能再呼叫/process。 對未註冊的使用者端或尚未註冊的使用者端使用API呼叫會傳回404錯誤。

取消登入回應 unregister-response

狀態代碼為：

處理要求 process-request

process作業會根據請求中的指示，提交將來源資產轉換為多個轉譯的工作。 有關成功完成（事件型別rendition_created）或任何錯誤（事件型別rendition_failed）的通知會傳送至事件日誌，必須先使用/register一次擷取該日誌，然後才能發出任何數量的/process個請求。 格式錯誤的請求會立即失敗，並產生400錯誤代碼。

使用URL來參考二進位檔案，例如Amazon AWS S3預先簽署的URL或Azure Blob儲存SAS URL。 用於讀取source資產(GET URL)和寫入轉譯(PUT URL)。 使用者端負責產生這些預先簽署的URL。

處理請求JSON process-request-json

/process的請求本文是具有此高階結構描述的JSON物件：

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

可用的欄位包括：

source可以是視為URL的<string>，或可以是具有額外欄位的<object>。 下列變體類似：

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

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

Source物件欄位 source-object-fields

完整的process要求範例 complete-process-request-example

{
    "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-response

根據基本要求驗證，/process要求會立即傳回成功或失敗。 實際資產處理為非同步進行。

狀態碼：

大部分使用者端可能會在任何錯誤​ 上以指數回退重試相同要求，但 ​設定問題（例如401或403）或無效要求（例如400）除外。 除了429回應方式的定期速率限制以外，暫時性的服務中斷或限制可能會導致5xx錯誤。 之後，建議您在一段時間後重試。

所有JSON回應（如果存在）都包含requestId，其值與X-Request-Id標頭相同。 Adobe建議從標頭讀取，因為它一律存在。 requestId也會在與處理要求相關的所有事件中傳回為requestId。 使用者端不得對此字串的格式做任何假設。 這是不透明的字串識別碼。

選擇加入後續處理 opt-in-to-post-processing

Asset Compute SDK支援一組基本的影像後處理選項。 自訂背景工作可透過將轉譯物件上的欄位postProcess設定為true，明確選擇加入後續處理。

支援的使用案例包括：

浮水印資產 add-watermark

Asset Compute SDK支援在PNG、JPEG、TIFF和GIF影像檔案中新增浮水印。 依照轉譯上watermark物件中的轉譯指示新增浮水印。

浮水印會在轉譯後期處理期間完成。 若要為資產加上浮水印，自訂背景工作將轉譯物件上的欄位postProcess設定為true，選擇進行後處理。 如果背景工作未選擇加入，則不會套用浮水印，即使浮水印物件已設定在請求中的轉譯物件上。

轉譯指示 rendition-instructions

下列是/process中renditions陣列的可用選項。

常用欄位 common-fields

轉譯特定欄位 rendition-specific-fields

如需目前支援的檔案格式清單，請參閱支援的檔案格式。

浮水印特定欄位 watermark-specific-fields

PNG格式會作為浮水印使用。

非同步事件 asynchronous-events

處理轉譯完成或發生錯誤時，會傳送事件至AdobeI/O Events Journal。 使用者端必須接聽透過/register提供的日誌URL。 日誌回應包含event陣列，每個事件包含一個物件，其中event欄位包含實際事件裝載。

Asset Compute Service之所有Adobe的I/O Events型別是asset_compute。 分錄僅自動訂閱此事件型別，不需要根據Adobe Developer事件型別進一步篩選。 服務特定事件型別可在事件的type屬性中使用。

事件型別 event-types

事件屬性 event-attributes

中繼資料 metadata

錯誤原因 error-reasons