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

El uso de la API se limita a fines de desarrollo. La API se proporciona como contexto al desarrollar aplicaciones personalizadas. Adobe Experience Manager as a Cloud Service usa la API para pasar la información de procesamiento a una aplicación personalizada. Para obtener más información, consulte Usar microservicios de recursos y Perfiles de procesamiento.

Cualquier cliente de la API HTTP Asset Compute Service debe seguir este flujo de alto nivel:

El módulo adobe-asset-compute-client facilita el uso de la API en el código de Node.js.

Autenticación y autorización authentication-and-authorization

Todas las API requieren autenticación de token de acceso. Las solicitudes deben establecer los siguientes encabezados:

Ámbitos scopes

Asegúrese de que los siguientes ámbitos sean válidos para el token de acceso:

Estos ámbitos requieren que el proyecto Adobe Developer Console se suscriba a los servicios Asset Compute, I/O Events y I/O Management API. El desglose de ámbitos individuales es el siguiente:

Registro register

Cada cliente de Asset Compute service (un proyecto único de Adobe Developer Console suscrito al servicio) debe registrarse antes de realizar solicitudes de procesamiento. El paso de registro devuelve el diario de eventos único necesario para recuperar los eventos asincrónicos del procesamiento de la representación.

Al final de su ciclo de vida, un cliente puede anular el registro.

Solicitud de registro register-request

Esta llamada de API configura un cliente Asset Compute y proporciona la dirección URL del diario de eventos. Este proceso es una operación idempotente y solo necesita llamarse una vez para cada cliente. Se puede volver a llamar para recuperar la dirección URL del historial.

Registrar respuesta register-response

Los códigos de estado HTTP son:

Solicitud de cancelación de registro unregister-request

Esta llamada de API anula el registro de un cliente Asset Compute. Una vez cancelado el registro, ya no es posible llamar a /process. El uso de la llamada de API para un cliente no registrado o un cliente aún no registrado devuelve un error 404.

Anular registro de respuesta unregister-response

Los códigos de estado son:

Procesar solicitud process-request

La operación process envía un trabajo que transforma un recurso de origen en varias representaciones, según las instrucciones de la solicitud. Las notificaciones sobre la finalización correcta (tipo de evento rendition_created) o cualquier error (tipo de evento rendition_failed) se envían a un diario de eventos que debe recuperarse mediante /register una vez antes de realizar cualquier número de /process solicitudes. Las solicitudes formadas incorrectamente generan un error 400.

Se hace referencia a los binarios mediante direcciones URL, como URL prefirmadas de Amazon AWS S3 o URL de SAS de almacenamiento de Azure Blob. Se usa tanto para leer el recurso source (GET direcciones URL) como para escribir las representaciones (PUT direcciones URL). El cliente es responsable de generar estas direcciones URL prefirmadas.

Solicitud de proceso JSON process-request-json

El cuerpo de la solicitud de /process es un objeto JSON con este esquema de alto nivel:

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

Los campos disponibles son:

source puede ser un <string> que se vea como una dirección URL o puede ser un <object> con un campo adicional. Las siguientes variantes son similares:

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

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

Campos de objeto de Source source-object-fields

Un ejemplo de solicitud process completa 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"
    }]
}

Respuesta del proceso process-response

La solicitud /process se devuelve inmediatamente con un resultado correcto o erróneo según la validación básica de la solicitud. El procesamiento real de recursos se produce de forma asíncrona.

Códigos de estado:

Es probable que la mayoría de los clientes prefieran reintentar la misma solicitud con retroceso exponencial en cualquier error excepto problemas de configuración como 401 o 403, o solicitudes no válidas como 400. Aparte de la limitación regular de la velocidad mediante respuestas 429, una interrupción temporal del servicio o una limitación podría provocar errores 5xx. Entonces, sería aconsejable volver a intentarlo después de un periodo de tiempo.

Todas las respuestas JSON (si están presentes) incluyen requestId, que es el mismo valor que el encabezado X-Request-Id. El Adobe recomienda leer del encabezado porque siempre está presente. El requestId también se devuelve en todos los eventos relacionados con el procesamiento de solicitudes como requestId. Los clientes no deben suponer el formato de esta cadena. Es un identificador de cadena opaco.

Inclusión en el posprocesamiento opt-in-to-post-processing

El SDK de Asset compute admite un conjunto de opciones básicas de procesamiento posterior de imágenes. Los trabajadores personalizados pueden incluirse explícitamente en el posprocesamiento estableciendo el campo postProcess en el objeto de representación en true.

Los casos de uso admitidos son:

Recursos de marca de agua add-watermark

El SDK de Asset compute admite la adición de una marca de agua a los archivos de imagen PNG, JPEG, TIFF y GIF. La marca de agua se agrega siguiendo las instrucciones de representación del objeto watermark de la representación.

La marca de agua se realiza durante el procesamiento posterior de la representación. Para marcar los recursos, el trabajador personalizado opta por el posprocesamiento al establecer el campo postProcess en el objeto de representación en true. Si el trabajador no selecciona, la marca de agua no se aplica, incluso si el objeto de marca de agua está establecido en el objeto de representación de la solicitud.

Instrucciones de representación rendition-instructions

Las siguientes son las opciones disponibles para la matriz renditions en /process.

Campos comunes common-fields

Campos específicos de representación rendition-specific-fields

Para obtener una lista de los formatos de archivo admitidos actualmente, consulte formatos de archivo admitidos.

Campos específicos de marcas de agua watermark-specific-fields

El formato PNG se utiliza como marca de agua.

Eventos asíncronos asynchronous-events

Cuando finaliza el procesamiento de una representación o se produce un error, se envía un evento a un Adobe I/O Events Journal. Los clientes deben escuchar la dirección URL del diario proporcionada a través de /register. La respuesta del diario incluye una matriz event que consta de un objeto para cada evento, de los cuales el campo event incluye la carga útil del evento real.

El tipo de Adobe I/O Events para todos los eventos de Asset Compute Service es asset_compute. El historial solo se suscribe automáticamente a este tipo de evento y no se requiere ningún otro filtro basado en el tipo de evento Adobe Developer. Los tipos de eventos específicos del servicio están disponibles en la propiedad type del evento.

Tipos de eventos event-types

Atributos de evento event-attributes

Metadatos metadata

Motivos de error error-reasons