Panoramica delle API di AEM aem-apis-overview

Scopri i diversi tipi di API in Adobe Experience Manager (AEM) e quali API scegliere per l’integrazione.

Per creare, leggere, aggiornare ed eliminare contenuti, risorse e moduli in AEM, gli sviluppatori possono utilizzare un’ampia gamma di API. Queste API consentono agli sviluppatori di creare applicazioni personalizzate che interagiscono con AEM.

Esaminiamo i diversi tipi di API in AEM e capiamo quale API scegliere per l’integrazione.

Tipi di API di AEM types-of-aem-apis

AEM offre le seguenti API per interagire con i suoi tipi di servizi Author e Publish.

Tipo di API di AEM
Descrizione
Disponibilità
Caso d’uso
Esempi di API
API AEM basate su OpenAPI
API standardizzate e leggibili da dispositivo automatico per Assets, Sites e Forms.
Solo AEM as a Cloud Service
Sviluppo API-first, applicazioni moderne
API Autore Assets, API Cartelle, API AEM Sites, API Forms Document Services e altri
API RESTful
Endpoint REST tradizionali per l’interazione con le risorse AEM.
AEM 6.X, AEM as a Cloud Service
Operazioni CRUD, applicazioni moderne
API HTTP Assets, API REST flusso di lavoro, Esportatore JSON per Content Services e altri
API di GraphQL
Ottimizzato per recuperare in modo efficiente i contenuti strutturati con query flessibili.
AEM 6.X, AEM as a Cloud Service
CMS headless, SPA, app per dispositivi mobili
API GraphQL
API tradizionali (non RESTful)
API meno recenti come JCR, modelli Sling, Query Builder e altri.
AEM 6.X, AEM as a Cloud Service
Integrazioni legacy, compatibilità con le versioni precedenti
API Query Builder e altri

Per ulteriori dettagli, visita la pagina API Adobe Experience Manager as a Cloud Service.

Quale API scegliere which-api-to-choose

Quando selezioni un’API per l’integrazione, considera i seguenti fattori:

  • Caso d'uso: verifica se l'API AEM supporta il tuo caso d'uso. Quando possibile, utilizza API AEM basate su OpenAPI, in quanto forniscono un approccio standardizzato e moderno all'interazione con AEM. Se le API basate su OpenAPI non sono disponibili, è consigliabile utilizzare le API RESTful o GraphQL e, come ultima risorsa, le API tradizionali.

  • Compatibilità: verifica che l'API selezionata sia compatibile con la versione di AEM in uso. Ad esempio, Le API AEM basate su OpenAPI sono esclusive di AEM as a Cloud Service e non sono disponibili in AEM 6.X.

  • Tipo di servizio AEM: Autore vs. Pubblicazione: la scelta dell'API dipende anche dal fatto che venga eseguita sul servizio Author o Publish, in quanto i loro modelli di accesso sono diversi. Il servizio AEM Author viene utilizzato per la creazione di contenuti e richiede sempre l’autenticazione. Il servizio di pubblicazione di AEM viene utilizzato per la distribuzione dei contenuti e potrebbe non richiedere l’autenticazione, a seconda del caso d’uso.

  • Autenticazione: verificare che l'API supporti il metodo di autenticazione che si intende utilizzare. Ad esempio:

    • API AEM basate su OpenAPI: supportano l'autenticazione OAuth 2.0, incluse le credenziali client (server-to-server), il codice di autorizzazione (app Web) e i tipi di concessione Proof Key for Code Exchange (app a pagina singola). Altre API di AEM non supportano l’autenticazione OAuth 2.0.
    • API RESTful: supportano l'autenticazione JSON Web Token (JWT), nota anche come autenticazione basata su token.

Differenza tra JSON Web Token (JWT) e OAuth 2.0 difference-between-jwt-and-oauth

Confrontiamo JSON Web Token (JWT) e OAuth 2.0, due meccanismi di autenticazione comuni utilizzati nelle API di AEM:

Funzione
Token web JSON (JWT)
OAuth 2.0
Utilizzato in
API RESTful
API AEM basate su OpenAPI (non supportate nelle API RESTful o di altro tipo)
Scopo
Autenticazione del servizio
Autenticazione utente o servizio
Interazione utente
Non è richiesta alcuna interazione da parte dell’utente
Interazione utente richiesta per i tipi di concessione Codice di autorizzazione e App a pagina singola
Ideale per
Chiamate API server-to-server
Accesso sicuro e consentito per app e utenti
Informazioni richieste
Chiave privata per la firma JWT
ID client e segreto client per OAuth 2.0
Scadenza token
Breve durata, spesso necessita di aggiornamento
Il token di accesso è di breve durata. Il token di aggiornamento ha una lunga durata e viene utilizzato per ottenere un nuovo token di accesso
Gestione credenziali
AEM Developer Console
Adobe Developer Console

API AEM basate su OpenAPI

Ulteriori informazioni sulle API AEM basate su OpenAPI e sui concetti importanti relativi all'accesso alle API Adobe sono disponibili nella guida API AEM basate su OpenAPI.

Casi d’uso

Richiama API tramite autenticazione server-to-server

Richiama API tramite autenticazione server-to-server

Scopri come richiamare le API AEM basate su OpenAPI da un’applicazione NodeJS personalizzata utilizzando l’autenticazione server-to-server di OAuth.

Ulteriori informazioni

Richiama l’API tramite l’autenticazione tramite app web

Richiama l'API tramite l'autenticazione dell'app Web

Scopri come richiamare le API AEM basate su OpenAPI da un’applicazione web personalizzata utilizzando l’autenticazione OAuth Web App.

Ulteriori informazioni

Richiama API tramite app a pagina singola OAuth

Richiama API tramite l'app a pagina singola OAuth

Scopri come richiamare le API AEM basate su OpenAPI da un’app a pagina singola personalizzata (SPA) utilizzando il flusso PKCE di OAuth 2.0.

Ulteriori informazioni

API di GraphQL - Esempi

Ulteriori informazioni sulle API di GraphQL e su come utilizzarle nella Guida introduttiva ad AEM Headless - GraphQL

Casi d’uso

Applicazione a pagina singola

Applicazione a pagina singola

Scopri come creare un’applicazione a pagina singola che recupera contenuti da AEM utilizzando le API di GraphQL.

Ulteriori informazioni

App mobile

App mobile

Scopri come creare un’app mobile che recuperi contenuti da AEM utilizzando le API di GraphQL.

Ulteriori informazioni

Componente Web

Componente Web

Scopri come creare un componente web che recupera contenuti da AEM utilizzando le API di GraphQL.

Ulteriori informazioni

API RESTful - Esempi

Ulteriori informazioni sulle API RESTful, ad esempio Assets HTTP API e JSON Exporter.

Casi d’uso

Utilizzo di Content Services per l’app headless

Utilizzo di Content Services per l'app headless

Scopri come creare un’app mobile nativa che recuperi contenuti da AEM utilizzando le API RESTful di Content Services.

Ulteriori informazioni

Autenticazione basata su token per le API RESTful

Autenticazione basata su token per le API RESTful

Scopri come richiamare le API RESTful utilizzando l’autenticazione JSON Web Token (JWT).

Ulteriori informazioni

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