Assets API HTTP

Visão geral

A API HTTP Assets permite operações de criação-leitura-atualização-exclusão (CRUD) em ativos digitais, incluindo metadados, renderizações e comentários, juntamente com conteúdo estruturado usando Experience Manager Fragmentos de conteúdo. Ele é exposto em /api/assets e é implementado como REST API. Inclui suporte para Fragmentos de conteúdo.

Para acessar a API:

1. Abra o documento de serviço da API em https://[hostname]:[port]/api.json.
2. Siga o link de serviço Assets que leva a https://[hostname]:[server]/api/assets.json.

A resposta da API é um arquivo JSON para alguns tipos MIME e um código de resposta para todos os tipos MIME. A resposta JSON é opcional e pode não estar disponível, por exemplo, para arquivos PDF. Confie no código de resposta para obter mais análises ou ações.

Depois do Tempo desligado, um ativo e suas representações não estão disponíveis por meio da interface da Web Assets e por meio da API HTTP. A API retornará uma mensagem de erro 404 se On Time estiver no futuro ou Off Time estiver no passado.

Fragmentos de conteúdo

Um fragmento de conteúdo é um tipo especial de ativo. Pode ser usado para acessar dados estruturados, como textos, números, datas, entre outros. Como há várias diferenças nos ativos standard (como imagens ou documentos), algumas regras adicionais se aplicam ao manuseio de fragmentos de conteúdo.

Para obter mais informações, consulte Suporte a fragmentos de conteúdo na API HTTP do Experience Manager Assets.

Modelo de dados

A API HTTP Assets expõe dois elementos principais, pastas e ativos (para ativos padrão).

Além disso, expõe elementos mais detalhados para os modelos de dados personalizados que descrevem o conteúdo estruturado em Fragmentos de conteúdo. Consulte Modelos de dados do fragmento de conteúdo para obter mais informações.

Pastas

As pastas são como diretórios em sistemas de arquivos tradicionais. São container para outras pastas ou asserções. As pastas têm os seguintes componentes:

Entidades: As entidades de uma pasta são seus elementos filho, que podem ser pastas e ativos.

Propriedades:

• name é o nome da pasta. É o mesmo que o último segmento no caminho do URL sem a extensão.
• title é um título opcional da pasta que pode ser exibido em vez de seu nome.

​​LinksFolders expõe três links:

• self: Vincule-se a si mesmo.
• parent: Link para a pasta pai.
• thumbnail: (Opcional) link para uma imagem em miniatura da pasta.

Assets

No Experience Manager, um ativo contém os seguintes elementos:

• As propriedades e os metadados do ativo.
• Várias representações, como a representação original (que é o ativo carregado originalmente), uma miniatura e várias outras representações. As execuções adicionais podem ser imagens de tamanhos diferentes, codificações de vídeo diferentes ou páginas extraídas de arquivos PDF ou Adobe InDesign.
• Comentários opcionais.

Para obter informações sobre elementos em Fragmentos de conteúdo, consulte Suporte a fragmentos de conteúdo na API HTTP do Experience Manager Assets.

Em Experience Manager uma pasta tem os seguintes componentes:

• Entidades: Os filhos dos ativos são suas representações.
• Propriedades.
• Links.

A API HTTP Assets inclui os seguintes recursos:

• Recuperar uma lista de pastas.
• Criar uma pasta.
• Criar um ativo.
• Atualize o binário do ativo.
• Atualize os metadados do ativo.
• Crie uma representação de ativo.
• Atualizar uma representação de ativo.
• Crie um comentário de ativo.
• Copie uma pasta ou um ativo.
• Mova uma pasta ou um ativo.
• Exclua uma pasta, ativo ou representação.

Pré-requisitos

• Acesso https://[aem_server]:[port]/system/console/configMgr.
• Navegue até Filtro CSRF de Adobe Granite.
• Verifique se a propriedade Métodos de Filtro inclui: POST, PUT, DELETE.

Recuperar uma lista de pastas

Recupera uma representação Siren de uma pasta existente e de suas entidades filhas (subpastas ou ativos).

Solicitação: GET /api/assets/myFolder.json

Códigos de resposta: Os códigos de resposta são:

• 200 - OK - sucesso.
• 404 - NOT FOUND - a pasta não existe ou não está acessível.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Resposta: A classe da entidade retornada é um ativo ou uma pasta. As propriedades de entidades contidas são um subconjunto do conjunto completo de propriedades de cada entidade. Para obter uma representação completa da entidade, os clientes devem recuperar o conteúdo do URL apontado pelo link com um rel de self.

Crie uma pasta

