API basate su OpenAPI

Ultimo aggiornamento: 15 maggio 2025
  • Si applica a:
  • Experience Manager as a Cloud Service

Creato per:

  • Amministratore
  • Sviluppatore

Le API di AEM as a Cloud Service più recenti seguono le specifiche OpenAPI e offrono quindi un set di API coerente e ben documentato.

NOTE
Un tutorial end-to-end è una risorsa consigliata per scoprire come configurare e richiamare le API AEM basate su OpenAPI.

Per gli endpoint che richiedono l’autenticazione, l’approccio all’autenticazione varia in base all’endpoint, ma può utilizzare OAuth Server-to-Server, OAuth Web App o OAuth Single Page App (SPA). Le credenziali sono configurate tramite progetti in Adobe Developer Console.

Casi d’uso comuni dell’API includono integrazioni con sistemi come un CRM o un PIM, in cui le API AEM vengono richiamate per recuperare o mantenere i dati. Come parte dell'implementazione dell'integrazione, le applicazioni possono sottoscrivere eventi emessi da AEM, che possono attivare la logica di business in Adobe App Builder o in altre infrastrutture.

Questo documento funge da panoramica, ma la documentazione più dettagliata è disponibile nelle pagine seguenti:

  • I collegamenti dalla sezione API basata su OpenAPI di documentazione di riferimento. Ogni documentazione di riferimento dell’API include anche un ambiente playground API, che consente di provare facilmente un endpoint utilizzando un token bearer generato con Adobe Developer Console.

  • Guide informative, inclusi concetti e sintassi API.

  • Un tutorial di primo livello che descrive approcci all'autenticazione e altri concetti.

  • Un tutorial con video incentrato su come configurare le API basate su OpenAPI.

  • Un'esercitazione end-to-end sulla configurazione e la chiamata di OpenAPI con la strategia di autenticazione server-to-server. Esercitazioni simili sono disponibili anche per gli approcci di autenticazione tramite app web e applicazioni a pagina singola.

Configurazione dell’accesso API

Alcune API AEM basate su OpenAPI richiedono l'autenticazione, che richiede la generazione di credenziali tramite Adobe Developer Console. La configurazione prevede i seguenti passaggi:

  1. Modernizzazione dell’ambiente AEM as a Cloud Service.
  2. Abilita l’accesso alle API di AEM utilizzando i profili di prodotto. I profili di prodotto sono associati ai servizi che rappresentano i gruppi di utenti di AEM con elenchi di controllo di accesso (ACL, Access Control List) predefiniti. Mentre alcuni servizi sono associati a profili di prodotto specifici per impostazione predefinita, altri devono essere associati in modo esplicito; ad esempio, il servizio Utenti API di AEM Assets non è associato ad alcun profilo di prodotto, pertanto devi abilitarlo per utilizzare l'API di AEM Assets. Per ulteriori informazioni, consulta il passaggio tutorial Abilita accesso alle API di AEM.
  3. Per aggiungere l’autenticazione server-to-server, l’utente che configura l’integrazione deve essere l’amministratore di sistema dell’organizzazione in Adobe Admin Console oppure deve essere aggiunto come sviluppatore al profilo di prodotto a cui è associato il servizio. Per ulteriori informazioni, consulta il passaggio tutorial Abilita accesso alle API di AEM.
  4. Creazione di un progetto Adobe Developer Console (ADC).
  5. Configura il progetto ADC. Questo genera credenziali che verranno utilizzate successivamente per scambiarle con un token Bearer quando si richiama l’API.
  6. Configura l’istanza di AEM per abilitare la comunicazione al progetto ADC. Ciò comporta la registrazione dell'ID client con l'ambiente configurando e distribuendo un file YAML, come descritto nella sezione Registrazione di un ID client di seguito.

Per istruzioni dettagliate, consulta l'esercitazione Configurare API basate su OpenAPI.