API de AEM basadas en OpenAPI
Obtenga información sobre las API de AEM basadas en OpenAPI, incluida la compatibilidad con la autenticación, los conceptos clave y cómo acceder a las API de Adobe.
La especificación de OpenAPI (conocida anteriormente como Swagger) es un estándar muy utilizado para definir las API de RESTful. AEM as a Cloud Service proporciona varias API basadas en la especificación OpenAPI (o simplemente API de AEM basadas en OpenAPI), lo que facilita la creación de aplicaciones personalizadas que interactúan con los tipos de servicio de autor o publicación de AEM. A continuación se indican algunos ejemplos:
Sites
- API de Sites: API para trabajar con fragmentos de contenido.
Recursos
-
API de carpetas: API para trabajar con carpetas, como crear, mostrar y eliminar carpetas.
-
API de autor de recursos: API para trabajar con recursos y sus metadatos.
Formularios
- API de comunicaciones de formularios: API para trabajar con formularios y documentos.
En futuras versiones, se añadirán más API de AEM basadas en OpenAPI para admitir casos de uso adicionales.
Compatibilidad con la autenticación authentication-support
Las API de AEM basadas en OpenAPI admiten la autenticación OAuth 2.0, incluidos los siguientes tipos de concesión:
-
Credencial de servidor a servidor OAuth: ideal para servicios back-end que necesitan acceso a la API sin interacción del usuario. Utiliza el tipo de concesión client_credentials, lo que permite una administración segura del acceso a nivel de servidor. Para más información, consulte Credencial de servidor a servidor de OAuth.
-
Credencial de la aplicación web de OAuth: es adecuada para aplicaciones web con componentes de front-end y back-end que acceden a las API de AEM en nombre de los usuarios. Utiliza el tipo de concesión authorization_code, donde el servidor back-end administra secretos y tókenes de forma segura. Para obtener más información, consulte Credencial de la aplicación web de OAuth.
-
Credencial de aplicación de una sola página de OAuth: diseñada para las SPA que se ejecutan en el explorador y que necesitan acceder a las API en nombre de un usuario sin un servidor back-end. Utiliza el tipo de concesión authorization_code y se basa en los mecanismos de seguridad del lado del cliente mediante PKCE (Proof Key for Code Exchange) para proteger el flujo del código de autorización. Para obtener más información, consulte Credencial de aplicación de una sola página de OAuth.
Qué método de autenticación utilizar auth-method-decision
A la hora de decidir qué método de autenticación utilizar, tenga en cuenta lo siguiente:
La autenticación de usuario (aplicación web o aplicación de una sola página) debe ser la opción predeterminada siempre que se trate de un contexto de usuario de AEM. Esto garantiza que todas las acciones del repositorio se atribuyan correctamente al usuario autenticado y que el usuario solo tenga acceso a los permisos que le corresponden.
El uso de servidor a servidor (o cuenta de sistema técnico) para realizar acciones en nombre de un usuario individual elude el modelo de seguridad e introduce riesgos como la escalada de privilegios y la auditoría inexacta.
Diferencia entre las credenciales de servidor a servidor de OAuth, de aplicación web y de una sola página difference-between-oauth-server-to-server-vs-web-app-vs-single-page-app-credentials
En la siguiente tabla se resumen las diferencias entre los tres métodos de autenticación de OAuth admitidos por las API de AEM basadas en OpenAPI:
client_id, client_secret) en sistemas back-end.client_id, client_secret) en sistemas back-end para intercambiar el código de autorización por el token de acceso.client_secret, ya que no es seguro almacenarlo en aplicaciones de front-end. Se basa en PKCE para intercambiar el código de autorización por el token de acceso.Acceso a las API de Adobe y conceptos relacionados accessing-adobe-apis-and-related-concepts
Antes de acceder a las API de Adobe, es esencial comprender estas construcciones clave:
-
Adobe Developer Console: es el centro para desarrolladores para acceder a las API de Adobe, SDK, eventos en tiempo real, funciones sin servidor y mucho más. Tenga en cuenta que es diferente de AEM Developer Console, que se utiliza para depurar aplicaciones de AEM.
-
Proyecto de Adobe Developer Console: lugar central para administrar las integraciones de la API, eventos y funciones de tiempo de ejecución. Aquí puede configurar las API, establecer la autenticación y generar las credenciales necesarias.
-
Perfiles de producto: los perfiles de producto proporcionan un ajuste preestablecido de permisos que le permite controlar el acceso de los usuarios o las aplicaciones a productos de Adobe como AEM, Adobe Target, Adobe Analytics y otros. Todos los productos de Adobe tienen perfiles de producto predefinidos asociados a ellos.
-
Servicios: los servicios definen los permisos reales y están asociados al perfil del producto. Para reducir o aumentar el ajuste preestablecido de permisos, puede anular la selección de los servicios asociados al perfil del producto o bien seleccionarlos. Lo que le permite controlar el nivel de acceso al producto y a sus API. En AEM as a Cloud Service, los servicios representan grupos de usuarios con Listas de control de acceso (ACL) predefinidas para nodos del repositorio, lo que permite la administración detallada de los permisos.
Introducción
Obtenga información sobre cómo configurar su entorno de AEM as a Cloud Service y un proyecto de Adobe Developer Console para habilitar el acceso a las API de AEM basadas en OpenAPI. Acceda también a la API de AEM mediante el explorador para comprobar la configuración y revisar la solicitud y la respuesta.
Configurar las API de AEM basadas en OpenAPI
Aprenda a configurar su entorno de AEM as a Cloud Service para habilitar el acceso a las API de AEM basadas en OpenAPI.
Tutoriales de la API
Aprenda a utilizar las API de AEM basadas en OpenAPI utilizando diferentes métodos de autenticación de OAuth:
Invocar la API mediante la 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 de OAuth.
Invocar la API mediante la 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.
Invocar la API mediante la autenticación de aplicación de una sola página
Obtenga información sobre cómo invocar las API de AEM basadas en OpenAPI desde una aplicación de una sola página (SPA) personalizada mediante la autenticación de aplicación de una sola página de OAuth.