Supporto dei frammenti di contenuto nell’API HTTP di AEM Assets

Panoramica

Scopri il supporto per i frammenti di contenuto nell’API HTTP di Assets, una funzione importante AEM consegna headless.

L’ API REST di Assets consente agli sviluppatori di Adobe Experience Manager as a Cloud Service di accedere ai contenuti (memorizzati in AEM) direttamente tramite l’API HTTP, tramite operazioni CRUD (Creazione, lettura, aggiornamento, eliminazione).

L’API ti consente di utilizzare Adobe Experience Manager as a Cloud Service come CMS headless (Content Management System) fornendo servizi per contenuti a un’applicazione front-end JavaScript. O qualsiasi altra applicazione in grado di eseguire richieste HTTP e gestire risposte JSON.

Ad esempio, Applicazioni a pagina singola (SPA), basate su framework o personalizzate, richiedono il contenuto fornito tramite l’API HTTP, spesso in formato JSON.

Mentre AEM Componenti core forniscono un’API molto completa, flessibile e personalizzabile che può servire le operazioni di lettura necessarie a questo scopo e il cui output JSON può essere personalizzato, richiedono AEM know-how WCM (Web Content Management) per l’implementazione in quanto devono essere ospitati in pagine basate su modelli AEM dedicati. Non tutte le SPA organizzazioni di sviluppo hanno accesso diretto a tali conoscenze.

Questo è il momento in cui è possibile utilizzare l’API REST di Assets. Consente agli sviluppatori di accedere direttamente alle risorse (ad esempio, immagini e frammenti di contenuto) senza dover prima incorporarle in una pagina e consegnare il contenuto in formato JSON serializzato.

L’API REST di Assets consente inoltre agli sviluppatori di modificare il contenuto creando nuove risorse, aggiornando o eliminando risorse esistenti, frammenti di contenuto e cartelle.

API REST di Assets:

• segue il principio HATEOAS

• implementa il formato SIREN

Prerequisiti

L’API REST di Assets è disponibile per ogni installazione predefinita di una versione di Adobe Experience Manager as a Cloud Service recente.

Concetti fondamentali

L’API REST di Assets offre accesso in stile REST alle risorse memorizzate in un’istanza AEM.

Utilizza l’ /api/assets endpoint e richiede il percorso della risorsa per accedervi (senza l’ /content/dam iniziale).

• Ciò significa che per accedere alla risorsa in:
  • /content/dam/path/to/asset
• È necessario richiedere:
  • /api/assets/path/to/asset

Ad esempio, per accedere a /content/dam/wknd/en/adventures/cycling-tuscany, richiedi /api/assets/wknd/en/adventures/cycling-tuscany.json

Il metodo HTTP determina l'operazione da eseguire:

• GET : per recuperare una rappresentazione JSON di una risorsa o di una cartella
• POST : per creare nuove risorse o cartelle
• PUT : per aggiornare le proprietà di una risorsa o di una cartella
• DELETE : per eliminare una risorsa o una cartella

Il formato esatto delle richieste supportate è definito nella documentazione Riferimento API .

Comportamento transazionale

Tutte le richieste sono atomiche.

Ciò significa che le richieste successive (write) non possono essere combinate in una singola transazione che potrebbe avere esito positivo o negativo come singola entità.

API REST AEM (Assets) e componenti AEM

Sicurezza

Se l’API REST di Assets viene utilizzata in un ambiente senza requisiti di autenticazione specifici, AEM filtro CORS deve essere configurato correttamente.

In ambienti con requisiti di autenticazione specifici, si consiglia OAuth.

Funzioni disponibili

I frammenti di contenuto sono un tipo specifico di risorsa. Consulta Uso dei frammenti di contenuto.

Per ulteriori informazioni sulle funzioni disponibili tramite API, consulta:

• API REST di Assets
• Tipi di entità, in cui vengono spiegate le funzioni specifiche di ciascun tipo supportato (in base ai frammenti di contenuto)

Paging

L’API REST di Assets supporta il paging (per richieste GET) tramite i parametri URL:

• offset - il numero della prima entità (figlio) da recuperare
• limit - il numero massimo di entità restituite

La risposta conterrà informazioni di paging come parte della sezione properties dell'output SIREN. Questa proprietà srn:paging contiene il numero totale di entità (secondarie) ( total), l'offset e il limite ( offset, limit) come specificato nella richiesta.

Esempio: Paging

GET /api/assets.json?offset=2&limit=3

...
"properties": {
    ...
    "srn:paging": {
        "total": 7,
        "offset": 2,
        "limit": 3
    }
    ...
}
...

Tipi di entità

Cartelle

Le cartelle fungono da contenitori per risorse e altre cartelle. Essi riflettono la struttura dell’archivio dei contenuti AEM.

L’API REST di Assets espone l’accesso alle proprietà di una cartella; ad esempio nome, titolo, ecc. Le risorse vengono esposte come entità secondarie di cartelle e sottocartelle.

Assets

Se viene richiesta una risorsa, la risposta restituirà i relativi metadati; quali titolo, nome e altre informazioni definite dal rispettivo schema di risorse.

I dati binari di una risorsa sono esposti come collegamento SIREN di tipo content.

Le risorse possono avere più rappresentazioni. Questi vengono generalmente esposti come entità secondarie, con un’eccezione rappresentata dal rendering delle miniature, che viene esposto come collegamento di tipo thumbnail ( rel="thumbnail").

Frammenti di contenuto

Un frammento di contenuto è un tipo speciale di risorsa. Possono essere utilizzati per accedere a dati strutturati, quali testi, numeri, date, ecc.

Poiché esistono diverse differenze tra le risorse standard (come immagini o audio), per gestirle è necessario applicare alcune regole aggiuntive.

Rappresentazione

Frammenti di contenuto:

• Non esporre dati binari.

• Sono completamente contenute nell’output JSON (all’interno della proprietà properties ).

• Sono anche considerate atomiche, ovvero gli elementi e le varianti sono esposti come parte delle proprietà del frammento rispetto a come collegamenti o entità secondarie. Ciò consente un accesso efficiente al payload di un frammento.

Modelli di contenuto e frammenti di contenuto

Attualmente i modelli che definiscono la struttura di un frammento di contenuto non sono esposti tramite un’API HTTP. Pertanto il consumatore deve conoscere il modello di un frammento (almeno un minimo), anche se la maggior parte delle informazioni può essere dedotta dal payload; come tipi di dati, ecc. fanno parte della definizione.

Per creare un nuovo frammento di contenuto, è necessario fornire il percorso (archivio interno) del modello.

Contenuto associato

Il contenuto associato non è attualmente esposto.

Utilizzando

L’utilizzo può variare a seconda che utilizzi un ambiente di authoring o pubblicazione AEM e del tuo caso d’uso specifico.

• Si consiglia vivamente di associare la creazione a un'istanza di authoring (e al momento non è disponibile alcun modo per replicare un frammento da pubblicare utilizzando questa API).

• La consegna è possibile da entrambi, in quanto AEM il contenuto richiesto solo in formato JSON.

  • L'archiviazione e la consegna da un'istanza di authoring AEM dovrebbero essere sufficienti per le applicazioni di librerie multimediali dietro il firewall.

  • Per la distribuzione web live, si consiglia un’istanza di pubblicazione AEM.

Lettura/consegna

L’utilizzo avviene tramite:

GET /{cfParentPath}/{cfName}.json

Esempio:

http://<host>/api/assets/wknd/en/adventures/cycling-tuscany.json

La risposta viene serializzata JSON con il contenuto strutturato come nel frammento di contenuto. I riferimenti vengono consegnati come URL di riferimento.

Sono possibili due tipi di operazioni di lettura:

• Quando si legge un frammento di contenuto specifico in base al percorso, viene restituita la rappresentazione JSON del frammento di contenuto.
• Lettura di una cartella di frammenti di contenuto in base al percorso: restituisce le rappresentazioni JSON di tutti i frammenti di contenuto all’interno della cartella.

Crea

L’utilizzo avviene tramite:

POST /{cfParentPath}/{cfName}

