En esta parte del AEM Recorrido para desarrolladores sin encabezado, obtenga información sobre cómo utilizar la API de REST para acceder y actualizar el contenido de los fragmentos de contenido.
En el documento anterior del recorrido sin AEM, Cómo acceder al contenido a través de las API de envío de AEM ha aprendido a acceder al contenido sin encabezado en AEM mediante la API de AEM GraphQL y ahora debería:
Este artículo se basa en estos aspectos básicos para que pueda comprender cómo actualizar el contenido sin encabezado existente en AEM a través de la API de REST.
En la fase anterior del Recorrido sin encabezado, ha aprendido a utilizar la API de AEM GraphQL para recuperar el contenido mediante consultas.
Entonces, ¿por qué se necesita otra API?
La API HTTP de Assets permite Lectura su contenido, pero también le permite Crear, Actualizar y Eliminar contenido : acciones que no son posibles con la API de GraphQL.
La API de REST de Assets está disponible en cada instalación predeterminada de una versión reciente de Adobe Experience Manager.
La API HTTP de recursos incluye:
La implementación actual de la API HTTP de Assets se basa en la variable REST estilo arquitectónico y le permite acceder al contenido (almacenado en AEM) mediante CRUD (Crear, Leer, Actualizar, Eliminar).
Con estas operaciones, la API le permite operar Adobe Experience Manager como un CMS sin encabezado (Content Management System) al proporcionar Content Services a una aplicación front-end de JavaScript. O cualquier otra aplicación que pueda ejecutar solicitudes HTTP y gestionar respuestas JSON. Por ejemplo, las aplicaciones de una sola página (SPA), basadas en marcos o personalizadas, requieren contenido proporcionado a través de una API, a menudo en formato JSON.
Los fragmentos de contenido se utilizan para envíos sin encabezado y un fragmento de contenido es un tipo especial de recurso. Se utilizan para acceder a datos estructurados, como textos, números, fechas, entre otros.
La API de REST de Assets utiliza la variable /api/assets
y requiere la ruta del recurso para acceder a él (sin el encabezado /content/dam
).
/content/dam/path/to/asset
/api/assets/path/to/asset
Por ejemplo, para acceder a /content/dam/wknd/en/adventures/cycling-tuscany
, solicitud /api/assets/wknd/en/adventures/cycling-tuscany.json
Acceso:
/api/assets
no necesidad del uso de .model
selector./content/path/to/page
does requerir el uso de .model
selector.El método HTTP determina la operación que se va a ejecutar:
Los parámetros del cuerpo de la solicitud o de la URL se pueden usar para configurar algunas de estas operaciones; por ejemplo, defina que una carpeta o un recurso deben crearse mediante una POST solicitud.
El formato exacto de las solicitudes admitidas se define en la documentación de referencia de la API.
El uso puede variar en función de si utiliza un entorno de publicación o autor de AEM, junto con su caso de uso específico.
Se recomienda encarecidamente que la creación esté vinculada a una instancia de autor (y actualmente no hay forma de replicar un fragmento para publicarlo con esta API).
La entrega es posible desde ambos, ya AEM sirve contenido solicitado solo en formato JSON.
El almacenamiento y el envío desde una instancia de autor AEM deben ser suficientes para las aplicaciones de biblioteca multimedia y detrás del firewall.
Para la entrega web activa, se recomienda una instancia de publicación AEM.
La configuración de Dispatcher en AEM instancias puede bloquear el acceso a /api
.
Para obtener más información, consulte la Referencia de API. En particular, API de Adobe Experience Manager Assets: Fragmentos de contenido.
El uso se realiza mediante:
GET /{cfParentPath}/{cfName}.json
Por ejemplo:
http://<host>/api/assets/wknd/en/adventures/cycling-tuscany.json
La respuesta es un archivo JSON serializado con el contenido estructurado como en el fragmento de contenido. Las referencias se envían como direcciones URL de referencia.
Se pueden realizar dos tipos de operaciones de lectura:
El uso se realiza mediante:
POST /{cfParentPath}/{cfName}
El cuerpo debe contener una representación JSON del fragmento de contenido que se va a crear, incluido cualquier contenido inicial que se deba configurar en los elementos del fragmento de contenido. Es obligatorio configurar la variable cq:model
y debe señalar a un modelo de fragmento de contenido válido. Si no lo hace, se producirá un error. También es necesario añadir un encabezado Content-Type
que está configurado como application/json
.
El uso se realiza mediante
PUT /{cfParentPath}/{cfName}
El cuerpo debe contener una representación JSON de lo que se debe actualizar para el fragmento de contenido determinado.
Puede ser simplemente el título o la descripción de un fragmento de contenido, o un solo elemento, o todos los valores o metadatos de elementos.
El uso se realiza mediante:
DELETE /{cfParentPath}/{cfName}
Para obtener más información sobre el uso de la API REST de AEM Assets, puede hacer referencia a:
Ahora que ha completado esta parte del Recorrido para desarrolladores sin encabezado de AEM, debe:
Debe continuar con su recorrido sin AEM para la próxima revisión del documento Cómo vivir con tu aplicación sin encabezado ¡donde realmente tomas tu proyecto sin AEM en vivo!