Configurare le API AEM basate su OpenAPI
Scopri come configurare l’ambiente AEM as a Cloud Service per abilitare l’accesso alle API AEM basate su OpenAPI.
In questo esempio, per illustrare il processo di configurazione viene utilizzata l’API di AEM Assets che utilizza il metodo di autenticazione server-to-server. Gli stessi passaggi possono essere seguiti per altre API AEM basate su OpenAPI.
Il processo di configurazione di alto livello prevede i seguenti passaggi:
- Modernizzazione dell’ambiente AEM as a Cloud Service.
- Abilita l’accesso alle API di AEM.
- Crea progetto Adobe Developer Console (ADC).
- Configura progetto ADC.
- Configura l’istanza di AEM per abilitare la comunicazione al progetto ADC.
Modernizzazione dell’ambiente AEM as a Cloud Service modernization-of-aem-as-a-cloud-service-environment
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 update-aem-instance
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.
Quindi fai clic sul pulsante Invia ed esegui la pipeline suggerita Fullstack.
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 add-new-product-profiles
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.
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.
I passaggi precedenti completano la modernizzazione dell’ambiente AEM as a Cloud Service.
Abilita accesso alle API di AEM enable-aem-apis-access
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.
Abilita accesso alle API di AEM Assets enable-aem-assets-apis-access
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 o a qualsiasi altro profilo di prodotto che desideri utilizzare per l'accesso all'API AEM Assets.
Abilita autenticazione server-to-server
Per abilitare l’autenticazione server-to-server per le API di AEM desiderate, è necessario aggiungere come sviluppatore al profilo di prodotto a cui è associato il servizio l’utente che imposta l’integrazione utilizzando Adobe Developer Console (ADC).
Ad esempio, per abilitare l'autenticazione server-to-server per l'API di AEM Assets, l'utente deve essere aggiunto come sviluppatore al profilo di prodotto Utenti di AEM Assets Collaborator - Autore - Programma XXX - Ambiente XXX.
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.
Crea progetto Adobe Developer Console (ADC) adc-project
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:
-
Accedi a Adobe Developer Console utilizzando il tuo Adobe ID.
-
Dalla sezione Guida rapida, fare clic sul pulsante Crea nuovo progetto.
-
Crea un nuovo progetto con il nome predefinito.
-
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.
Configura progetto ADC configure-adc-project
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.
-
Per aggiungere le API di AEM, fai clic sul pulsante Aggiungi API.
-
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.
note tip TIP Se la scheda API AEM desiderata è disabilitata e Perché è disabilitata?Le informazioni di mostrano il messaggio Licenza richiesta uno dei motivi potrebbe essere che NON hai modernizzato l'ambiente AEM as a Cloud Service. Per ulteriori informazioni, consulta Modernizzazione dell'ambiente AEM as a Cloud Service. -
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.
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.
note tip TIP Se l’opzione di autenticazione da server a server non è visibile, significa che l’utente che configura l’integrazione non viene aggiunto come sviluppatore al profilo di prodotto a cui è associato il servizio. Per ulteriori informazioni, vedere Abilitare l'autenticazione server-to-server. -
Se necessario, puoi rinominare l’API per facilitarne l’identificazione. A scopo dimostrativo, viene utilizzato il nome predefinito.
-
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.
-
Controlla l’API di AEM e la configurazione dell’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 configure-aem-instance
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.
-
In AEM Project individuare o creare il file
api.yamldalla cartellaconfig.
-
Aggiungi la seguente configurazione al file
api.yaml.code language-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.note caution 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. -
Apporta le modifiche alla configurazione e le invia all’archivio Git remoto a cui è connessa la pipeline Cloud Manager.
-
Distribuisci le modifiche precedenti utilizzando la pipeline di configurazione in Cloud Manager. Il file
api.yamlpuò essere installato anche in un RDE, utilizzando gli strumenti della riga di comando.
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:
Richiamare l’API tramite autenticazione da server a server
Scopri come richiamare le API AEM basate su OpenAPI da un’applicazione NodeJS personalizzata utilizzando l’autenticazione da server a server di OAuth.
Richiamare l’API tramite l’autenticazione da app web
Scopri come richiamare le API AEM basate su OpenAPI da un’applicazione web personalizzata utilizzando l’autenticazione app web OAuth.
Richiamare l’API tramite l’autenticazione da applicazione 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.