Présentation des API d’AEM aem-apis-overview

Découvrez les différents types d’API as a Cloud Service Adobe Experience Manager (AEM) et obtenez une vue d’ensemble des API d’AEM basées sur la OpenAPI Specification (OAS), communément appelées API d’ basées sur OpenAPI.

AEM as a Cloud Service fournit un large éventail d’API pour la création, la lecture, la mise à jour et la suppression de contenu, de ressources et de formulaires. Ces API permettent aux développeurs de créer des applications personnalisées qui interagissent avec AEM.

Explorons les différents types d’API d’AEM et comprenons les concepts clés de l’accès aux API d’Adobe.

Types d’API AEM types-of-aem-apis

AEM propose des API héritées et modernes pour interagir avec ses types de services de création et de publication.

  • API héritées : introduites dans les versions AEM antérieures, les API héritées sont toujours prises en charge pour la compatibilité ascendante.

  • API modernes : basées sur la spécification REST OpenAPI, ces API suivent les bonnes pratiques de conception d’API actuelles et sont recommandées pour les nouvelles intégrations.

Type d’API AEM
Spécifications
Disponibilité
Cas d’utilisation
Exemple
API traditionnelles (non RESTful)
Servlets Sling
AEM 6.X, AEM as a Cloud Service
Intégrations héritées, rétrocompatibilité
API Query Builder et autres
API RESTful
HTTP, JSON
AEM 6.X, AEM as a Cloud Service
opérations CRUD, applications modernes
API HTTP Assets, API REST de workflow, exportateur JSON pour Content Services et autres
API GRAPHQL
GraphQL
AEM 6.X, AEM as a Cloud Service
CMS sans tête, SPA, applications mobiles
API GraphQL
API AEM OpenAPI
REST, OpenAPI
AEM as a Cloud Service uniquement
Développement d’abord API, applications modernes
API d’auteur Assets, API de dossiers, API AEM Sites, Services Forms Acrobat et autres
IMPORTANT
Les API d’AEM basées sur OpenAPI ne sont disponibles que dans AEM as a Cloud Service et ne sont pas compatibles avec AEM 6.X.

Pour plus d’informations sur les API d’AEM, voir la section API Adobe Experience Manager as a Cloud Service.

Regardons de plus près les API d’AEM basées sur OpenAPI et les concepts importants d’accès aux API d’Adobe.

API AEM OpenAPI openapi-based-aem-apis

AVAILABILITY
Les API d’AEM OpenAPI sont disponibles dans le cadre d’un programme d’accès anticipé. Si vous souhaitez y accéder, nous vous encourageons à envoyer un email aem-apis@adobe.com avec une description de votre cas d’utilisation.

La spécification OpenAPI (anciennement connue sous le nom de Swagger) est une norme largement utilisée pour définir les API RESTful. AEM as a Cloud Service fournit plusieurs API basées sur les spécifications OpenAPI (ou simplement des API d’AEM basées sur OpenAPI), ce qui facilite la création d’applications personnalisées qui interagissent avec AEM types de services de création ou de publication. Voici quelques exemples :

Sites

  • API Sites : API pour travailler avec des fragments de contenu.

Assets

  • API de dossiers : API pour travailler avec des dossiers tels que créer, répertorier et supprimer des dossiers.

  • API d’auteur Assets : API pour travailler avec des ressources et ses métadonnées.

Forms

Dans les prochaines versions, d’autres API d’AEM basées sur OpenAPI seront ajoutées pour prendre en charge des cas d’utilisation supplémentaires.

Prise en charge de l’authentification authentication-support

Les API d’AEM basées sur OpenAPI prennent en charge les méthodes d’authentification suivantes :

  • OAuth Server-to-Server Credential : idéal pour les services principaux ayant besoin d’un accès à l’API sans interaction de l’utilisateur. Il utilise le type d’octroi client_credentials, ce qui permet la gestion sécurisée des accès au niveau du serveur. Pour plus d’informations, voir Informations d’identification OAuth Server-to-Server.

  • Informations d’identification de l’application web OAuth : adaptées aux applications web avec interface et serveur principal ayant accès aux API AEM au nom des utilisateurs. Il utilise le type d’octroi authorization_code, où le serveur principal gère en toute sécurité les secrets et les jetons. Pour plus d’informations, voir Informations d’identification de l’application web OAuth.

  • Informations d’identification de l’application d’une seule page OAuth : conçues pour SPA s’exécutant dans le navigateur, qui doit accéder aux API au nom d’un utilisateur sans serveur principal. Il utilise le type d’octroi authorization_code et s’appuie sur des mécanismes de sécurité côté client à l’aide de PKCE (BAT Key for Code Exchange) pour sécuriser le flux de code d’autorisation. Pour plus d’informations, voir Informations d’identification de l’application monopage OAuth.

Avant d’accéder aux API Adobe, il est essentiel de comprendre ces concepts clés :

  • Adobe Developer Console : centre de développement pour l’accès aux API d’Adobe, aux SDK, aux événements en temps réel, aux fonctions sans serveur, etc. Notez qu’il est différent de la Developer Console AEM utilisée pour le débogage des applications AEM.

  • Projet Adobe Developer Console : emplacement central pour la gestion des intégrations API, des événements et des fonctions d’exécution. Ici, vous configurez les API, définissez l’authentification et générez les informations d’identification requises.

  • Profils de produit : les profils de produit fournissent un paramètre d’autorisation prédéfini qui vous permet de contrôler l’accès des utilisateurs ou des applications aux produits d’Adobe tels qu’AEM, Adobe Target, Adobe Analytics, etc. Chaque produit Adobe est associé à des profils de produit prédéfinis.

  • Services : les services définissent les autorisations réelles et sont associés au profil de produit. Pour réduire ou augmenter le paramètre prédéfini d’autorisations, vous pouvez désélectionner ou sélectionner les services associés au profil de produit. Cela vous permet donc de contrôler le niveau d’accès au produit et à ses API. Dans AEM as a Cloud Service, les services représentent des groupes d’utilisateurs avec des listes de contrôle d’accès (ACL) prédéfinies pour les noeuds de référentiel, ce qui permet une gestion granulaire des autorisations.

Étapes suivantes next-steps

Comprendre les différents types d’API AEM, notamment
Les API d’AEM basées sur OpenAPI et les concepts clés d’accès aux API d’Adobe vous permettent désormais de commencer à créer des applications personnalisées qui interagissent avec AEM.

Commençons avec le tutoriel Comment appeler les API d’AEM OpenAPI.

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