Dokumentation AEM as a Cloud Service Användarhandbok

OpenAPI-baserade API:er openapi-based-apis

Last update: Tue Jul 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Gäller:
Experience Manager as a Cloud Service

Ämnen:
Utveckling

Skapat för:

Administratör
Utvecklare

Nyare AEM as a Cloud Service-API:er följer OpenAPI-specifikationen och erbjuder därmed en konsekvent och väldokumenterad uppsättning API:er.

NOTE

En heltäckande självstudiekurs rekommenderas för att lära dig hur du konfigurerar och anropar OpenAPI-baserade AEM API:er.

För slutpunkter som kräver autentisering skiljer sig autentiseringsmetoden från slutpunkten, men kan använda OAuth Server-to-Server, OAuth Web App eller OAuth Single Page App (SPA). Autentiseringsuppgifter konfigureras via projekt i Adobe Developer Console.

Vanliga API-användningsfall omfattar integreringar med system som CRM eller PIM, där AEM API:er anropas för att hämta eller behålla data. Som en del av integreringsimplementeringen kan program prenumerera på händelser som skickas från AEM, vilket kan utlösa affärslogik i Adobe App Builder eller annan infrastruktur.

Det här dokumentet fungerar som en översikt, men mer ingående dokumentation finns på följande sidor:

Länkarna från det OpenAPI-baserade API-avsnittet i referensdokumentationen. Varje API:s referensdokumentation innehåller också en API-spelningsbakgrund, vilket gör det enkelt att testa en slutpunkt med en bearer-token som genererats med Adobe Developer Console.
Informativa guider, inklusive API-koncept och syntax.
En självstudiekurs på den översta nivån som beskriver autentiseringsmetoder och andra koncept.
En självstudiekurs med video som fokuserar på hur du konfigurerar OpenAPI-baserade API:er.
En självstudiekurs från början till slut om hur du konfigurerar och anropar OpenAPI:er med autentiseringsstrategin server-till-server. Liknande självstudiekurser finns också för autentiseringsmetoderna Web App och Single Page Application.

Konfigurera API-åtkomst configuring-api-access

Vissa OpenAPI-baserade AEM-API:er behöver autentiseras, vilket kräver att autentiseringsuppgifter genereras med Adobe Developer Console. Konfiguration omfattar följande steg:

Modernisering av AEM as a Cloud Service. Mer information finns i Modernisering av AEM as a Cloud Service-miljön - självstudiekurs.
Ge åtkomst till AEM API:er med produktprofiler. Produktprofiler är kopplade till de tjänster som representerar AEM användargrupper med fördefinierade åtkomstkontrollistor (ACL). Vissa tjänster är som standard associerade med specifika produktprofiler, men andra måste uttryckligen kopplas. AEM Assets API-användartjänst är till exempel inte associerad med någon produktprofil, så du måste aktivera den för att kunna använda AEM Assets API. Mer information finns i Aktivera åtkomst till AEM API:er självstudiekurs.
Om du vill lägga till server-till-server-autentisering måste den användare som ställer in integreringen vara organisationens systemadministratör i Adobe Admin Console eller läggas till som utvecklare i den produktprofil där tjänsten är kopplad. Mer information finns i Aktivera åtkomst till AEM API:er självstudiekurs.
Skapa ett Adobe Developer Console-projekt (ADC).
Konfigurera ADC-projektet. Detta genererar autentiseringsuppgifter som ska användas senare för utbyte mot en innehavartoken när API anropas.
Konfigurera AEM-instansen för att aktivera ADC-projektkommunikation. Detta innebär att registrera klient-ID:t i miljön genom att konfigurera och distribuera en YAML-fil, vilket beskrivs i avsnittet Registrera ett klient-ID nedan.

Detaljerade stegvisa instruktioner finns i självstudiekursen Konfigurera OpenAPI-baserade API:er.

Registrera ett klient-ID registering-a-client-id

Klient-ID:n omfattar API:erna i ett Adobe Developer Console-projekt för specifika AEM-miljöer. Detta uppnås på följande sätt:

Skapa en fil med namnet api.yaml eller liknande med en konfiguration som fragmentet nedan, inklusive önskade nivåer (författare, publicering, förhandsgranskning). Client_id värden ska komma från dina Adobe Developer Console API-projekt.

Egenskaperna kind, version och metadata beskrivs i artikeln Konfigurera pipeline. Egenskapsvärdet kind ska anges till API och egenskapen version ska anges till 1.

code language-none
`kind: "API" version: "1" metadata: envTypes: ["dev"] data: allowedClientIDs: author: - "<client_id>" publish: - "<client_id>" preview: - "<client_id>"`

Placera filen någonstans under en mapp på den översta nivån med namnet config eller liknande, enligt beskrivningen under Konfigurera pipeline.
För andra miljötyper än RDE (som använder kommandoradsverktyg) skapar du en riktad distributionskonfigurationspipeline i Cloud Manager, enligt referens i det här avsnittet i artikeln Config Pipeline. Observera att pipelines för fullständig stapel och webbnivå inte distribuerar konfigurationsfilen.
Distribuera konfigurationen.

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab