Overzicht van AEM API's aem-apis-overview
Leer over de verschillende types van APIs in Adobe Experience Manager (AEM) as a Cloud Service en krijg een overzicht van OpenAPI Specificatie (OAS)gebaseerde AEM APIs, algemeen gekend als OpenAPI-Gebaseerde AEM APIs.
AEM as a Cloud Service biedt een groot aantal API's voor het maken, lezen, bijwerken en verwijderen van inhoud, elementen en formulieren. Met deze API's kunnen ontwikkelaars aangepaste toepassingen maken die met AEM werken.
Laten we de verschillende typen API's in AEM onderzoeken en de belangrijkste concepten begrijpen voor het benaderen van Adobe-API's.
Typen AEM API's types-of-aem-apis
AEM biedt zowel verouderde als moderne API's voor interactie met de auteur en het publiceren van servicetypen.
-
Verouderde APIs: Ingebracht in vroegere AEM versies, erfenis APIs wordt nog gesteund voor achterwaartse verenigbaarheid.
-
Moderne APIs: Gebaseerd op REST, de Specificatie OpenAPI, volgen deze APIs huidige API ontwerpopbest praktijken en worden geadviseerd voor nieuwe integratie.
Voor meer details over AEM APIs, zie Adobe Experience Manager as a Cloud Service APIs.
Laten we eens nader kijken naar de op OpenAPI gebaseerde AEM API's en de belangrijke concepten voor toegang tot Adobe API's.
Op OpenAPI gebaseerde AEM API's openapi-based-aem-apis
De Specificatie OpenAPI(die vroeger als Swagger wordt bekend) is een wijd gebruikte norm voor het bepalen van RESTful APIs. AEM as a Cloud Service biedt verschillende API's die zijn gebaseerd op OpenAPI-specificaties (of gewoon op OpenAPI gebaseerde AEM API's), waardoor het eenvoudiger wordt om aangepaste toepassingen te maken die interageren met AEM auteur- of publicatieservice. Hieronder volgen enkele voorbeelden:
Plaatsen
- Plaatsen API: APIs voor het werken met de Fragmenten van de Inhoud.
Assets
-
Mappen API: APIs voor het werken met omslagen zoals creeer, lijst en schrap omslagen.
-
de Auteur API van Assets: APIs voor het werken met activa en zijn meta-gegevens.
Forms
- Communicatie APIs van Forms: APIs voor het werken met vormen en documenten.
In toekomstige versies worden meer op OpenAPI gebaseerde AEM-API's toegevoegd ter ondersteuning van extra gebruiksgevallen.
Verificatieondersteuning authentication-support
De op OpenAPI gebaseerde AEM API's ondersteunen de volgende verificatiemethoden:
-
OAuth Server-aan-Server Referentie: Ideaal voor backend de diensten die API toegang zonder gebruikersinteractie vereisen. Het gebruikt client_credentials giftype, toelatend veilig toegangsbeheer op het serverniveau. Voor meer informatie, zie Server-aan-Server referentie.
-
OAuth App credential van het Web: Geschikt voor Webtoepassingen met front-end en achterste componenten die tot APIs namens gebruikers toegang hebben. Het gebruikt het authentication_code subsidietype, waar de backendserver veilig geheimen en tokens beheert. Voor meer informatie, zie {de referentie van de App van 0} OAuth Web 🔗.
-
OAuth de Enige referentie van de App van de Pagina: Ontworpen voor SPA die in browser lopen, die tot APIs namens een gebruiker zonder een achtergrondserver moet toegang hebben. Het gebruikt authentication_code verlenen type en baseert zich op cliënt-zijveiligheidsmechanismen gebruikend PKCE (Sleutel van het Bewijs voor de Uitwisseling van de Code) om de stroom van de vergunningscode te beveiligen. Voor meer informatie, zie OAuth Enige de credentie van de Pagina App.
Toegang tot Adobe-API's en verwante concepten accessing-adobe-apis-and-related-concepts
Voordat u Adobe-API's opent, is het van essentieel belang dat u deze belangrijke concepten begrijpt:
-
Adobe Developer Console: De ontwikkelaarshub voor de toegang tot van Adobe APIs, SDKs, gebeurtenissen in real time, serverless functies, en meer. Merk op dat het van AEM Developer Console verschillend is, die voor het zuiveren AEM toepassingen wordt gebruikt.
-
Project van Adobe Developer Console: Centrale plaats voor het beheren van API integratie, gebeurtenissen, en runtime functies. Hier, vormt u APIs, plaatst authentificatie, en produceert vereiste geloofsbrieven.
-
Profielen van het Product: De Profielen van het product verstrekken een toestemmingsvooraf ingesteld die u toestaat om gebruiker of toepassingstoegang tot de producten van de Adobe zoals AEM, Adobe Target, Adobe Analytics, en anderen te controleren. Elk product van de Adobe heeft vooraf bepaalde productprofielen verbonden aan het.
-
de Diensten: De diensten bepalen de daadwerkelijke toestemmingen en worden geassocieerd met het Profiel van het Product. Als u de voorinstelling voor machtigingen wilt beperken of vergroten, kunt u de services die aan het productprofiel zijn gekoppeld, deselecteren of selecteren. Zo kunt u het toegangsniveau voor het product en de bijbehorende API's bepalen. In AEM as a Cloud Service, vertegenwoordigen de diensten gebruikersgroepen met vooraf bepaalde Lijsten van het Toegangsbeheer (ACLs) voor bewaargegevensopslagknopen, die korrelig toestemmingsbeheer toestaan.
Volgende stappen next-steps
Met inzicht in de verschillende AEM API-typen, waaronder
AEM API's die zijn gebaseerd op OpenAPI's en de belangrijkste concepten voor toegang tot Adobe-API's zijn nu klaar om aangepaste toepassingen te maken die met AEM werken.
Laten we beginnen met hoe te om op OpenAPI-Gebaseerde AEM APIsleerprogramma aan te halen.