DocumentazioneAEMTutorial su AEMTutorial su AEM as a Cloud Service

Configurare le API AEM basate su OpenAPI

Last update: Thu Apr 17 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:
  • Sviluppo

Creato per:

  • Principiante
  • Sviluppatore
  • Leader

Scopri come configurare l’ambiente AEM as a Cloud Service per abilitare l’accesso alle API AEM basate su OpenAPI.

video poster

https://video.tv.adobe.com/v/3457510?quality=12&learn=on

Il processo di configurazione ad alto livello prevede le seguenti fasi:

  1. Modernizzazione dell’ambiente AEM as a Cloud Service.
  2. Abilita l’accesso alle API di AEM.
  3. Crea progetto Adobe Developer Console (ADC).
  4. Configura progetto ADC.
  5. Configura l’istanza di AEM per abilitare la comunicazione al progetto ADC.

Modernizzazione dell’ambiente AEM as a Cloud Service

La modernizzazione dell’ambiente AEM as a Cloud Service è un’attività una tantum per ogni ambiente che prevede i seguenti passaggi:

  • Aggiornamento ad AEM versione 2024.10.18459.20241031T210302Z o successiva.
  • Aggiungi nuovi profili di prodotto, se l’ambiente è stato creato prima della versione 2024.10.18459.20241031T210302Z.

Aggiorna istanza AEM

Per aggiornare l'istanza di AEM, nella sezione Ambienti di Adobe Cloud Manager, seleziona l'icona puntini di sospensione accanto al nome dell'ambiente e seleziona l'opzione Aggiorna.

Aggiorna istanza AEM

Quindi fai clic sul pulsante Invia ed esegui la pipeline suggerita Fullstack.

Seleziona la versione più recente di AEM

Nel mio caso, la pipeline full stack si chiama Dev :: Fullstack-Deploy e l'ambiente AEM si chiama wknd-program-dev. I tuoi nomi possono essere diversi.

Aggiungere nuovi profili di prodotto

Per aggiungere nuovi profili di prodotto all'istanza di AEM, nella sezione Ambienti di Adobe Cloud Manager, seleziona l'icona puntini di sospensione accanto al nome dell'ambiente e l'opzione Aggiungi profili di prodotto.

Aggiungi nuovi profili di prodotto

Puoi rivedere i profili di prodotto appena aggiunti facendo clic sull'icona puntini di sospensione accanto al nome dell'ambiente e selezionando Gestisci accesso > Profili autore.

Nella finestra Admin Console sono visualizzati i profili di prodotto appena aggiunti.

Verifica nuovi profili di prodotto

I passaggi precedenti completano la modernizzazione dell’ambiente AEM as a Cloud Service.

Abilita accesso alle API di AEM

La presenza di nuovi profili di prodotto abilita l'accesso API AEM basato su OpenAPI in Adobe Developer Console (ADC). Ricorda che Adobe Developer Console (ADC) è l'hub di sviluppo per accedere alle API di Adobe, agli SDK, agli eventi in tempo reale, alle funzioni senza server e altro ancora.

I nuovi profili di prodotto aggiunti sono associati ai Servizi che rappresentano gruppi di utenti AEM con elenchi di controllo di accesso (ACL) predefiniti. I servizi vengono utilizzati per controllare il livello di accesso alle API di AEM.

Puoi anche selezionare o deselezionare i servizi associati al profilo prodotto per ridurre o aumentare il livello di accesso.

Rivedi l'associazione facendo clic sull'icona Visualizza dettagli accanto al nome del profilo di prodotto.

Servizi di revisione associati al profilo di prodotto

Per impostazione predefinita, il servizio Utenti API AEM Assets non è associato ad alcun profilo di prodotto. Associamolo al profilo di prodotto Utenti AEM Assets Collaborator - Autore - Programma XXX - Ambiente XXX appena aggiunto. Dopo questa associazione, l'API Asset Author del progetto ADC può impostare l'autenticazione server-to-server desiderata e associare l'account di autenticazione dal progetto ADC (creato nel passaggio successivo) al profilo di prodotto.

Associa il servizio Utenti API di AEM Assets al profilo di prodotto

IMPORTANT
Il passaggio precedente è fondamentale per abilitare l’autenticazione server-to-server per l’API di AEM Assets. Senza questa associazione, l’API di AEM Assets non può essere utilizzata con il metodo di autenticazione server-to-server.

Crea progetto Adobe Developer Console (ADC)

Il progetto ADC viene utilizzato per aggiungere le API desiderate, configurarne l’autenticazione e associare l’account di autenticazione al profilo di prodotto.

Per creare un progetto ADC:

  1. Accedi a Adobe Developer Console utilizzando il tuo Adobe ID.

    Adobe Developer Console

  2. Dalla sezione Guida rapida, fare clic sul pulsante Crea nuovo progetto.

    Crea nuovo progetto

  3. Crea un nuovo progetto con il nome predefinito.

    Nuovo progetto creato

  4. Modifica il nome del progetto facendo clic sul pulsante Modifica progetto nell'angolo in alto a destra. Specifica un nome significativo e fai clic su Salva.

    Modifica nome progetto

Configura progetto ADC

Dopo aver creato il progetto ADC, devi aggiungere le API AEM desiderate, configurarne l’autenticazione e associare l’account di autenticazione al profilo di prodotto.

  1. Per aggiungere le API di AEM, fai clic sul pulsante Aggiungi API.

    Aggiungi API

  2. Nella finestra di dialogo Aggiungi API, filtra per Experience Cloud e seleziona l'API AEM desiderata. Ad esempio, in questo caso, è selezionata l'API Asset Author.

    Aggiungi API AEM

  3. Quindi, nella finestra di dialogo Configura API, seleziona l'opzione di autenticazione desiderata. In questo caso, ad esempio, è selezionata l'opzione di autenticazione Server-to-Server.

    Seleziona autenticazione

    L’autenticazione server-to-server è ideale per i servizi back-end che richiedono accesso API senza interazione da parte dell’utente. Le opzioni di autenticazione dell’app web e dell’app a pagina singola sono adatte per le applicazioni che necessitano dell’accesso API per conto degli utenti. Per ulteriori informazioni, vedere Differenza tra le credenziali server-to-server OAuth e app Web rispetto alle credenziali app a pagina singola.

  4. Se necessario, puoi rinominare l’API per facilitarne l’identificazione. A scopo dimostrativo, viene utilizzato il nome predefinito.

    Rinomina credenziali

  5. In questo caso, il metodo di autenticazione è OAuth Server-to-Server, pertanto è necessario associare l'account di autenticazione al profilo di prodotto. Seleziona il profilo di prodotto Utenti AEM Assets Collaborator - Autore - Programma XXX - Ambiente XXX e fai clic su Salva.

    Seleziona profilo prodotto

  6. Controlla l’API di AEM e la configurazione dell’autenticazione.

    Configurazione API AEM

    Configurazione autenticazione

Se si sceglie il metodo di autenticazione OAuth Web App o OAuth Single Page App, l'associazione del profilo di prodotto non viene richiesta, ma è necessario l'URI di reindirizzamento dell'applicazione. L’URI di reindirizzamento dell’applicazione viene utilizzato per reindirizzare l’utente all’applicazione dopo l’autenticazione con un codice di autorizzazione. Le esercitazioni sui casi d’uso pertinenti descrivono tali configurazioni specifiche per l’autenticazione.

Configura l’istanza di AEM per abilitare la comunicazione del progetto ADC

Per abilitare l’ID client del progetto ADC alla comunicazione con l’istanza AEM, devi configurare l’istanza AEM.

Questa operazione viene eseguita definendo la configurazione API in un file YAML e distribuendola utilizzando la pipeline di configurazione in Cloud Manager. Il file YAML definisce gli ID client consentiti dal progetto ADC in grado di comunicare con l’istanza di AEM.

  1. In AEM Project individuare o creare il file api.yaml dalla cartella config.

    Individua API YAML

  2. Aggiungi la seguente configurazione al file api.yaml.

    kind: "API"
version: "1.0"
metadata:
    envTypes: ["dev", "stage", "prod"]
data:
    allowedClientIDs:
        author:
        - "<ADC Project's Credentials ClientID>"

    Sostituire <ADC Project's Credentials ClientID> con l'ID client effettivo del valore Credenziali del progetto ADC. L'endpoint API utilizzato in questa esercitazione è disponibile solo sul livello di authoring, ma per altre API la configurazione yaml può avere anche un nodo publish o preview.

    CAUTION
    A scopo dimostrativo, viene utilizzato lo stesso ClientID per tutti gli ambienti. Si consiglia di utilizzare un ClientID separato per ogni ambiente (dev, stage, prod) per migliorare la sicurezza e il controllo.

  3. Apporta le modifiche alla configurazione e le invia all’archivio Git remoto a cui è connessa la pipeline Cloud Manager.

  4. Distribuisci le modifiche precedenti utilizzando la pipeline di configurazione in Cloud Manager. Il file api.yaml può essere installato anche in un RDE, utilizzando gli strumenti della riga di comando.

    Distribuisci YAML

Passaggi successivi

Una volta configurata l’istanza di AEM per abilitare la comunicazione con il progetto ADC, puoi iniziare a utilizzare le API AEM basate su OpenAPI. Scopri come utilizzare le API AEM basate su OpenAPI utilizzando diversi metodi di autenticazione OAuth:

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 autenticazione app a pagina singola

Richiama API tramite autenticazione app a pagina singola

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

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