DocumentazioneAEM as a Cloud ServiceGuida utente

API basate su OpenAPI openapi-based-apis

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

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 configuring-api-access

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 tramite i profili di prodotto.
  3. Creazione di un progetto Adobe Developer Console (ADC).
  4. Configura il progetto ADC. Questo genera credenziali che verranno utilizzate successivamente per scambiarle con un token Bearer quando si richiama l’API.
  5. 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.

Registrazione di un ID client registering-a-client-id

Gli ID client eseguono l’ambito delle API in un progetto Adobe Developer Console in ambienti AEM specifici. Ciò si ottiene come segue:

  1. Creare un file denominato api.yaml o simile con una configurazione come lo snippet sottostante, inclusi i livelli desiderati (authoring, pubblicazione, anteprima). I valori Client_id devono provenire dai progetti API di Adobe Developer Console.

    Le proprietà kind, version e metadata sono descritte nell'articolo Pipeline di configurazione. Il valore della proprietà kind deve essere impostato su API e la proprietà version su 1.

    code language-none 
    kind: "API"
version: "1"
metadata:
  envTypes: ["dev"]
data:
  allowedClientIDs:
    author:
      - "<client_id>"
    publish:
      - "<client_id>"
    preview:
      - "<client_id>"

  2. Posizionare il file in una cartella di primo livello denominata config o simile, come descritto in Pipeline di configurazione.

  3. Per tipi di ambiente diversi da RDE (che utilizza strumenti della riga di comando), crea una pipeline di configurazione della distribuzione di destinazione in Cloud Manager, come indicato da questa sezione nell'articolo Pipeline di configurazione. Tieni presente che le pipeline full stack e le pipeline a livello web non distribuiscono il file di configurazione.

  4. Distribuisci la configurazione.

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab