Asset Compute Service API HTTP 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 utiliza la API para pasar la información de procesamiento a una aplicación personalizada. Para obtener más información, consulte Uso de microservicios de recursos y perfiles de procesamiento.

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

El @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 requieren el Adobe Developer Console proyecto al que se va a suscribir Asset Compute, I/O Events, y I/O Management API servicios. El desglose de ámbitos individuales es el siguiente:

Registro register

Cada cliente del Asset Compute service - un único Adobe Developer Console proyecto suscrito al servicio: debe registrar antes de realizar solicitudes de procesamiento. El paso de registro devuelve el diario de evento único que es necesario para recuperar los eventos asincrónicos del procesamiento de 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 Asset Compute y proporciona la URL del diario de eventos. 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 Asset Compute cliente. Después de esto 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 404 error.

Anular registro de respuesta unregister-response

Los códigos de estado son:

Procesar solicitud process-request

El process Esta operación envía un trabajo que transforma un recurso de origen en varias representaciones, según las instrucciones de la solicitud. Notificaciones sobre 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, para que los dos lean source recurso (GET URL) y escribir las representaciones (PUT 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:

El source puede ser un <string> que se ve 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 del objeto de origen source-object-fields

Una completa process ejemplo de solicitud 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

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

Códigos de estado:

La mayoría de los clientes tienden a reintentar exactamente la misma solicitud con retroceso exponencial sobre 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 a través de 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 de JSON (si están presentes) incluyen las siguientes requestId que es el mismo valor que el X-Request-Id encabezado. Se recomienda leer desde el encabezado, ya que 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 dar por hecho el formato de esta cadena, ya que es un identificador de cadena opaco.

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

El ASSET COMPUTE SDK admite un conjunto de opciones básicas de posprocesamiento de imágenes. Los trabajadores personalizados pueden incluirse explícitamente en el posprocesamiento configurando el campo postProcess en el objeto de representación a true.

Los casos de uso admitidos son:

Recursos de marca de agua add-watermark

El ASSET COMPUTE SDK admite agregar 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 de la watermark en la representación.

La marca de agua se realiza durante el procesamiento posterior de la representación. Para crear marcas de agua en los recursos, el trabajador personalizado opta por el posprocesamiento estableciendo el campo postProcess en el objeto de representación a true. Si el trabajador no realiza la inclusión, la marca de agua no se aplica, aunque el objeto de marca de agua esté establecido en el objeto de representación de la solicitud.

Instrucciones de representación rendition-instructions

Estas son las opciones disponibles para renditions matriz 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 compatibles.

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

El formato PNG se utiliza como marca de agua.

Eventos asíncronos asynchronous-events

Una vez finalizado el procesamiento de una representación o cuando se produce un error, se envía un evento a un Adobe I/O Diario de eventos. Los clientes deben escuchar la URL del diario proporcionada mediante /register. La respuesta del diario incluye un event matriz que consta de un objeto para cada evento, del cual el event incluye la carga útil del evento real.

El Adobe I/O Tipo de evento para todos los eventos del Asset Compute Service es asset_compute. El historial solo se suscribe automáticamente a este tipo de evento y no hay ningún requisito adicional de filtrar según el Adobe I/O Tipo de evento. Los tipos de eventos específicos del servicio están disponibles en la variable type propiedad del evento.

Tipos de eventos event-types

Atributos de evento event-attributes

Metadatos metadata

Motivos del error error-reasons