AEM API's die zijn gebaseerd op OpenAPI
Leer meer over de op OpenAPI gebaseerde AEM API's, waaronder verificatieondersteuning, sleutelconcepten en toegang tot Adobe API's.
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 op basis van OpenAPI-specificaties (of gewoon AEM API's op basis van OpenAPI), waardoor het eenvoudiger wordt aangepaste toepassingen te maken die communiceren met de auteur van AEM of servicetypen publiceren. 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 OAuth 2.0-verificatie, inclusief de volgende typen subsidies:
-
OAuth Server-aan-Server credential: Ideaal voor backend 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 AEM 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 🔗.
-
Voor één enkele Pagina App credential: Ontworpen voor SPAs 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.
Verschil tussen OAuth Server-aan-Server vs Web App vs Single Page App geloofsbrieven difference-between-oauth-server-to-server-vs-web-app-vs-single-page-app-credentials
De volgende tabel geeft een overzicht van de verschillen tussen de drie OAuth-verificatiemethoden die worden ondersteund door AEM API's die zijn gebaseerd op OpenAPI:
client_id, client_secret ) veilig op in back-endsystemen.client_id, client_secret ) veilig op in back-endsystemen om machtigingscode voor toegangstoken uit te wisselen.client_secret niet gebruikt, omdat het onveilig is om deze in frontend-apps op te slaan. Verantwoordt op PKCE om vergunningscode voor toegangstoken uit te wisselen.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 de volgende belangrijke elementen 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 van de toepassingen van AEM 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 Adobe zoals AEM, Adobe Target, Adobe Analytics, en anderen te controleren. Elk Adobe-product heeft vooraf gedefinieerde productprofielen.
-
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.
Aan de slag
Leer hoe u uw AEM as a Cloud Service-omgeving instelt en een Adobe Developer Console-project om toegang tot de op OpenAPI gebaseerde AEM API's mogelijk te maken. Toegang ook tot de AEM API via de browser om de installatie te controleren en de aanvraag en het antwoord te bekijken.
opstelling op OpenAPI-Gebaseerde AEM APIs
Leer hoe u uw AEM as a Cloud Service-omgeving instelt om toegang tot de op OpenAPI gebaseerde AEM API's mogelijk te maken.
API-zelfstudies
Leer hoe u de op OpenAPI gebaseerde AEM API's gebruikt met verschillende OAuth-verificatiemethoden:
Oproep API gebruikend Server-aan-Server authentificatie
Leer hoe u op OpenAPI gebaseerde AEM API's aanroept vanuit een aangepaste NodeJS-toepassing met OAuth Server-to-Server-verificatie.
Oproep API gebruikend de authentificatie van de App van het Web
Leer hoe u op OpenAPI gebaseerde AEM API's aanroept vanuit een aangepaste webtoepassing met OAuth Web App-verificatie.
Oproep API gebruikend de Enige authentificatie van de Toepassing van de Pagina
Leer hoe u op OpenAPI gebaseerde AEM API's aanroept vanuit een aangepaste Single Page App (SPA) met OAuth App-verificatie voor één pagina.