Dokumentation AEM Självstudiekurser om AEM Självstudiekurser om AEM as a Cloud Service

Konfigurera OpenAPI-baserade AEM API:er

Last update: Sat Dec 13 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Gäller:
Experience Manager as a Cloud Service

Ämnen:
Utveckling

Skapat för:

Nybörjare
Utvecklare
Ledare

Lär dig hur du konfigurerar AEM as a Cloud Service-miljön för att ge åtkomst till OpenAPI-baserade AEM API:er.

I det här exemplet används AEM Assets API med autentiseringsmetoden Server-till-server för att demonstrera den OpenAPI-baserade installationsprocessen för AEM API:er. Liknande steg kan följas för att konfigurera andra OpenAPI-baserade AEM API:er.

https://video.tv.adobe.com/v/3457510?quality=12&learn=on

Konfigurationsprocessen på hög nivå omfattar följande steg:

Modernisering av AEM as a Cloud Service-miljön.
Aktivera åtkomst till AEM API:er.
Skapa Adobe Developer Console-projekt (ADC).
Konfigurera ADC-projekt.
Konfigurera AEM-instansen för att aktivera ADC-projektkommunikation.

Förutsättningar

Tillgång till Cloud Manager- och AEM as a Cloud Service-miljön
Tillgång till Adobe Developer Console (ADC).
AEM-projekt för att lägga till eller uppdatera API-konfigurationen i filen api.yaml.

Modernisering av AEM as a Cloud Service miljö modernization-of-aem-as-a-cloud-service-environment

Moderniseringen av AEM as a Cloud Service-miljön är en engångsåtgärd per miljöaktivitet som omfattar följande steg. Om du redan har moderniserat din AEM as a Cloud Service-miljö kan du hoppa över det här steget.

Uppdatera till AEM-utgåvan 2024.10.18459.20241031T210302Z eller senare.
Lägg till nya produktprofiler i den om miljön skapades före utgåvan 2024.10.18459.20241031T210302Z.

Uppdatera AEM-instans update-aem-instance

När du har loggat in på Adobe Cloud Manager och vill uppdatera AEM-instansen går du till avsnittet Miljö, markerar ikonen ellips bredvid miljönamnet och väljer alternativet Uppdatera .

Uppdatera AEM-instans

Klicka sedan på knappen Skicka och kör den föreslagna kompletta stackpipeline.

Välj den senaste versionen av AEM

I det här fallet heter Pipeline i helhög Dev :: Fullstack-Deploy och AEM-miljön kallas wknd-program-dev. Dina namn kan vara olika.

Lägg till nya produktprofiler add-new-product-profiles

Om du vill lägga till nya produktprofiler i AEM-instansen går du till avsnittet Miljö för Adobe Cloud Manager och markerar ikonen ellips bredvid miljönamnet. Välj sedan alternativet Lägg till produktprofiler .

Lägg till nya produktprofiler

Granska de nya produktprofilerna genom att klicka på ikonen ellips bredvid miljönamnet och välja Hantera åtkomst > Författarprofiler.
Fönstret Admin Console visar de nya produktprofilerna. Beroende på dina AEM-rättigheter som AEM Assets, AEM Sites, AEM Forms osv. kan du se olika produktprofiler. I mitt fall har jag till exempel AEM Assets- och Sites-rättigheter, så jag ser följande produktprofiler.

Granska nya produktprofiler

Ovanstående steg avslutar moderniseringen av AEM as a Cloud Service-miljön.

Aktivera åtkomst till AEM API:er enable-aem-apis-access

Förekomsten av de nya produktprofilerna aktiverar OpenAPI-baserad AEM API-åtkomst i Adobe Developer Console (ADC). Utan dessa produktprofiler kan du inte konfigurera de OpenAPI-baserade AEM-API:erna i Adobe Developer Console (ADC).

De nya produktprofilerna är kopplade till tjänsterna som representerar AEM-användargrupper med fördefinierade åtkomstkontrollistor. Tjänsterna används för att styra åtkomstnivån för AEM API:er. Du kan också markera eller avmarkera de tjänster som är kopplade till produktprofilen för att minska eller öka åtkomstnivån.

Granska associationen genom att klicka på ikonen Visa detaljer bredvid produktprofilens namn. På följande skärmbild ser du kopplingen mellan AEM Sites Content Managers - author - Program XXX - Environment XXX och AEM Sites Content Managers Service. Granska andra produktprofiler och deras associationer med tjänsterna.

Granska tjänster som är kopplade till produktprofilen

Aktivera åtkomst till AEM Assets API:er enable-aem-assets-apis-access

I det här exemplet används AEM Assets-API:t för att demonstrera den OpenAPI-baserade installationsprocessen för AEM-API:er. Som standard är dock AEM Assets API-användartjänsten inte kopplad till någon produktprofil. Du måste associera den med den önskade produktprofilen.

Låt oss associera det med den nya produktprofilen AEM Assets Collaborator Users - författare - Program XXX - Miljö XXX eller någon annan produktprofil som du vill använda för AEM Assets API-åtkomst.

Koppla AEM Assets API-användartjänst till produktprofil

Aktivera autentisering från server till server

Om du vill aktivera autentisering från server till server för de OpenAPI-baserade AEM-API:erna måste användaren som konfigurerar integrering med Adobe Developer Console (ADC) läggas till som utvecklare i produktprofilen där tjänsten är associerad.

Om du till exempel vill aktivera autentisering från server till server för AEM Assets API måste användaren läggas till som utvecklare i AEM Assets Collaborator Users - författare - Program XXX - Miljö XXX Produktprofil.

Koppla utvecklare till produktprofil

Efter den här associationen kan ADC-projektets API för tillgångsförfattare ställa in önskad server-till-server-autentisering och associera autentiseringskontot från ADC-projektet (som skapades i nästa steg) med produktprofilen.

IMPORTANT

Ovanstående steg är viktigt för att aktivera autentisering från server till server för önskat AEM API. Utan den här associationen kan AEM API inte användas med autentiseringsmetoden Server-till-server.

Genom att utföra alla ovanstående steg har du förberett AEM as a Cloud Service-miljön för att aktivera OpenAPI-baserad åtkomst till AEM API:er. Sedan måste du skapa Adobe Developer Console-projektet (ADC) för att konfigurera OpenAPI-baserade AEM API:er.

Skapa Adobe Developer Console-projekt (ADC) adc-project

Adobe Developer Console-projektet (ADC) används för att konfigurera OpenAPI-baserade AEM API:er. Kom ihåg att Adobe Developer Console (ADC) är utvecklarnavet för åtkomst till Adobe API:er, SDK:er, realtidshändelser, serverlösa funktioner med mera.

ADC-projektet används för att lägga till önskade API:er, konfigurera autentiseringen och associera autentiseringskontot med produktprofilen.

Så här skapar du ett ADC-projekt:

Logga in på Adobe Developer Console med din Adobe ID.
I avsnittet Snabbstart klickar du på knappen Skapa nytt projekt .
Ett nytt projekt med standardnamnet skapas.
Redigera projektnamnet genom att klicka på knappen Redigera projekt i det övre högra hörnet. Ange ett beskrivande namn och klicka på Spara.

Konfigurera ADC-projekt configure-adc-project

När du har skapat ADC-projektet måste du lägga till de AEM-API:er du vill använda, konfigurera autentiseringen och associera autentiseringskontot med produktprofilen.

I det här fallet används AEM Assets-API:t för att demonstrera den OpenAPI-baserade installationsprocessen för AEM-API:er. Du kan dock följa de här stegen för att lägga till andra OpenAPI-baserade AEM-API:er som AEM Sites API, AEM Forms API osv. AEM-berättigandena avgör vilka API:er som är tillgängliga i Adobe Developer Console (ADC).

Om du vill lägga till AEM API:er klickar du på knappen Lägg till API .

I dialogrutan Lägg till API filtrerar du efter Experience Cloud och väljer önskat AEM-API. I det här fallet har till exempel API:t för resursförfattare valts.

Lägg till AEM API

note tip
TIP
Om AEM API-kortet är inaktiverat och Varför är det inaktiverat? information visar meddelandet Licens krävs. En av orsakerna kan vara att du INTE har moderniserat din AEM as a Cloud Service-miljö. Mer information finns i Modernisering av AEM as a Cloud Service-miljön.

