DocumentazioneAEM as a Cloud ServiceGuida utente

API basate su OpenAPI openapi-based-apis

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Amministratore
  • Sviluppatore
NOTE
OpenAPI sono disponibili come parte di un programma di accesso anticipato. Se ti interessa accedervi, ti invitiamo a inviare un'e-mail a aem-apis@adobe.com con una descrizione del tuo caso d'uso.

Le API di AEM as a Cloud Service più recenti seguono le specifiche OpenAPI e producono quindi API coerenti, ben documentate e di facile utilizzo. Informazioni approfondite sono disponibili nelle pagine seguenti:

Un caso d’uso API comune prevede 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 dall'AEM, che possono attivare la logica di business in Adobe App Builder o in altre infrastrutture.

I tipi di autenticazione API supportati variano a seconda dell’endpoint, ma possono essere server-to-server OAuth, app Web OAuth e app a pagina singola OAuth (SPA).

NOTE
Il tutorial end-to-end è una risorsa consigliata per imparare a configurare e richiamare le API AEM basate su OpenAPI.

Configurazione dell’accesso API configuring-api-access

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

  1. Assicurati che i profili di prodotto del tuo programma AEM siano aggiornati e che sia abilitato un servizio appropriato per accedere all'API desiderata.
  2. Crea un nuovo progetto in Adobe Developer Console e aggiungi le API desiderate al progetto, selezionando anche il tipo di autenticazione appropriato.
  3. Genera le credenziali, che verranno successivamente utilizzate per scambiare un token Bearer quando si richiama l’API.
  4. Registra l’ID client con l’ambiente configurando un file YAML, distribuito utilizzando la pipeline di configurazione (o riga di comando per gli RDE).

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

Gli ID client hanno come ambito le API di un progetto Adobe Developer Console per 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