Explorar APIs de entrega de fragmentos de conteúdo baseadas em OpenAPI do AEM

A Entrega de fragmento de conteúdo do AEM com APIs OpenAPI no AEM fornece uma maneira poderosa de fornecer conteúdo estruturado a qualquer aplicativo ou canal. Neste capítulo, exploramos como usar as OpenAPIs para recuperar fragmentos de conteúdo por meio da funcionalidade Experimente da documentação.

Pré-requisitos prerequisites

Este é um tutorial de várias partes e presume que as etapas descritas em Criação de fragmentos de conteúdo foram concluídas.

Certifique-se de ter o seguinte:

Objetivos objectives

APIs de entrega

A entrega de fragmento de conteúdo do AEM com APIs OpenAPI fornece uma interface RESTful para recuperar fragmentos de conteúdo. As APIs discutidas neste tutorial estão disponíveis apenas nos serviços de Publicação e visualização do AEM, e não no serviço do Autor. Existem outras OpenAPIs para interagir com Fragmentos de conteúdo no serviço de Autor do AEM.

Explore as APIs

A documentação de Entrega de fragmentos de conteúdo do AEM com APIs OpenAPI tem um recurso "Experimente" que permite explorar as APIs e testá-las diretamente do navegador. Essa é uma ótima maneira de se familiarizar com os endpoints da API e seus recursos.

Abra os documentos da API do AEM Sites em seu navegador.

As APIs estão listadas na navegação à esquerda na seção Entrega de fragmento. É possível expandir esta seção para ver as APIs disponíveis. Selecionar uma API exibe os detalhes da API no painel principal e uma seção Experimente no painel direito que permite testar e explorar a API diretamente do navegador.

Listar fragmentos de conteúdo

Essa API permite recuperar uma lista paginada de todos os fragmentos de conteúdo do AEM por pasta. A maneira mais simples de usar essa API é fornecer o caminho para a pasta que contém os fragmentos de conteúdo.

Como estamos usando o serviço de Publicação do AEM, defina o bucket para o identificador do serviço de Publicação do AEM. Por exemplo:

Quando o bucket é definido, o campo Servidor de destino é atualizado automaticamente para a URL completa da API do serviço de Publicação do AEM, como: https://publish-p138003-e1400351.adobeaemcloud.com/adobe/contentFragments

Obter detalhes do fragmento de conteúdo

Semelhante à API Listar todos os fragmentos de conteúdo, a API Obter um fragmento de conteúdo recupera um único fragmento de conteúdo por sua ID, juntamente com todas as referências opcionais. Para explorar essa API, solicitaremos o Fragmento de conteúdo da equipe que faz referência a vários Fragmentos de conteúdo de pessoas.

Neste exemplo, use a ID do Fragmento de conteúdo da equipe recuperada na seção anterior. Por exemplo, para esta resposta de Fragmento de Conteúdo em Listar todos os Fragmentos de Conteúdo, use o valor no campo id de b954923a-0368-4fa2-93ea-2845f599f512. (Seu id será diferente do valor usado no tutorial.)

{
    "path": "/content/dam/my-project/teams/team-alpha",
    "name": "",
    "title": "Team Alpha",
    "id": "50f28a14-fec7-4783-a18f-2ce2dc017f55", // This is the Content Fragment ID
    "description": "",
    "model": {},
    "fields": {}
}

Observe que a matriz teamMembers agora inclui os detalhes dos Fragmentos de conteúdo de pessoa referenciados. As referências de hidratação permitem recuperar todos os dados necessários em uma única chamada de API, o que é particularmente útil para reduzir o número de solicitações feitas por aplicativos clientes.

Parabéns!

Parabéns, você criou e executou várias entregas de fragmento de conteúdo do AEM com chamadas da API OpenAPI usando o recurso Experimente da documentação do AEM.

Próximas etapas

No próximo capítulo, Criar um aplicativo React, você explora como um aplicativo externo pode interagir com a Entrega de fragmentos de conteúdo do AEM com APIs OpenAPI.