Dokumentation AEM as a Cloud Service Användarhandbok

OpenAPI-baserade API:er openapi-based-apis

Last update: Fri Nov 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Ämnen:
Utveckling

Skapat för:

Administratör
Utvecklare

NOTE

OpenAPI:er är tillgängliga som en del av ett program för tidig åtkomst. Om du är intresserad av att få tillgång till dem bör du skicka ett e-postmeddelande till aem-apis@adobe.com med en beskrivning av ditt användningsfall.

Nyare AEM as a Cloud Service-API:er följer OpenAPI-specifikationen och producerar därmed konsekventa, väldokumenterade och användarvänliga API:er. Detaljerad information finns på följande sidor:

En heltäckande självstudiekurs om hur du konfigurerar och anropar OpenAPI-baserade AEM-API:er.
Informativa guider, inklusive API-koncept och syntax.
API-slutpunktens referensdokumentation, där vissa API:er är OpenAPI-baserade, till exempel den här webbplats-API:n. Referensdokumentationen innehåller också en API-spelningsbakgrund, som gör det enkelt att testa en slutpunkt med en innehavartoken som genererats med Adobe Developer Console.

Ett vanligt API-exempel omfattar integrering med system som CRM eller PIM, där AEM API anropas för att hämta eller behålla data. Som en del av integreringsimplementeringen kan program prenumerera på AEM-utsända händelser som kan utlösa affärslogik i Adobe App Builder eller annan infrastruktur.

De API-autentiseringstyper som stöds skiljer sig åt beroende på slutpunkten, men kan vara OAuth Server-to-Server, OAuth Web App och OAuth Single Page App (SPA).

NOTE

Självstudiekursen från början till slut rekommenderas för att lära dig hur du konfigurerar och anropar OpenAPI-baserade AEM API:er.

Konfigurera API-åtkomst configuring-api-access

Många OpenAPI-baserade AEM-API:er kräver autentisering, vilket kräver att autentiseringsuppgifter genereras med Adobe Developer Console. Konfiguration omfattar följande steg, som visas i självstudiekursen:

Se till att ditt AEM produktprofiler uppdateras och att en lämplig tjänst är aktiverad för att komma åt det önskade API:t.
Skapa ett nytt projekt i Adobe Developer Console och lägg till önskade API:er i projektet, och välj även lämplig autentiseringstyp.
Generera autentiseringsuppgifterna, som senare kommer att användas för utbyte av en innehavartoken när API anropas.
Registrera klient-ID:t i miljön genom att konfigurera en YAML-fil som distribueras med Config Pipeline (eller kommandorad för RDE:er).

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

Klient-ID:n omfattar åtkomstpunkten i ett Adobe Developer Console-projekt för specifika AEM. 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