AEM API:er - översikt aem-apis-overview

Lär dig mer om de olika typerna av API:er i Adobe Experience Manager (AEM) och förstå vilket API du ska välja för integreringen.

För att skapa, läsa, uppdatera och ta bort innehåll, resurser och formulär i AEM kan utvecklare använda ett stort antal API:er. Med dessa API:er kan utvecklare skapa anpassade program som interagerar med AEM.

Låt oss utforska de olika typerna av API:er i AEM och förstå vilket API som du ska välja för integreringen.

Typer av AEM API:er types-of-aem-apis

AEM erbjuder följande API:er för interaktion med författare och publiceringstjänster.

AEM API-typ
Beskrivning
Tillgänglighet
Användningsfall
API-exempel
OpenAPI-baserade AEM API:er
Standardiserade, maskinläsbara API:er för Assets, Sites och Forms.
Endast AEM as a Cloud Service
API-utveckling först, moderna program
API:t för Assets-författare, API:t för mappar, API:t för AEM Sites, API:t för Forms Document Services med flera
RESTful API:er
Traditionella REST-slutpunkter för interaktion med AEM-resurser.
AEM 6.X, AEM as a Cloud Service
CRUD-åtgärder, moderna program
Assets HTTP API, REST API för arbetsflöde, JSON Exporter för innehållstjänster med flera
GraphQL API:er
Optimerad för att effektivt hämta strukturerat innehåll med flexibla frågor.
AEM 6.X, AEM as a Cloud Service
Headless CMS, SPA, mobile apps
GraphQL API
Traditionella (icke-RESTful) API:er
Äldre API:er som JCR, Sling Models, Query Builder med flera.
AEM 6.X, AEM as a Cloud Service
Äldre integreringar, bakåtkompatibilitet
API:t för frågebyggaren med flera

Mer information finns på sidan Adobe Experience Manager as a Cloud Service API:er.

Vilken API du ska välja which-api-to-choose

Tänk på följande när du väljer ett API för integreringen:

  • Användningsfall: Kontrollera om AEM-API:t stöder ditt användningsfall. Använd, när det är möjligt, OpenAPI-baserade AEM-API:er eftersom de ger ett standardiserat, modernt sätt att interagera med AEM. Om OpenAPI-baserade API:er inte är tillgängliga bör du använda RESTful API:er eller GraphQL API:er och som en sista utväg även traditionella API:er.

  • Kompatibilitet: Kontrollera att det valda API:t är kompatibelt med din AEM-version. OpenAPI-baserade AEM-API:er är till exempel bara för AEM as a Cloud Service och är inte tillgängliga i AEM 6.X.

  • AEM tjänsttyp: Författare kontra Publicera: Vilken API som ska användas beror också på om den körs på författaren eller publiceringstjänsten, eftersom deras åtkomstmodeller är olika. AEM Author-tjänsten används för att skapa innehåll och kräver alltid autentisering. AEM Publish-tjänsten används för innehållsleverans och behöver kanske inte autentiseras, beroende på användningsfallet.

  • Autentisering: Verifiera att API:t har stöd för den autentiseringsmetod du tänker använda. Till exempel:

    • OpenAPI-baserade AEM-API:er: stöd för OAuth 2.0-autentisering, inklusive klientautentiseringsuppgifter (Server-to-Server), auktoriseringskod (Web App) och korrekturnyckel för tilldelningstyper för kodutbyte (Single Page App). Andra AEM-API:er stöder inte OAuth 2.0-autentisering.
    • RESTful API:er: stöder JSON Web Token-autentisering (JWT) och fungerar även som tokenbaserad autentisering.

Skillnad mellan JSON Web Token (JWT) och OAuth 2.0 difference-between-jwt-and-oauth

Låt oss jämföra JSON Web Token (JWT) och OAuth 2.0, två vanliga autentiseringsmekanismer som används i AEM API

Funktion
JSON Web Token (JWT)
OAuth 2.0
Används i
RESTful API:er
OpenAPI-baserade AEM-API:er (stöds inte i RESTful eller andra API:er)
Syfte
Tjänstautentisering
Autentisering av användare eller tjänst
Användarinteraktion
Ingen användarinteraktion krävs
Användarinteraktion krävs för behörighetskoden och anslagstyperna för Single Page App
Passar bäst för
API-anrop från server till server
Säker, tillåten åtkomst för appar och användare
Nödvändig information
Privat nyckel för signering av JWT
Klient-ID och klienthemlighet för OAuth 2.0
Token förfaller
Kortlivad, behöver ofta uppdateras
Åtkomsttoken är kortlivad. Uppdateringstoken är långvarig och används för att hämta en ny åtkomsttoken
Hantering av autentiseringsuppgifter
AEM Developer Console
Adobe Developer Console

OpenAPI-baserade AEM API:er

Läs mer om de OpenAPI-baserade AEM-API:erna och de viktiga begreppen för att komma åt Adobe-API:er i OpenAPI-baserade AEM API:er .

Användningsexempel

Anropa API med autentisering från server till server

Anropa API med autentisering från server till server

Lär dig hur du anropar OpenAPI-baserade AEM-API:er från ett anpassat NodeJS-program med OAuth Server-till-Server-autentisering.

Läs mer

Anropa API med autentisering i webbapp

Anropa API med autentisering via webbapp

Lär dig hur du anropar OpenAPI-baserade AEM-API:er från ett anpassat webbprogram med OAuth Web App-autentisering.

Läs mer

Anropa API med OAuth Single Page App

Anropa API med OAuth Single Page App

Lär dig hur du anropar OpenAPI-baserade AEM-API:er från en anpassad Single Page App (SPA) med OAuth 2.0 PKCE-flöde.

Läs mer

GraphQL API:er - exempel

Läs mer om GraphQL API:er och hur du använder dem i Komma igång med AEM Headless - GraphQL

Användningsexempel

Single Page Application (SPA)

Single Page Application (SPA)

Lär dig hur du skapar ett SPA-program (Single Page Application) som hämtar innehåll från AEM med GraphQL API:er.

Läs mer

Mobilapp

Mobilapp

Lär dig hur du skapar en mobilapp som hämtar innehåll från AEM med GraphQL API:er.

Läs mer

Webbkomponent

Webbkomponent

Lär dig hur du skapar en webbkomponent som hämtar innehåll från AEM med GraphQL API:er.

Läs mer

RESTful APIs - Exempel

Läs mer om RESTful-API:er, till exempel Assets HTTP API och JSON Exporter.

Användningsexempel

Använda innehållstjänster för Headless-appar

Använda innehållstjänster för den kostnadsfria appen

Lär dig hur du skapar en intern mobilapp som hämtar innehåll från AEM med hjälp av RESTful-API:er i Content Services.

Läs mer

Tokenbaserad autentisering för RESTful API:er

Tokenbaserad autentisering för RESTful API:er

Lär dig hur du anropar RESTful-API:er med JSON Web Token-autentisering (JWT).

Läs mer

recommendation-more-help
4859a77c-7971-4ac9-8f5c-4260823c6f69