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

O uso da API é limitado a fins de desenvolvimento. A API é fornecida como um contexto ao desenvolver aplicativos personalizados. Adobe Experience Manager como Cloud Service usa a API para transmitir as informações de processamento para um aplicativo personalizado. Para obter mais informações, consulte Usar microsserviços de ativos e Perfis de processamento.

Qualquer cliente da API HTTP Asset Compute Service deve seguir este fluxo de alto nível:

O módulo adobe-asset-compute-client facilita o uso da API no código Node.js.

Autenticação e autorização authentication-and-authorization

Todas as APIs exigem autenticação de token de acesso. As solicitações devem definir os seguintes cabeçalhos:

Escopos scopes

Verifique os seguintes escopos para o token de acesso:

Esses escopos exigem que o projeto Adobe Developer Console seja inscrito nos serviços Asset Compute, I/O Events e I/O Management API. O detalhamento de escopos individuais é:

Registro register

Cada cliente do Asset Compute service - um projeto Adobe Developer Console exclusivo que assinou o serviço - deve se registrar antes de fazer solicitações de processamento. A etapa de registro retorna o diário de eventos exclusivo necessário para recuperar os eventos assíncronos do processamento de representação.

No final de seu ciclo de vida, um cliente pode cancelar o registro.

Registrar solicitação register-request

Esta chamada de API configura um cliente Asset Compute e fornece a URL do diário de eventos. Esse processo é uma operação idempotente e só precisa ser chamado uma vez para cada cliente. Ele pode ser chamado novamente para recuperar o URL do diário.

Registrar resposta register-response

Os códigos de status HTTP são:

Cancelar registro da solicitação unregister-request

Esta chamada de API cancela o registro de um cliente Asset Compute. Após esse cancelamento de registro, não será mais possível chamar /process. O uso da chamada de API para um cliente não registrado ou para um cliente a ser registrado retorna um erro 404.

Cancelar registro da resposta unregister-response

Os códigos de status são:

Processar solicitação process-request

A operação process envia um trabalho que transforma um ativo de origem em várias representações, com base nas instruções na solicitação. Notificações sobre conclusão bem-sucedida (tipo de evento rendition_created) ou quaisquer erros (tipo de evento rendition_failed) são enviadas a um diário de Eventos que deve ser recuperado usando /register uma vez antes de fazer qualquer número de /process solicitações. Solicitações formadas incorretamente falham imediatamente com um código de erro 400.

Os binários são referenciados usando URLs, como URLs pré-assinados do Amazon AWS S3 ou URLs SAS do Armazenamento Azure Blob. Usado para ler o ativo source (GET URLs) e gravar as representações (PUT URLs). O cliente é responsável por gerar esses URLs pré-assinados.

Processar solicitação JSON process-request-json

O corpo da solicitação de /process é um objeto JSON com este esquema de alto nível:

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

Os campos disponíveis são:

O source pode ser um <string> que é visto como uma URL ou pode ser um <object> com um campo adicional. As seguintes variantes são semelhantes:

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

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

Campos de objeto do Source source-object-fields

Um exemplo completo de solicitação 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"
    }]
}

Processar resposta process-response

A solicitação /process retorna imediatamente com êxito ou falha com base na validação básica da solicitação. O processamento de ativos real ocorre de forma assíncrona.

Códigos de status:

Provavelmente, a maioria dos clientes está inclinada a repetir a mesma solicitação com retirada exponencial em qualquer erro exceto, problemas de configuração como 401 ou 403 ou solicitações inválidas como 400. Além da limitação de taxa regular por meio de respostas 429, uma interrupção ou limitação temporária de serviço pode resultar em erros 5xx. Em seguida, seria aconselhável tentar novamente após um período.

Todas as respostas JSON (se presentes) incluem o requestId, que é o mesmo valor que o cabeçalho X-Request-Id. O Adobe recomenda a leitura do cabeçalho, pois ele está sempre presente. O requestId também é retornado em todos os eventos relacionados às solicitações de processamento como requestId. Os clientes não devem fazer nenhuma suposição sobre o formato dessa cadeia de caracteres. É um identificador de sequência de caracteres opaco.

Aceitar o pós-processamento opt-in-to-post-processing

O SDK do Asset Compute dá suporte a um conjunto de opções básicas de pós-processamento de imagem. Os trabalhadores personalizados podem aceitar explicitamente o pós-processamento definindo o campo postProcess no objeto de representação como true.

Os casos de uso compatíveis são:

Inserir marca d'água em ativos add-watermark

O SDK do Asset compute oferece suporte à adição de uma marca d'água aos arquivos de imagem PNG, JPEG, TIFF e GIF. A marca d'água é adicionada seguindo as instruções de representação no objeto watermark na representação.

A marca d'água é feita durante o pós-processamento da representação. Para adicionar ativos de marca d'água, o trabalhador personalizado opta pelo pós-processamento definindo o campo postProcess no objeto de representação como true. Se o trabalhador não aceitar, a marca d'água não será aplicada, mesmo se o objeto de marca d'água estiver definido no objeto de representação na solicitação.

Instruções de representação rendition-instructions

Estas são as opções disponíveis para a matriz renditions em /process.

Campos comuns common-fields

Campos específicos da representação rendition-specific-fields

Para obter uma lista de formatos de arquivo com suporte no momento, consulte formatos de arquivo com suporte.

Campos específicos de marca d'água watermark-specific-fields

O formato PNG é usado como marca d'água.

Eventos assíncronos asynchronous-events

Quando o processamento de uma representação for concluído ou quando ocorrer um erro, um evento será enviado para um Adobe I/O Events Journal. Os clientes devem escutar a URL do diário fornecida por meio de /register. A resposta do diário inclui uma matriz event que consiste em um objeto para cada evento, do qual o campo event inclui a carga do evento real.

O tipo de Adobe I/O Events para todos os eventos de Asset Compute Service é asset_compute. O diário é inscrito automaticamente apenas neste tipo de evento e não há mais nenhum requisito para filtrar com base no tipo de Evento Adobe Developer. Os tipos de evento específicos do serviço estão disponíveis na propriedade type do evento.

Tipos de evento event-types

Atributos do evento event-attributes

Metadados metadata

Motivos de erro error-reasons