Overzicht van AEM API's aem-apis-overview

Leer meer over de verschillende typen API's in Adobe Experience Manager (AEM) en begrijp welke API u moet kiezen voor uw integratie.

Ontwikkelaars kunnen een groot aantal API's gebruiken om inhoud, elementen en formulieren in AEM te maken, lezen, bij te werken en te verwijderen. Met deze API's kunnen ontwikkelaars aangepaste toepassingen maken die communiceren met AEM.

Laten we de verschillende typen API's in AEM bekijken en begrijpen welke API u voor uw integratie moet kiezen.

Typen AEM API's types-of-aem-apis

AEM biedt de volgende API's aan voor interactie met de auteur en voor het publiceren van servicetypen.

AEM API-type
Beschrijving
Beschikbaarheid
Hoofdletters gebruiken
API-voorbeelden
AEM API's die zijn gebaseerd op OpenAPI
Gestandaardiseerde, machineleesbare API's voor Assets, Sites en Forms.
slechts AEM as a Cloud Service
API-eerste ontwikkeling, moderne toepassingen
de Auteur API van Assets, Omslagen API, AEM Sites API, de Diensten API van het Document van Formsen anderen
RESTful-API's
Traditionele REST-eindpunten voor interactie met AEM-bronnen.
AEM 6.X, AEM as a Cloud Service
CRUD-bewerkingen, moderne toepassingen
HTTP API van Assets, het REST API van het Werkschema, Exporter JSON voor de Diensten van de Inhouden anderen
GraphQL API's
Geoptimaliseerd voor het efficiënt ophalen van gestructureerde inhoud met flexibele query's.
AEM 6.X, AEM as a Cloud Service
CMS, SPA's, mobiele apps zonder koppen
GraphQL API
Traditionele (niet-RESTful) API's
Oudere API's zoals JCR, Sling Models, Query Builder en andere.
AEM 6.X, AEM as a Cloud Service
Verouderde integratie, achterwaartse compatibiliteit
de Bouwer API van de Vraagen anderen

Voor meer details, zie de Adobe Experience Manager as a Cloud Service APIspagina.

Welke API moet worden gekozen which-api-to-choose

Houd rekening met de volgende factoren wanneer u een API voor uw integratie selecteert:

  • Geval van het Gebruik: Bepaal of AEM API uw gebruiksgeval steunt. Waar mogelijk, gebruik op openAPI-Gebaseerde AEM APIs, aangezien zij een gestandaardiseerde, moderne benadering verstrekken om met AEM in wisselwerking te staan. Als API's op basis van OpenAPI's niet beschikbaar zijn, kunt u overwegen RESTful API's of GraphQL API's te gebruiken en als laatste redmiddel traditionele API's.

  • Verenigbaarheid: Zorg ervoor dat geselecteerde API met uw versie van AEM compatibel is. Bijvoorbeeld, op openAPI-Gebaseerde AEM APIs zijn exclusief aan AEM as a Cloud Service en zijn niet beschikbaar in AEM 6.X.

  • het Type van Dienst van AEM: Auteur vs. publiceer: De keus van API hangt ook van af of het op de Auteur of de Publish dienst loopt, aangezien hun toegangsmodellen verschillend zijn. De AEM Author-service wordt gebruikt voor het maken van inhoud en vereist altijd verificatie. De AEM-publicatieservice wordt gebruikt voor de levering van inhoud en vereist mogelijk geen verificatie, afhankelijk van het gebruiksgeval.

  • Authentificatie: Verifieer dat API de authentificatiemethode steunt u van plan bent te gebruiken. Bijvoorbeeld:

    • op openAPI-Gebaseerde AEM APIs: steun OAuth 2.0 authentificatie, met inbegrip van de Ontvankelijkheden van de Cliënt (server-aan-server), de Code van de Vergunning (de Toepassing van het Web), en Sleutel van het Bewijs voor de Uitwisseling van de Code (Enige App van de Pagina) subsidietypes. Andere AEM API's bieden geen ondersteuning voor OAuth 2.0-verificatie.
    • RESTful APIs: steun de Symbolische authentificatie van het Web JSON (JWT), weet ook als symbolisch-gebaseerde authentificatie.

Verschil tussen JSON Web Token (JWT) en OAuth 2.0 difference-between-jwt-and-oauth

Vergelijk JSON Web Token (JWT) en OAuth 2.0, twee gemeenschappelijke authentificatiemechanismen die in AEM APIs worden gebruikt:

Functie
JSON Web Token (JWT)
OAuth 2.0
Gebruikt in
RESTful-API's
AEM API's die zijn gebaseerd op OpenAPI's (niet ondersteund in RESTful of andere API's)
Doel
Serviceverificatie
Gebruiker- of serviceverificatie
Gebruikersinteractie
Geen gebruikersinteractie vereist
Gebruikersinteractie vereist voor machtigingscode en toepassingstypen voor één pagina
Meest geschikt voor
Server-aan-server API vraag
Beveiligde, geoorloofde toegang voor apps en gebruikers
Vereiste informatie
Persoonlijke sleutel voor ondertekening van JWT
Client ID and Client Secret for OAuth 2.0
Tokenvervaldatum
Kortstondig en vaak vernieuwbaar
Het toegangstoken is van korte duur. Vernieuwt-teken is lang en gebruikt om een nieuw toegang-token te krijgen
Credentials Management
AEM Developer Console
Adobe Developer Console

AEM API's die zijn gebaseerd op OpenAPI

Leer meer over OpenAPI-Gebaseerde AEM APIs en de belangrijke concepten om tot Adobe APIs in de op OpenAPI-Gebaseerde gids van AEM toegang te hebben APIs.

Gevallen gebruiken

API aanroepen met Server-naar-server verificatie

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.

Leer meer

API aanroepen met webtoepassingsverificatie

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.

Leer meer

API aanroepen met OAuth-app voor één pagina

OAuth roepen API

Leer hoe u op OpenAPI gebaseerde AEM API's aanroept vanuit een aangepaste Single Page App (SPA) met OAuth 2.0 PKCE-stroom.

Leer meer

GraphQL API's - Voorbeelden

Leer meer over GraphQL APIs en hoe te om hen in te gebruiken die met de Zetel van AEM worden begonnen - GraphQL

Gevallen gebruiken

Single Page Application (SPA)

Enige Toepassing van de Pagina (SPA)

Leer hoe u een toepassing voor één pagina (SPA) maakt die inhoud van AEM ophaalt met behulp van GraphQL API's.

Leer meer

Mobiele app

Mobiele Toepassing

Leer hoe u een mobiele app maakt die inhoud van AEM ophaalt met GraphQL API's.

Leer meer

Webcomponent

Component van het Web

Leer hoe u een webcomponent maakt die inhoud van AEM ophaalt met GraphQL API's.

Leer meer

RESTful-API's - Voorbeelden

Leer meer over RESTful APIs, zoals HTTP API van Assetsen JSON Exporter.

Gevallen gebruiken

Inhoudsservices gebruiken voor Headless App

Gebruikend de Diensten van de Inhoud voor Hoofdloze App

Leer hoe u een systeemeigen mobiele app maakt die inhoud van AEM ophaalt met RESTful-API's van Content Services.

Leer meer

Token-based Authentificatie voor RESTful APIs

Op token-gebaseerde Authentificatie voor RESTful APIs

Leer hoe u RESTful API's aanroept met JSON Web Token (JWT)-verificatie.

Leer meer

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