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

API的使用仅限于开发目的。 API在开发自定义应用程序时作为上下文提供。 Adobe Experience Manager作为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）的通知将发送到事件日志，该日志必须在发出任意数量的/process请求之前使用/register检索一次。 格式不正确的请求立即失败，并显示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可以是视为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 computeSDK支持一组基本的图像后处理选项。 自定义工作进程可以通过将节目对象上的字段postProcess设置为true来显式选择加入后处理。

支持的用例包括：

为资源添加水印 add-watermark

Asset computeSDK支持向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的所有事件的AdobeI/O Events类型为asset_compute。 日志仅自动订阅此事件类型，无需根据Adobe Developer事件类型进行筛选。 服务特定的事件类型在事件的type属性中可用。

事件类型 event-types

事件属性 event-attributes

元数据 metadata

错误原因 error-reasons