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

确保访问令牌的以下范围：

这些需要 Adobe Developer Console 要订阅的项目 Asset Compute， I/O Events、和 I/O Management API 服务。 各个范围的划分如下：

注册 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 Storage SAS URL，两者均读取 source 资源(GET URL)和写入演绎版(PUT URL)。 客户端负责生成这些预签名的URL。

处理请求JSON process-request-json

的请求正文 /process 是一个具有此高级模式的JSON对象：

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

可用字段包括：

此 source 可以是 <string> 该URL可以是 <object> 带有一个附加字段。 以下变量类似：

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

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

源对象字段 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 标头。 建议从标头读取，因为它始终存在。 此 requestId 也会在与处理请求相关的所有事件中作为 requestId. 客户端不得对此字符串的格式进行任何假设，它是不透明的字符串标识符。

选择加入后处理 opt-in-to-post-processing

此 ASSET COMPUTESDK 支持一组基本的图像后处理选项。 自定义工作程序可以通过设置字段来明确选择启用后处理 postProcess 将节目对象设置为 true.

支持的用例包括：

为资源添加水印 add-watermark

此 ASSET COMPUTESDK 支持向PNG、JPEG、TIFF和GIF图像文件添加水印。 水印将按照演绎版中的说明添加 watermark 呈现版本上的对象。

水印在演绎版后处理期间完成。 要对资产添加水印，自定义工作程序 选择进行后处理 通过设置字段 postProcess 将节目对象设置为 true. 如果辅助进程不选择加入，则不会应用水印，即使对请求中的演绎版对象设置了水印对象也是如此。

节目说明 rendition-instructions

这些选项适用于 renditions 数组 /process.

常用字段 common-fields

节目特定字段 rendition-specific-fields

有关当前支持的文件格式的列表，请参阅 支持的文件格式.

特定于水印的字段 watermark-specific-fields

PNG格式用作水印。

异步事件 asynchronous-events

处理完节目或发生错误后，会将事件发送到 Adobe I/O 事件日志. 客户端必须侦听通过提供的日志URL /register. 日志响应包括 event 数组，每个事件由一个对象组成，其中 event 字段包含实际事件有效负载。

此 Adobe I/O 的所有事件的事件类型 Asset Compute Service 是 asset_compute. 日志仅自动订阅此事件类型，无需根据 Adobe I/O 事件类型。 特定于服务的事件类型请参见 type 事件的属性。

事件类型 event-types

事件属性 event-attributes

元数据 metadata

错误原因 error-reasons