AEM API's instellen die zijn gebaseerd op OpenAPI
Leer hoe u uw AEM as a Cloud Service-omgeving instelt om toegang tot de op OpenAPI gebaseerde AEM API's mogelijk te maken.
In dit voorbeeld, wordt de AEM Assets API gebruikend de server-aan-server authentificatiemethode gebruikt om het op OpenAPI-Gebaseerde de opstellingsproces van AEM aan te tonen APIs. De gelijkaardige stappen kunnen aan opstelling andere op open API-Gebaseerde AEM APIs worden gevolgd.
Het installatieproces op hoog niveau omvat de volgende stappen:
- Modernisering van de AEM as a Cloud Service-omgeving.
- Toegang tot AEM API's inschakelen.
- Maak een Adobe Developer Console-project (ADC).
- ADC-project configureren.
- Vorm de instantie van AEM om de mededeling van het Project van ADC toe te laten.
Vereisten
- Toegang tot de Cloud Manager- en AEM as a Cloud Service-omgeving
- Toegang tot Adobe Developer Console (ADC).
- AEM-project voor het toevoegen of bijwerken van de API-configuratie in het
api.yaml-bestand.
Modernisering van de AEM as a Cloud Service-omgeving modernization-of-aem-as-a-cloud-service-environment
De modernisering van het milieu van AEM as a Cloud Service is a eenmalig per milieuactiviteit die de volgende stappen impliceert. Als u uw AEM as a Cloud Service-omgeving al hebt gemoderniseerd, kunt u deze stap overslaan.
- Update aan de Versie van AEM 2024.10.18459.20241031T210302Z of later.
- Voeg er nieuwe productprofielen aan toe als de omgeving is gemaakt vóór de release 2024.10.18459.20241031T210302Z.
AEM-instantie bijwerken update-aem-instance
- Om de instantie van AEM bij te werken, na het programma openen aan Adobe Cloud Manager , navigeer aan de sectie van Milieu, selecteer het ellips pictogram naast de milieunaam en selecteer optie van de Update.
- Dan klik voorleggen knoop en stel gesuggereerde FullstackPipeline in werking.
In mijn geval, wordt de FullstackPipeline genoemd Dev:: Fullstack-Deploy, en het milieu van AEM wordt genoemd wknd-programma-dev. Uw namen kunnen verschillen.
Nieuwe productprofielen toevoegen add-new-product-profiles
- Om nieuwe Profielen van het Product aan de instantie van AEM toe te voegen, in de 2} sectie van de Milieu's van Adobe , selecteer het ellips pictogram naast de milieunaam en selecteer toevoegen de optie van de Profielen van het Product .
-
Herzie de onlangs toegevoegde Profielen van het Product door op het ellips pictogram naast de milieunaam te klikken en te selecteren leidt Toegang > Profielen van de Auteur.
-
Het Admin Console venster toont de onlangs toegevoegde Profielen van het Product. Afhankelijk van uw AEM-rechten, zoals AEM Assets, AEM Sites, AEM Forms, enz., ziet u mogelijk verschillende productprofielen. In mijn geval heb ik bijvoorbeeld AEM Assets en Sites-rechten, dus zie ik de volgende productprofielen.
- Met de bovenstaande stappen wordt de modernisering van de AEM as a Cloud Service-omgeving voltooid.
Toegang tot AEM API's inschakelen enable-aem-apis-access
De aanwezigheid van de nieuwe Profielen van het Product laat op OpenAPI-Gebaseerde toegang van AEM API in Adobe Developer Console (ADC) toe. Zonder deze productprofielen kunt u de op OpenAPI gebaseerde AEM API's niet instellen in de Adobe Developer Console (ADC).
De onlangs toegevoegde Profielen van het Product worden geassocieerd met de Diensten die gebruikersgroepen van AEM met vooraf bepaalde Lijsten van het Toegangsbeheer (ACLs) vertegenwoordigen. De Diensten worden gebruikt om het niveau van toegang tot AEM APIs te controleren. U kunt de Diensten ook selecteren of schrappen verbonden aan het Profiel van het Product om het niveau van toegang te verminderen of te verhogen.
Herzie de vereniging door op het pictogram van de Details van de Mening naast de naam van het Profiel van het Product te klikken. In het volgende screenshot, kunt u de vereniging van de Managers van de Inhoud van AEM Sites zien - auteur - Programma XXX - het Profiel van het Product van het Milieu XXX met de 3} Dienst van de Managers van de Inhoud van AEM Sites. Andere productprofielen bekijken en hun koppelingen met de services bekijken.
{de diensten van het 0} Overzicht verbonden aan het Profiel van het Product
Toegang tot AEM Assets API's inschakelen enable-aem-assets-apis-access
In dit voorbeeld, wordt AEM Assets API gebruikt om het op OpenAPI-Gebaseerde de opstellingsproces van AEM aan te tonen APIs. Nochtans, door gebrek, wordt de AEM Assets API Gebruikers Dienst niet geassocieerd met om het even welk Profiel van het Product. U moet dit koppelen aan het gewenste productprofiel.
Laat ons het met de onlangs toegevoegde Gebruikers van de Medewerker van AEM Assets associëren - auteur - Programma XXX - het Profiel van het Product van het Milieu XXX of een ander Profiel van het Product dat u voor de toegang van AEM Assets API wilt gebruiken.
Server-naar-server verificatie inschakelen
Om de server-aan-Server authentificatie voor gewenste op OpenAPI-Gebaseerde AEM APIs toe te laten, moet de gebruikersinstellingsintegratie die Adobe Developer Console (ADC) gebruikt als Ontwikkelaar aan het Profiel van het Product worden toegevoegd waar de Dienst wordt geassocieerd.
Bijvoorbeeld, om de server-aan-server authentificatie voor AEM Assets API toe te laten, moet de gebruiker als Ontwikkelaar aan de Gebruikers van de Medewerker van AEM Assets worden toegevoegd - auteur - Programma XXX - Milieu XXX Profiel van het Product.
Na deze vereniging, kan de 20} ActivaAuteur API van het Project ADC opstelling de gewenste server-aan-Server authentificatie en de authentificatierekening van het Project associëren ADC (die in de volgende stap) met het Profiel van het Product wordt gecreeerd.
Door alle bovenstaande stappen uit te voeren, hebt u de AEM as a Cloud Service-omgeving voorbereid om op OpenAPI gebaseerde AEM API's toegang te geven. Vervolgens moet u het Adobe Developer Console-project (ADC) maken om de op OpenAPI gebaseerde AEM-API's in te stellen.
Adobe Developer Console-project (ADC) maken adc-project
Het Adobe Developer Console-project (ADC) wordt gebruikt om de op OpenAPI gebaseerde AEM API's in te stellen. Rappel dat Adobe Developer Console (ADC) de ontwikkelaarshub voor de toegang tot van Adobe APIs, SDKs, gebeurtenissen in real time, serverless functies, en meer is.
Het ADC-project wordt gebruikt om de gewenste API's toe te voegen, de verificatie ervan in te stellen en de verificatieaccount aan het productprofiel te koppelen.
Een ADC-project maken:
-
Login aan Adobe Developer Console gebruikend uw Adobe ID.
-
Van de Snelle sectie van het Begin, klik op creeer nieuwe project knoop.
-
Het leidt tot een nieuw project met de standaardnaam.
-
Bewerk de projectnaam door te klikken uitgeeft project knoop in de hoogste juiste hoek. Verstrek een betekenisvolle naam en klik sparen.
ADC-project configureren configure-adc-project
Nadat u het ADC-project hebt gemaakt, moet u de gewenste AEM API's toevoegen, de verificatie ervan instellen en de verificatieaccount aan het productprofiel koppelen.
In dit geval, wordt AEM Assets API gebruikt om het op OpenAPI-Gebaseerde de opstellingsproces van AEM aan te tonen APIs. Nochtans, kunt u de gelijkaardige stappen volgen om andere op OpenAPI-Gebaseerde AEM APIs als AEM Sites API toe te voegen, AEM Forms API, enz. De AEM-rechten bepalen de beschikbare API's in de Adobe Developer Console (ADC).
-
Om AEM APIs toe te voegen, klik op voeg API knoop toe.
-
In voeg API dialoog toe, filter door Experience Cloud en selecteer gewenste AEM API. Bijvoorbeeld, in dit geval, wordt Auteur API van Activa geselecteerd.
note tip TIP Als de gewenste AEM API kaart wordt onbruikbaar gemaakt en waarom is dit gehandicapt? de informatie toont het Vereiste Vergunning bericht één van de redenen zou kunnen zijn dat u uw milieu van AEM as a Cloud Service NIET hebt gemoderniseerd, zie Modernisering van het milieu van AEM as a Cloud Service voor meer informatie. -
Daarna, in vorm API dialoog, selecteer de gewenste authentificatieoptie. Bijvoorbeeld, in dit geval, wordt de server-aan-Server authentificatieoptie geselecteerd.
De server-aan-server authentificatie is ideaal voor de backenddiensten die API toegang zonder gebruikersinteractie vereisen. De opties Web App en Single Page App voor verificatie zijn geschikt voor toepassingen die API-toegang nodig hebben namens gebruikers. Zie Verschil tussen Server-aan-Server van OAuth vs Web App vs Één enkele geloofsbrieven van de Toepassing van de Pagina voor meer informatie.
note tip TIP Als u niet de server-aan-server authentificatieoptie ziet, betekent het dat de gebruiker die opstelling de integratie niet als Ontwikkelaar aan het Profiel van het Product wordt toegevoegd waar de Dienst wordt geassocieerd. Zie Server-aan-Server authentificatie voor meer informatie toelaten. -
Indien nodig kunt u de naam van de API wijzigen om deze gemakkelijker te kunnen identificeren. Voor demo-doeleinden wordt de standaardnaam gebruikt.
-
In dit geval, is de authentificatiemethode OAuth Server-aan-Server zodat moet u de authentificatierekening met het Profiel van het Product associëren. Selecteer de Gebruikers van de Medewerker van AEM Assets - auteur - Programma XXX - het Profiel van het Product van Milieu XXX en klik sparen.
-
Controleer de AEM API- en verificatieconfiguratie.
Als u of OAuth App authentificatiemethode van de Toepassing van de Toepassing van de enig-Pagina kiest, wordt de vereniging van het Profiel van het Product niet veroorzaakt maar de toepassing richt URI wordt vereist. De URI voor omleiding van de toepassing wordt gebruikt om de gebruiker na verificatie met een machtigingscode om te leiden naar de toepassing. In de relevante zelfstudies voor gebruiksgevallen worden dergelijke configuraties beschreven.
De AEM-instantie configureren om ADC-projectcommunicatie in te schakelen configure-aem-instance
Vervolgens moet u de AEM-instantie configureren om bovenstaande ADC-projectcommunicatie in te schakelen. Met deze configuratie kan de ClientID van het ADC-project NIET communiceren met de AEM-instantie en resulteert dit in een 403 Verboden fout. Beschouw deze configuratie als een firewallregel zodat alleen de toegestane ClientID's kunnen communiceren met de AEM-instantie.
Volg de stappen om de instantie van AEM te vormen om bovengenoemde mededeling van het Project van ADC toe te laten.
-
Navigeer op uw lokale computer naar het AEM-project (of kloon het als u dat nog niet hebt gedaan) en zoek de map
config. -
Zoek in AEM Project het
api.yaml-bestand in de mapconfigof maak dit. In mijn geval, wordt het Project van de Plaatsen van AEM WKND gebruikt om het op OpenAPI-Gebaseerde de opstellingsproces van AEM aan te tonen APIs.
-
Voeg de volgende configuratie aan het
api.yamldossier toe om de CliëntID van het Project van ADC toe om met de instantie van AEM te communiceren.code language-yaml kind: "API" version: "1.0" metadata: envTypes: ["dev", "stage", "prod"] data: allowedClientIDs: author: - "<ADC Project's Credentials ClientID>"Vervang
<ADC Project's Credentials ClientID>door de werkelijke ClientID van de Credentials-waarde van het ADC-project. Het API eindpunt dat in dit leerprogramma wordt gebruikt is beschikbaar slechts op de auteurslaag, maar voor andere APIs, kan yaml config ook a hebben publiceren of voorproef knoop.note caution CAUTION Voor demo-doeleinden wordt dezelfde ClientID gebruikt voor alle omgevingen. Het wordt aanbevolen afzonderlijke ClientID per omgeving (dev, stage, prod) te gebruiken voor betere beveiliging en controle. -
Leg de configuratiewijzigingen vast en duw de wijzigingen naar de externe Git-opslagplaats waar de Cloud Manager-pijplijn op is aangesloten.
-
Stel de bovengenoemde veranderingen op gebruikend de Pijpleiding Config in Cloud Manager.
Merk op dat het api.yaml dossier ook in RDE kan worden geïnstalleerd, gebruikend het hulpmiddel van de bevellijn . Dit is nuttig om de configuratieveranderingen te testen alvorens hen aan het productiemilieu op te stellen.
Volgende stappen
Zodra de AEM-instantie is geconfigureerd om ADC-projectcommunicatie in te schakelen, kunt u beginnen met het gebruik van de op OpenAPI gebaseerde AEM API's. 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 2.0 PKCE-stroom.