I dialogrutan Konfigurera API väljer du sedan önskat autentiseringsalternativ. I det här fallet är autentiseringsalternativet Server-till-server markerat.

Välj autentisering

Server-till-server-autentiseringen är idealisk för backend-tjänster som behöver API-åtkomst utan användarinteraktion. Autentiseringsalternativen Web App och Single Page App är lämpliga för program som behöver API-åtkomst åt användarna. Mer information finns i Skillnaden mellan autentiseringsuppgifter för OAuth Server-to-Server och Web App respektive Single Page App .

note tip
TIP
Om du inte ser autentiseringsalternativet Server-till-server betyder det att användaren som ställer in integreringen inte läggs till som utvecklare i den produktprofil där tjänsten är kopplad. Mer information finns i Aktivera autentisering från server till server.

Om det behövs kan du byta namn på API:t för enklare identifiering. I demosyfte används standardnamnet.
I det här fallet är autentiseringsmetoden OAuth Server-to-Server så du måste associera autentiseringskontot med produktprofilen. Välj AEM Assets Collaborator Users - författare - Program XXX - Miljö XXX Produktprofil och klicka på Spara.
Granska AEM API och autentiseringskonfigurationen.

Om du väljer autentiseringsmetoden OAuth Web App eller OAuth Single Page App uppmanas inte associationen för produktprofilen, men en omdirigerings-URI krävs. Omdirigerings-URI för programmet används för att dirigera om användaren till programmet efter autentisering med en auktoriseringskod. De relevanta självstudiekurserna för användningsfall beskriver sådana autentiseringsspecifika konfigurationer.

Konfigurera AEM-instansen för att aktivera ADC-projektkommunikation configure-aem-instance

Därefter måste du konfigurera AEM-instansen så att den aktiverar ovanstående ADC-projektkommunikation. Med den här konfigurationen kan ADC-projektets ClientID INTE kommunicera med AEM-instansen och resulterar i ett 403-otillåtet fel. Tänk på den här konfigurationen som en brandväggsregel så att bara de klient-ID:n som tillåts kan kommunicera med AEM-instansen.

Låt oss följa stegen för att konfigurera AEM-instansen så att den aktiveras ovanför ADC Project-kommunikationen.

Navigera till AEM-projektet (eller klona det om du inte redan gjort det) på den lokala datorn och leta upp mappen config.
Leta reda på eller skapa filen api.yaml från mappen config i AEM Project. I mitt fall används AEM WKND Sites Project för att demonstrera den OpenAPI-baserade installationsprocessen för AEM API:er.

Lägg till följande konfiguration i filen api.yaml så att ADC-projektets ClientID kan kommunicera med AEM-instansen.

code language-yaml
`kind: "API" version: "1.0" metadata: envTypes: ["dev", "stage", "prod"] data: allowedClientIDs: author: - "<ADC Project's Credentials ClientID>"`

Ersätt <ADC Project's Credentials ClientID> med det faktiska klient-ID:t för ADC-projektets autentiseringsuppgifter-värde. API-slutpunkten som används i den här självstudiekursen är bara tillgänglig på författarnivån, men för andra API:er kan yaml-konfigurationen också ha en publish - eller preview -nod.

note caution
CAUTION
För demoändamål används samma ClientID för alla miljöer. Vi rekommenderar att du använder ett separat ClientID per miljö (dev, stage, prod) för bättre säkerhet och kontroll.

Bekräfta konfigurationsändringarna och skicka ändringarna till Git-fjärrdatabasen som Cloud Manager pipeline är ansluten till.
Distribuera ovanstående ändringar med konfigurationsförloppet i Cloud Manager.

Observera att filen api.yaml också kan installeras i en RDE, med kommandoradsverktyg. Detta är användbart när du vill testa konfigurationsändringarna innan du distribuerar dem till produktionsmiljön.

Nästa steg

När AEM-instansen har konfigurerats för att aktivera ADC-projektkommunikation kan du börja använda de OpenAPI-baserade AEM-API:erna. Lär dig hur du använder OpenAPI-baserade AEM API:er med olika OAuth-autentiseringsmetoder: