Suporte a Fragmentos de conteúdo na API HTTP do AEM Assets

Visão geral

Saiba mais sobre o suporte para Fragmentos de conteúdo na API HTTP do Assets, uma parte importante AEM recurso de entrega sem cabeçalho.

OBSERVAÇÃO

A API HTTP de ativos abrange:

  • API REST de ativos
  • incluindo suporte para Fragmentos de conteúdo

A implementação atual da API HTTP de ativos é baseada no estilo arquitetônico REST.

A API REST do Assets permite que os desenvolvedores do Adobe Experience Manager como um Cloud Service acessem o conteúdo (armazenado em AEM) diretamente sobre a API HTTP, por meio de operações CRUD (Criar, Ler, Atualizar, Excluir).

A API permite operar o Adobe Experience Manager as a Cloud Service como um CMS (Content Management System) sem periféricos fornecendo serviços de conteúdo a um aplicativo front-end JavaScript. Ou qualquer outro aplicativo que possa executar solicitações HTTP e manipular respostas JSON.

Por exemplo, Aplicativos de página única (SPA), baseados em estrutura ou personalizados, exigem conteúdo fornecido através da API HTTP, geralmente no formato JSON.

Embora AEM Componentes principais ofereça uma API muito abrangente, flexível e personalizável que possa servir as operações de Leitura necessárias para essa finalidade e cuja saída JSON possa ser personalizada, eles exigem AEM know-how WCM (Gerenciamento de conteúdo da Web) para implementação, pois devem ser hospedados em páginas que se baseiam em modelos de AEM dedicados. Nem todas as organizações SPA de desenvolvimento têm acesso direto a esses conhecimentos.

É quando a API REST do Assets pode ser usada. Ela permite que os desenvolvedores acessem ativos (por exemplo, imagens e fragmentos de conteúdo) diretamente, sem a necessidade de primeiro incorporá-los a uma página e entregar seu conteúdo em formato JSON serializado.

OBSERVAÇÃO

Não é possível personalizar a saída JSON da API REST de ativos.

A API REST de ativos também permite que os desenvolvedores modifiquem o conteúdo, criando ativos novos, atualizados ou excluindo ativos, fragmentos de conteúdo e pastas existentes.

A API REST de ativos:

Pré-requisitos

A API REST de ativos está disponível em cada instalação pronta para uso de uma versão recente do Adobe Experience Manager as a Cloud Service.

Principais conceitos

A API REST de ativos oferece acesso ao estilo REST para ativos armazenados em uma instância de AEM.

Ele usa o terminal /api/assets e requer o caminho do ativo para acessá-lo (sem o /content/dam à esquerda).

  • Isso significa que para acessar o ativo em:
    • /content/dam/path/to/asset
  • Você precisa solicitar:
    • /api/assets/path/to/asset

Por exemplo, para acessar /content/dam/wknd/en/adventures/cycling-tuscany, solicite /api/assets/wknd/en/adventures/cycling-tuscany.json

OBSERVAÇÃO

Acesso ao:

  • /api/assets não precisa do uso do .model seletor.
  • /content/path/to/page ​Não requer o uso do .model seletor.

O método HTTP determina a operação a ser executada:

  • GET - para recuperar uma representação JSON de um ativo ou uma pasta
  • POST - para criar novos ativos ou pastas
  • PUT - para atualizar as propriedades de um ativo ou pasta
  • DELETE - para excluir um ativo ou uma pasta
OBSERVAÇÃO

O corpo da solicitação e/ou os parâmetros de URL podem ser usados para configurar algumas dessas operações; por exemplo, defina que uma pasta ou um ativo deve ser criado por uma solicitação POST.

O formato exato das solicitações compatíveis é definido na documentação de API Reference.

Comportamento transacional

Todas as solicitações são atômicas.

Isso significa que as solicitações subsequentes (write) não podem ser combinadas em uma única transação que pode ter êxito ou falhar como uma única entidade.

AEM (Ativos) REST API versus AEM Componentes

Aspecto API REST de ativos
Componente AEM
(componentes que usam Modelos Sling)
Casos de uso suportados Finalidade geral.

Otimizado para consumo em um Aplicativo de página única (SPA), ou qualquer outro contexto (que consome conteúdo).

Também pode conter informações de layout.

Operações suportadas

Criar, Ler, Atualizar, Excluir.

Com operações adicionais, dependendo do tipo de entidade.

Somente leitura.
Acesso

Pode ser acessado diretamente.

Usa o ponto de extremidade /api/assets mapeado para /content/dam (no repositório).

Um caminho de exemplo seria: /api/assets/wknd/en/adventures/cycling-tuscany.json

Precisa ser referenciado por meio de um componente de AEM em uma página de AEM.

Usa o seletor .model para criar a representação JSON.

Um caminho de exemplo seria:
/content/wknd/language-masters/en/adventures/cycling-tuscany.model.json

Segurança