Cria um novo sling: OrderedFolder no caminho especificado. Se um * for fornecido em vez de um nome de nó, o servlet usará o nome do parâmetro como nome de nó. Aceitos como dados de solicitação é uma representação Siren da nova pasta ou um conjunto de pares nome-valor, codificados como application/www-form-urlencoded ou multipart/ form- data, úteis para criar uma pasta diretamente de um formulário HTML. Além disso, as propriedades da pasta podem ser especificadas como parâmetros de query de URL.

Uma chamada de API falha com um código de resposta 500 se o nó pai do caminho fornecido não existir. Uma chamada retornará um código de resposta 409 se a pasta já existir.

Parâmetros: name é o nome da pasta.

Solicitar

• POST /api/assets/myFolder -H"Content-Type: application/json" -d '{"class":"assetFolder","properties":{"title":"My Folder"}}'
• POST /api/assets/* -F"name=myfolder" -F"title=My Folder"

Códigos de resposta: Os códigos de resposta são:

• 201 - CRIADO - sobre criação bem sucedida.
• 409 - CONFLICT - se a pasta já existir.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Criar um ativo

Coloque o arquivo fornecido no caminho fornecido para criar um ativo no repositório DAM. Se um * for fornecido em vez de um nome de nó, o servlet usará o nome do parâmetro ou o nome do arquivo como nome do nó.

Parâmetros: Os parâmetros são name para o nome do ativo e file para a referência do arquivo.

Solicitar

• POST /api/assets/myFolder/myAsset.png -H"Content-Type: image/png" --data-binary "@myPicture.png"
• POST /api/assets/myFolder/* -F"name=myAsset.png" -F"file=@myPicture.png"

Códigos de resposta: Os códigos de resposta são:

• 201 - CRIADO - se o Ativo tiver sido criado com êxito.
• 409 - CONFLITO - se o Ativo já existir.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Atualizar um binário de ativo

Atualiza o binário de um ativo (execução com o nome original). Uma atualização aciona o fluxo de trabalho de processamento de ativos padrão para ser executado, se estiver configurado.

Solicitação: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: image/png" --data-binary @myPicture.png

Códigos de resposta: Os códigos de resposta são:

• 200 - OK - se Asset (Ativo) tiver sido atualizado com êxito.
• 404 - NÃO ENCONTRADO - se o Ativo não puder ser encontrado ou acessado no URI fornecido.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Atualizar metadados do ativo

Atualiza as propriedades de metadados do ativo. Se você atualizar qualquer propriedade na namespace dc:, a API atualizará a mesma propriedade na namespace jcr. A API não sincroniza as propriedades nas duas namespaces.

Solicitação: PUT /api/assets/myfolder/myAsset.png -H"Content-Type: application/json" -d '{"class":"asset", "properties":{"jcr:title":"My Asset"}}'

Códigos de resposta: Os códigos de resposta são:

• 200 - OK - se Asset (Ativo) tiver sido atualizado com êxito.
• 404 - NÃO ENCONTRADO - se o Ativo não puder ser encontrado ou acessado no URI fornecido.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Sincronizar atualização de metadados entre a namespace dc e jcr

O método da API atualiza as propriedades de metadados na namespace jcr. As atualizações feitas usando a interface do usuário alteram as propriedades de metadados na namespace dc. Para sincronizar os valores de metadados entre as namespaces dc e jcr, é possível criar um fluxo de trabalho e configurar o Experience Manager para executar o fluxo de trabalho após a edição do ativo. Use um script ECMA para sincronizar as propriedades de metadados necessárias. O script de amostra a seguir sincroniza a string de título entre dc:title e jcr:title.

var workflowData = workItem.getWorkflowData();
if (workflowData.getPayloadType() == "JCR_PATH")
{
 var path = workflowData.getPayload().toString();
 var node = workflowSession.getSession().getItem(path);
 var metadataNode = node.getNode("jcr:content/metadata");
 var jcrcontentNode = node.getNode("jcr:content");
if (jcrcontentNode.hasProperty("jcr:title"))
{
 var jcrTitle = jcrcontentNode.getProperty("jcr:title");
 metadataNode.setProperty("dc:title", jcrTitle.toString());
 metadataNode.save();
}
}

Criar uma representação de ativo

Crie uma nova representação de ativo para um ativo. Se o nome do parâmetro de solicitação não for fornecido, o nome do arquivo será usado como nome de execução.

Parâmetros: Os parâmetros são name para o nome da representação e file como uma referência de arquivo.

Solicitar

• POST /api/assets/myfolder/myasset.png/renditions/web-rendition -H"Content-Type: image/png" --data-binary "@myRendition.png"
• POST /api/assets/myfolder/myasset.png/renditions/* -F"name=web-rendition" -F"file=@myRendition.png"

Códigos de resposta: Os códigos de resposta são:

• 201 - CREATED - se a Renderização tiver sido criada com êxito.
• 404 - NÃO ENCONTRADO - se o Ativo não puder ser encontrado ou acessado no URI fornecido.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Atualizar uma representação de ativo

As atualizações substituem respectivamente uma representação de ativo pelos novos dados binários.

Solicitação: PUT /api/assets/myfolder/myasset.png/renditions/myRendition.png -H"Content-Type: image/png" --data-binary @myRendition.png

Códigos de resposta: Os códigos de resposta são:

• 200 - OK - se Renderização tiver sido atualizada com êxito.
• 404 - NÃO ENCONTRADO - se o Ativo não puder ser encontrado ou acessado no URI fornecido.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Adicionar um comentário em um ativo

Cria um novo comentário de ativo.

Parâmetros: Os parâmetros são message para o corpo da mensagem do comentário e annotationData para os dados de anotação no formato JSON.

Solicitação: POST /api/assets/myfolder/myasset.png/comments/* -F"message=Hello World." -F"annotationData={}"

Códigos de resposta: Os códigos de resposta são:

• 201 - CRIADO - se Comentário tiver sido criado com êxito.
• 404 - NÃO ENCONTRADO - se o Ativo não puder ser encontrado ou acessado no URI fornecido.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Copiar uma pasta ou um ativo

Copia uma pasta ou ativo disponível no caminho fornecido para um novo destino.

Cabeçalhos de solicitação: Os parâmetros são:

• X-Destination - um novo URI de destino dentro do escopo da solução de API para copiar o recurso.
• X-Depth - quer infinity quer 0. Usar 0 copia somente o recurso e suas propriedades, e não seus filhos.
• X-Overwrite - Use F para evitar a substituição de um ativo no destino existente.

Solicitação: COPY /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-copy"

Códigos de resposta: Os códigos de resposta são:

• 201 - CRIADO - se a pasta/ativo tiver sido copiado para um destino não existente.
• 204 - SEM CONTEÚDO - se a pasta/ativo tiver sido copiado para um destino existente.
• 412 - PRECONDITION FAILED - se um cabeçalho de solicitação estiver ausente.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Mover uma pasta ou um ativo

Move uma pasta ou um ativo no caminho fornecido para um novo destino.

Cabeçalhos de solicitação: Os parâmetros são:

• X-Destination - um novo URI de destino dentro do escopo da solução de API para copiar o recurso.
• X-Depth - quer infinity quer 0. Usar 0 copia somente o recurso e suas propriedades, e não seus filhos.
• X-Overwrite - Use T para forçar a exclusão de um recurso existente ou F para evitar a substituição de um recurso existente.

Solicitação: MOVE /api/assets/myFolder -H"X-Destination: /api/assets/myFolder-moved"

Não use /content/dam no URL. Um comando de exemplo para mover ativos e substituir ativos existentes é:

curl -u admin:admin -X MOVE https://[aem_server]:[port]/api/assets/source/file.png -H "X-Destination: http://[aem_server]:[port]/api/assets/destination/file.png" -H "X-Overwrite: T"

Códigos de resposta: Os códigos de resposta são:

• 201 - CRIADO - se a pasta/ativo tiver sido copiado para um destino não existente.
• 204 - SEM CONTEÚDO - se a pasta/ativo tiver sido copiado para um destino existente.
• 412 - PRECONDITION FAILED - se um cabeçalho de solicitação estiver ausente.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Excluir uma pasta, um ativo ou uma representação

Exclui um recurso (-tree) no caminho fornecido.

Solicitar

• DELETE /api/assets/myFolder
• DELETE /api/assets/myFolder/myAsset.png
• DELETE /api/assets/myFolder/myAsset.png/renditions/original

Códigos de resposta: Os códigos de resposta são:

• 200 - OK - se a pasta tiver sido excluída com êxito.
• 412 - PRECONDITION FAILED - se a coleção raiz não puder ser encontrada ou acessada.
• 500 - ERRO DE SERVIDOR INTERNO - se algo der errado.

Dicas e limitações

• A API HTTP atualiza as propriedades de metadados na jcr namespace. No entanto, a interface do usuário do Experience Manager atualiza as propriedades de metadados na namespace dc.

• A API de ativos não retorna os metadados completos. Na API, as namespaces são codificadas e só são retornadas. Se você precisar de metadados completos, verifique o caminho do ativo /jcr_content/metadata.json.