Il corpo deve contenere una rappresentazione JSON del frammento di contenuto da creare, incluso qualsiasi contenuto iniziale da impostare sugli elementi del frammento di contenuto. È obbligatorio impostare la proprietà cq:model e deve puntare a un modello di frammento di contenuto valido. In caso contrario si verifica un errore. È inoltre necessario aggiungere un'intestazione Content-Type impostata su application/json.

Aggiorna

Utilizzo tramite

PUT /{cfParentPath}/{cfName}

Il corpo deve contenere una rappresentazione JSON di ciò che deve essere aggiornato per il frammento di contenuto specificato.

Può trattarsi semplicemente del titolo o della descrizione di un frammento di contenuto, di un singolo elemento o di tutti i valori e/o metadati degli elementi.

Elimina

L’utilizzo avviene tramite:

DELETE /{cfParentPath}/{cfName}

Limitazioni

Ci sono alcune limitazioni:

• I modelli di frammento di contenuto non sono attualmente supportati: non possono essere letti o creati. Per poter creare un nuovo frammento di contenuto o aggiornarne uno esistente, gli sviluppatori devono conoscere il percorso corretto per il modello di frammento di contenuto. Attualmente l’unico metodo per ottenere una panoramica di questi è tramite l’interfaccia utente di amministrazione.
• I riferimenti vengono ignorati. Al momento non è disponibile alcun controllo per stabilire se viene fatto riferimento a un frammento di contenuto esistente. Pertanto, ad esempio, l’eliminazione di un frammento di contenuto potrebbe causare problemi in una pagina che contiene un riferimento al frammento di contenuto eliminato.
• Tipo di dati JSON L’output API REST dei tipi di dati JSON è attualmente un output basato su stringhe.

Codici di stato e messaggi di errore

I seguenti codici di stato possono essere visti nelle circostanze pertinenti:

• 200 (OK) Restituito quando:

  • richiesta di un frammento di contenuto tramite GET
  • aggiornamento completato di un frammento di contenuto tramite PUT

• 201 (Creato) Restituito quando:

  • creazione corretta di un frammento di contenuto tramite POST

• 404 (Non trovato) Restituito quando:

  • il frammento di contenuto richiesto non esiste

• 500 (errore server interno)

  NOTA

  Questo errore viene restituito:

  • quando si è verificato un errore che non può essere identificato con un codice specifico
  • quando il payload specificato non era valido

  Di seguito sono elencati gli scenari comuni in cui viene restituito questo stato di errore, insieme al messaggio di errore (monospazio) generato:

  • La cartella principale non esiste (durante la creazione di un frammento di contenuto tramite POST)

  • Non viene fornito alcun modello di frammento di contenuto (cq:model mancante), non può essere letto (a causa di un percorso non valido o di un problema di autorizzazione) o non è disponibile un modello di frammento valido:

    • No content fragment model specified
    • Cannot create a resource of given model '/foo/bar/qux'

  • Impossibile creare il frammento di contenuto (potenzialmente un problema di autorizzazione):

    • Could not create content fragment

  • Impossibile aggiornare il titolo e la descrizione:

    • Could not set value on content fragment

  • Impossibile impostare i metadati:

    • Could not set metadata on content fragment

  • Impossibile trovare l'elemento contenuto o aggiornarlo

    • Could not update content element
    • Could not update fragment data of element

  I messaggi di errore dettagliati vengono in genere restituiti nel modo seguente:

  {
    "class": "core/response",
    "properties": {
      "path": "/api/assets/foo/bar/qux",
      "location": "/api/assets/foo/bar/qux.json",
      "parentLocation": "/api/assets/foo/bar.json",
      "status.code": 500,
      "status.message": "...{error message}.."
    }
  }
  

Riferimento API

Vedi qui per riferimenti API dettagliati:

• API di Adobe Experience Manager Assets - Frammenti di contenuto

• API HTTP di Assets

  • Funzioni disponibili

Risorse aggiuntive

Per ulteriori informazioni, consulta:

• Documentazione API HTTP di Assets
• Sessione Gem AEM: OAuth