Várias opções são possíveis.

O OAuth é proposto; pode ser configurado separadamente da configuração padrão.

Usa AEM configuração padrão.
Observações arquitetônicas

O acesso de gravação normalmente endereçará uma instância de autor.

A leitura também pode ser direcionada a uma instância de publicação.

Como essa abordagem é somente leitura, ela normalmente será usada para instâncias de publicação.
Saída Saída SIREN baseada em JSON: verboso, mas poderoso. Permite navegar dentro do conteúdo. Saída proprietária baseada em JSON; configurável por meio de Modelos do Sling. É difícil implementar a navegação na estrutura de conteúdo (mas não é necessariamente impossível).

Segurança

Se a API REST do Assets for usada em um ambiente sem requisitos de autenticação específicos, AEM filtro CORS precisará ser configurado corretamente.

OBSERVAÇÃO

Para obter mais informações, consulte:

Em ambientes com requisitos de autenticação específicos, o OAuth é recomendado.

Recursos disponíveis

Fragmentos de conteúdo são um tipo específico de ativo, consulte Trabalhar com fragmentos de conteúdo.

Para obter mais informações sobre recursos disponíveis por meio da API, consulte:

Paginação

A API REST de ativos suporta paginação (para solicitações do GET) por meio dos parâmetros de URL:

  • offset - o número da primeira entidade (filho) a recuperar
  • limit - o número máximo de entidades devolvidas

A resposta conterá informações de paginação como parte da seção properties da saída SIREN. Esta propriedade srn:paging contém o número total de entidades (filho) ( total), o deslocamento e o limite ( offset, limit) conforme especificado na solicitação.

OBSERVAÇÃO

A paginação normalmente é aplicada em entidades de contêiner (ou seja, pastas ou ativos com representações), pois está relacionada aos filhos da entidade solicitada.

Exemplo: Paginação

GET /api/assets.json?offset=2&limit=3

...
"properties": {
    ...
    "srn:paging": {
        "total": 7,
        "offset": 2,
        "limit": 3
    }
    ...
}
...

Tipos de entidade

Pastas

As pastas atuam como contêineres para ativos e outras pastas. Eles refletem a estrutura do repositório de conteúdo AEM.

A API REST do Assets expõe o acesso às propriedades de uma pasta; por exemplo, seu nome, título etc. Os ativos são expostos como entidades filhas de pastas e subpastas.

OBSERVAÇÃO

Dependendo do tipo de ativo dos ativos e pastas filhos, a lista de entidades filhas já pode conter o conjunto completo de propriedades que define a respectiva entidade filho. Como alternativa, apenas um conjunto reduzido de propriedades pode ser exposto para uma entidade nesta lista de entidades-filho.

Ativos

Se um ativo for solicitado, a resposta retornará seus metadados; como título, nome e outras informações conforme definido pelo respectivo schema de ativos.

Os dados binários de um ativo são expostos como um link SIREN do tipo content.

Os ativos podem ter várias representações. Normalmente, elas são expostas como entidades secundárias, sendo uma exceção uma representação em miniatura, que é exposta como um link do tipo thumbnail ( rel="thumbnail").

Fragmentos de conteúdo

Um fragmento de conteúdo é um tipo especial de ativo. Eles podem ser usados para acessar dados estruturados, como textos, números, datas, entre outros.

Como há várias diferenças nos ativos padrão (como imagens ou áudio), algumas regras adicionais se aplicam ao seu manuseio.

Representação

Fragmentos de conteúdo:

  • Não exponha quaisquer dados binários.

  • Estão completamente contidos na saída JSON (dentro da propriedade properties ).

  • Também são considerados atômicos, ou seja, os elementos e as variações são expostos como parte das propriedades do fragmento vs. como links ou entidades filhas. Isso permite acesso eficiente à carga de um fragmento.

Modelos de conteúdo e fragmentos de conteúdo

Atualmente, os modelos que definem a estrutura de um fragmento de conteúdo não são expostos por meio de uma API HTTP. Portanto, o consumidor precisa saber sobre o modelo de um fragmento (pelo menos um mínimo) - embora a maioria das informações possa ser inferida da carga; como tipos de dados, etc. fazem parte da definição.

Para criar um novo fragmento de conteúdo, o caminho (repositório interno) do modelo deve ser fornecido.

Conteúdo associado

O conteúdo associado não está exposto no momento.

Usar

O uso pode ser diferente dependendo se você está usando um autor ou um ambiente de publicação AEM, juntamente com seu caso de uso específico.

  • É altamente recomendável que a criação seja vinculada a uma instância do autor (e atualmente não há como replicar um fragmento para publicar usando essa API).

  • A entrega é possível de ambos, pois AEM serve o conteúdo solicitado somente no formato JSON.

    • O armazenamento e o delivery de uma instância de autor de AEM devem ser suficientes para aplicativos de biblioteca de mídia por trás do firewall.

    • Para entrega na Web ao vivo, recomenda-se uma instância de publicação de AEM.

CUIDADO

A configuração do dispatcher em instâncias AEM nuvem pode bloquear o acesso a /api.

OBSERVAÇÃO

Para obter mais detalhes, consulte a Referência da API. Especificamente, API do Adobe Experience Manager Assets - Fragmentos de conteúdo.

Leitura/entrega

O uso é via:

GET /{cfParentPath}/{cfName}.json

Por exemplo:

http://<host>/api/assets/wknd/en/adventures/cycling-tuscany.json

A resposta é JSON serializado com o conteúdo estruturado como no fragmento de conteúdo. As referências são fornecidas como URLs de referência.

Dois tipos de operações de leitura são possíveis:

  • Ao ler um fragmento de conteúdo específico por caminho, a representação JSON do fragmento de conteúdo é retornada.
  • Leitura de uma pasta de fragmentos de conteúdo por caminho: isso retorna as representações JSON de todos os fragmentos de conteúdo dentro da pasta.

Criar

O uso é via:

POST /{cfParentPath}/{cfName}

O corpo deve conter uma representação JSON do fragmento de conteúdo a ser criado, incluindo qualquer conteúdo inicial que deve ser definido nos elementos do fragmento de conteúdo. É obrigatório definir a propriedade cq:model e deve apontar para um modelo de fragmento de conteúdo válido. Se isso não for feito, haverá um erro. Também é necessário adicionar um cabeçalho Content-Type que está definido como application/json.

Atualizar

O uso é via

PUT /{cfParentPath}/{cfName}

O corpo deve conter uma representação JSON do que deve ser atualizado para o fragmento de conteúdo especificado.

Pode ser simplesmente o título ou a descrição de um fragmento de conteúdo, um único elemento ou todos os valores e/ou metadados do elemento.

Excluir

O uso é via:

DELETE /{cfParentPath}/{cfName}

Limitações

Existem algumas limitações:

  • No momento, os modelos de fragmento de conteúdo não são compatíveis: eles não podem ser lidos ou criados. Para criar um novo fragmento de conteúdo ou atualizar um fragmento de conteúdo existente, os desenvolvedores precisam saber o caminho correto para o modelo de fragmento de conteúdo. Atualmente, o único método para obter uma visão geral desses itens é por meio da interface do usuário de administração.
  • As referências são ignoradas. Atualmente, não há verificações para determinar se um fragmento de conteúdo existente é referenciado. Portanto, por exemplo, excluir um fragmento de conteúdo pode resultar em problemas em uma página que contenha uma referência para o Fragmento de conteúdo excluído.
  • Tipo de dados JSON A saída da API REST do tipo de dados JSON é atualmente baseada em sequência de caracteres.

Códigos de status e mensagens de erro

Os seguintes códigos de status podem ser vistos nas circunstâncias relevantes:

  • 200 (OK) Retornado quando:

    • solicitando um fragmento de conteúdo por meio de GET
    • atualização bem-sucedida de um fragmento de conteúdo via PUT
  • 201 (Criado) Retornado quando:

    • criação com êxito de um fragmento de conteúdo via POST
  • 404 (Não encontrado) Retornado quando:

    • o fragmento de conteúdo solicitado não existe
  • 500 (Erro interno do servidor)

    OBSERVAÇÃO

    Este erro é retornado:

    • quando ocorre um erro que não pode ser identificado com um código específico
    • quando a carga fornecida não era válida

    A seguir são apresentados cenários comuns quando esse status de erro é retornado, juntamente com a mensagem de erro (monospace) gerada:

    • A pasta pai não existe (ao criar um fragmento de conteúdo via POST)

    • Nenhum modelo de fragmento de conteúdo é fornecido (cq:model está ausente), não pode ser lido (devido a um caminho inválido ou a um problema de permissão) ou não há um modelo de fragmento válido:

      • No content fragment model specified
      • Cannot create a resource of given model '/foo/bar/qux'
    • Não foi possível criar o fragmento de conteúdo (possivelmente um problema de permissão):

      • Could not create content fragment
    • Não foi possível atualizar o título e ou a descrição:

      • Could not set value on content fragment
    • Não foi possível definir metadados:

      • Could not set metadata on content fragment
    • O elemento de conteúdo não pôde ser encontrado ou não pôde ser atualizado

      • Could not update content element
      • Could not update fragment data of element

    As mensagens de erro detalhadas geralmente são retornadas da seguinte maneira:

    {
      "class": "core/response",
      "properties": {
        "path": "/api/assets/foo/bar/qux",
        "location": "/api/assets/foo/bar/qux.json",
        "parentLocation": "/api/assets/foo/bar.json",
        "status.code": 500,
        "status.message": "...{error message}.."
      }
    }
    

Referência da API

Consulte aqui para obter referências detalhadas da API:

Recursos adicionais

Para obter mais informações, consulte:

Nesta página