Resumen de API de AEM aem-apis-overview

Obtenga información sobre los distintos tipos de API en Adobe Experience Manager (AEM) y comprenda qué API elegir para su integración.

Para crear, leer, actualizar y eliminar contenido, recursos y formularios en AEM, los desarrolladores pueden utilizar una amplia gama de API. Estas API permiten a los desarrolladores crear aplicaciones personalizadas que interactúen con AEM.

Vamos a explorar los diferentes tipos de API en AEM y comprender qué API elegir para su integración.

Tipos de API de AEM types-of-aem-apis

AEM ofrece las siguientes API para interactuar con sus tipos de servicio de autor y publicación.

Tipo de API de AEM
Descripción
Disponibilidad
Caso práctico
Ejemplos de API
API de AEM basadas en OpenAPI
API estandarizadas y legibles por el equipo para Assets, Sites y Forms.
Solo AEM as a Cloud Service
Desarrollo con API en primer lugar, aplicaciones modernas
API de autor de Assets, API de carpetas, API de AEM Sites, API de servicios de documentos de Forms y otras
API de RESTful
Puntos finales REST tradicionales para interactuar con recursos de AEM.
AEM 6.X, AEM as a Cloud Service
Operaciones CRUD, aplicaciones modernas
API HTTP de Assets, API REST de flujo de trabajo, exportador JSON para servicios de contenido y otros
API de GraphQL
Optimizado para recuperar contenido estructurado de forma eficaz con consultas flexibles.
AEM 6.X, AEM as a Cloud Service
CMS sin encabezado, SPA, aplicaciones móviles
API de GraphQL
API tradicionales (no RESTful)
Las API más antiguas, como JCR, modelos Sling, Query Builder y otras.
AEM 6.X, AEM as a Cloud Service
Integraciones heredadas, compatibilidad con versiones anteriores
API de Query Builder y otras

Para obtener más información, consulte la página API de Adobe Experience Manager as a Cloud Service.

Qué API elegir which-api-to-choose

Al seleccionar una API para la integración, tenga en cuenta los siguientes factores:

  • Caso de uso: Determine si la API de AEM admite su caso de uso. Siempre que sea posible, use las API de AEM basadas en OpenAPI, ya que proporcionan un enfoque estandarizado y moderno para interactuar con AEM. Si las API basadas en OpenAPI no están disponibles, considere la posibilidad de utilizar las API de RESTful o las API de GraphQL y, como último recurso, las API tradicionales.

  • Compatibilidad: Asegúrese de que la API seleccionada sea compatible con su versión de AEM. Por ejemplo, las API de AEM basadas en OpenAPI son exclusivas de AEM as a Cloud Service y no están disponibles en AEM 6.X.

  • Tipo de servicio de AEM: autor vs. publicación: la elección de la API también depende de si se ejecuta en el servicio de autor o publicación, ya que sus modelos de acceso son diferentes. El servicio AEM Author se utiliza para crear contenido y siempre requiere autenticación. El servicio de publicación de AEM se utiliza para la entrega de contenido y es posible que no requiera autenticación, según el caso de uso.

  • Autenticación: Compruebe que la API admite el método de autenticación que planea usar. Por ejemplo:

    • API de AEM basadas en OpenAPI: admiten la autenticación OAuth 2.0, incluidas las credenciales de cliente (servidor a servidor), el código de autorización (aplicación web) y la clave de revisión para los tipos de concesión de intercambio de código (aplicación de una sola página). Otras API de AEM no admiten la autenticación OAuth 2.0.
    • API RESTful: admite la autenticación de token web JSON (JWT), también conocida como autenticación basada en token.

Diferencia entre el token web JSON (JWT) y OAuth 2.0 difference-between-jwt-and-oauth

Vamos a comparar el token web JSON (JWT) y OAuth 2.0, dos mecanismos de autenticación comunes utilizados en las API de AEM:

Función
Token web JSON (JWT)
OAuth 2.0
Utilizado en
API de RESTful
API de AEM basadas en OpenAPI (no admitidas en RESTful ni en otras API)
Función
Autenticación de servicio
Autenticación de usuarios o servicios
Interacción del usuario
No se requiere interacción del usuario
Interacción de usuario necesaria para los tipos de concesión de código de autorización y aplicación de una sola página
Más Adecuado Para
Llamadas de API de servidor a servidor
Acceso seguro y permitido para aplicaciones y usuarios
Información necesaria
Clave privada para firmar JWT
ID de cliente y secreto de cliente para OAuth 2.0
Caducidad del token
De corta duración, a menudo necesita actualización
El token de acceso es de corta duración. El token de actualización es de larga duración y se utiliza para obtener un nuevo token de acceso
Administración de credenciales
AEM Developer Console
Adobe Developer Console

API de AEM basadas en OpenAPI

Obtenga más información acerca de las API de AEM basadas en OpenAPI y los conceptos importantes para acceder a las API de Adobe en la guía API de AEM basadas en OpenAPI.

Casos de uso

Invocar la API mediante la autenticación de servidor a servidor

Invocar API mediante autenticación de servidor a servidor

Obtenga información sobre cómo invocar las API de AEM basadas en OpenAPI desde una aplicación NodeJS personalizada mediante la autenticación de servidor a servidor OAuth.

Más información

Invocar la API mediante la autenticación de aplicación web

Invocar API mediante autenticación de aplicación web

Obtenga información sobre cómo invocar las API de AEM basadas en OpenAPI desde una aplicación web personalizada mediante la autenticación de aplicación web de OAuth.

Más información

Invocar la API mediante la aplicación de una sola página de OAuth

Invocar API mediante la aplicación de una sola página de OAuth

Aprenda a invocar las API de AEM basadas en OpenAPI desde una aplicación de una sola página (SPA) personalizada mediante el flujo PKCE de OAuth 2.0.

Más información

API de GraphQL: ejemplos

Obtenga más información acerca de las API de GraphQL y cómo usarlas en Introducción a AEM sin encabezado: GraphQL

Casos de uso

Aplicación de una sola página (SPA)

Aplicación de una sola página (SPA)

Obtenga información sobre cómo crear una aplicación de una sola página (SPA) que obtenga contenido de AEM mediante las API de GraphQL.

Más información

Aplicación móvil

Aplicación móvil

Obtenga información sobre cómo crear una aplicación móvil que recupere contenido de AEM mediante las API de GraphQL.

Más información

Componente web

Componente web

Obtenga información sobre cómo crear un componente web que obtenga contenido de AEM mediante las API de GraphQL.

Más información

API de RESTful: ejemplos

Obtenga más información acerca de las API de RESTful, como la API HTTP de Assets y el Exportador JSON.

Casos de uso

Uso de servicios de contenido para aplicaciones sin encabezado

Uso de servicios de contenido para la aplicación sin encabezado

Aprenda a crear una aplicación móvil nativa que recupere contenido de AEM mediante las API de RESTful de servicios de contenido.

Más información

Autenticación basada en tokens para API de RESTful

Autenticación basada en tokens para API RESTful

Obtenga información sobre cómo invocar las API de RESTful mediante la autenticación de token web JSON (JWT).

Más información

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69