AEM API's instellen die zijn gebaseerd op OpenAPI
- Onderwerpen:
- Ontwikkelen
Gemaakt voor:
- Beginner
- Ontwikkelaar
- Leider
Leer hoe u uw AEM as a Cloud Service-omgeving instelt om toegang tot de op OpenAPI gebaseerde AEM API's mogelijk te maken.
AVAILABILITYHet 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.
Modernisering van de AEM as a Cloud Service-omgeving
De modernisering van het milieu van AEM as a Cloud Service is een eenmalige milieuactiviteit die de volgende stappen omvat:
- 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
Om de instantie van AEM bij te werken, in de Adobe Cloud Manager van de Milieu sectie van 1} {, 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
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.
U kunt de onlangs toegevoegde Profielen van het Product herzien door op het ellips pictogram naast de milieunaam te klikken en te selecteren beheert Toegang > Profielen van de Auteur.
Het Admin Console venster toont de onlangs toegevoegde Profielen van het Product.
Met de bovenstaande stappen wordt de modernisering van de AEM as a Cloud Service-omgeving voltooid.
Toegang tot AEM API's inschakelen
De aanwezigheid van de nieuwe Profielen van het Product laat op OpenAPI-Gebaseerde toegang van AEM API in Adobe Developer Console (ADC) toe. 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.
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.
{de diensten van het 0} Overzicht verbonden aan het Profiel van het Product
Door gebrek, wordt de AEM Assets API Gebruikers Dienst niet geassocieerd met om het even welk Profiel van het Product. Laat ons het met de onlangs toegevoegde Gebruikers van de Medewerker van AEM Assets associëren - auteur - Programma XXX - Milieu XXX Profiel van het Product. Na deze vereniging, kan de 20} ActivaAuteur API van het Project ADC opstelling de gewenste authentificatie en de authentificatierekening associëren met het Profiel van het Product.
Adobe Developer Console-project (ADC) maken
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 Consolegebruikend 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
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.
-
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.
-
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 OAuth en de Server App van het Web App/Één enkele Pagina App geloofsbrievenvoor meer informatie.
-
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 die specifiek zijn voor verificatie.
De AEM-instantie configureren om ADC-projectcommunicatie in te schakelen
Om de ClientID van het Project van ADC aan communicatie met de instantie van AEM toe te laten, moet u de instantie van AEM vormen.
Hiervoor definieert u de API-configuratie in het config.yaml -bestand van
het AEM-project en de implementatie ervan met behulp van de Config Pipeline in de Cloud Manager.
-
Zoek in AEM Project het
config.yaml-bestand in de mapconfigof maak dit.
-
Voeg de volgende configuratie toe aan het
config.yamldossier.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.
CAUTIONVoor 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.
-
Implementeer de bovenstaande wijzigingen met behulp van de configuratiegids in de Cloud Manager. Het
config.yaml-bestand kan ook worden geïnstalleerd in een RDE met behulp van opdrachtregelprogramma's.
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.