Stöd för innehållsfragment i AEM Assets HTTP API content-fragments-support-in-aem-assets-http-api

Ökning overview

Läs mer om stöd för innehållsfragment i Assets HTTP API, en viktig del av AEM headless-leveransfunktion.

Med Assets REST API kan utvecklare för Adobe Experience Manager komma åt innehåll (som lagras i AEM) direkt via HTTP-API:t via CRUD-åtgärder (Skapa, Läs, Uppdatera, Ta bort).

Med API:t kan du använda Adobe Experience Manager som headless CMS (Content Management System) genom att tillhandahålla innehållstjänster till ett JavaScript front end-program. Eller något annat program som kan köra HTTP-begäranden och hantera JSON-svar.

Enkelsidiga program (SPA), ramverksbaserade eller anpassade, kräver till exempel innehåll som tillhandahålls via HTTP API, ofta i JSON-format.

AEM Core Components innehåller ett mycket omfattande, flexibelt och anpassningsbart API som kan hantera nödvändiga läsåtgärder i detta syfte, och vars JSON-utdata kan anpassas, men de kräver AEM WCM-kunskaper (Web Content Management) för implementering eftersom de måste finnas på sidor som är baserade på dedikerade AEM. Det är inte varje SPA utvecklingsorganisation som har direkt tillgång till sådan kunskap.

Detta är när Assets REST API kan användas. Med det kan utvecklare komma åt resurser (till exempel bilder och innehållsfragment) direkt, utan att först behöva bädda in dem på en sida, och leverera innehållet i serialiserat JSON-format.

Med Assets REST API kan utvecklare ändra innehåll genom att skapa nya, uppdatera eller ta bort befintliga resurser, innehållsfragment och mappar.

Assets REST API:

Förutsättningar prerequisites

Assets REST API är tillgängligt för varje körklar installation av en AEM.

Viktiga begrepp key-concepts

Assets REST API ger REST-åtkomst till resurser som lagras i en AEM.

Slutpunkten /api/assets används och resursens sökväg krävs för att komma åt den (utan radavståndet /content/dam).

Om du till exempel vill komma åt /content/dam/wknd/en/adventures/cycling-tuscany begär du /api/assets/wknd/en/adventures/cycling-tuscany.json

HTTP-metoden avgör vilken åtgärd som ska utföras:

Exakt format för begäranden som stöds definieras i API Reference -dokumentationen.

Transaktionsbeteende transactional-behavior

Alla förfrågningar är atomiska.

Detta innebär att efterföljande (write) begäranden inte kan kombineras till en enda transaktion som kan lyckas eller misslyckas som en enskild enhet.

AEM (Assets) REST API jämfört med AEM aem-assets-rest-api-versus-aem-components

Dokumentskydd security

Om Assets REST API används i en miljö utan särskilda autentiseringskrav måste AEM CORS-filter konfigureras korrekt.

I miljöer med specifika autentiseringskrav rekommenderas OAuth.

Tillgängliga funktioner available-features

Innehållsfragment är en specifik typ av resurs, se Arbeta med innehållsfragment.

Mer information om funktioner som är tillgängliga via API finns i:

Sidindelning paging

Assets REST API har stöd för sidindelning (för GET-begäranden) via URL-parametrar:

Svaret kommer att innehålla växlingsinformation som en del av avsnittet properties i SIREN-utdata. Den här srn:paging-egenskapen innehåller det totala antalet (underordnade) entiteter ( total), förskjutningen och gränsen ( offset, limit) som anges i begäran.

Exempel: Sidindelning example-paging

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

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

Enhetstyper entity-types

Mappar folders

Mappar fungerar som behållare för resurser och andra mappar. De återspeglar strukturen i AEM innehållsdatabas.

Assets REST API ger åtkomst till egenskaperna för en mapp, till exempel dess namn, titel och så vidare. Assets visas som underordnade enheter till mappar och undermappar.

Assets assets

Om en resurs begärs returnerar svaret dess metadata, till exempel titel, namn och annan information som definieras i respektive resursschema.

Binära data för en resurs visas som en SIREN-länk av typen content.

Assets kan ha flera renderingar. Dessa visas vanligtvis som underordnade entiteter, ett undantag är en miniatyrrendering som visas som en länk av typen thumbnail ( rel="thumbnail").

Innehållsfragment content-fragments

Ett innehållsfragment är en särskild typ av resurs. De kan användas för att komma åt strukturerade data, t.ex. texter, siffror och datum.

Eftersom det finns flera skillnader mellan standardresurser (till exempel bilder eller ljud) gäller vissa ytterligare regler för att hantera dem.

Representation representation

Innehållsfragment:

Innehållsmodeller och innehållsfragment content-models-and-content-fragments

För närvarande visas inte modellerna som definierar strukturen för ett innehållsfragment via ett HTTP-API. Därför behöver konsumenten känna till modellen för ett fragment (minst ett minimum), även om den mesta informationen kan härledas från nyttolasten, som datatyper och så vidare. är en del av definitionen.

Om du vill skapa ett innehållsfragment måste modellens (interna databas) sökväg anges.

Associerat innehåll associated-content

Associerat innehåll visas för närvarande inte.

Använda using

Användningen kan variera beroende på om du använder en AEM författare eller publiceringsmiljö, tillsammans med ditt specifika användningsexempel.

Läsning/leverans read-delivery

Användning sker via:

GET /{cfParentPath}/{cfName}.json

Till exempel:

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

Svaret är serialiserat JSON med innehållet strukturerat som i innehållsfragmentet. Referenser levereras som referens-URL:er.

Det finns två typer av läsåtgärder:

Skapa create

Användning sker via:

POST /{cfParentPath}/{cfName}

Brödtexten måste innehålla en JSON-representation av det innehållsfragment som ska skapas, inklusive allt ursprungligt innehåll som ska anges för elementen i innehållsfragmentet. Det är obligatoriskt att ange egenskapen cq:model och den måste peka på en giltig innehållsfragmentmodell. Om du inte gör det kommer ett fel att uppstå. Du måste också lägga till rubriken Content-Type som är inställd på application/json.

Uppdatera update

Användning sker via

PUT /{cfParentPath}/{cfName}

Brödtexten måste innehålla en JSON-representation av vad som ska uppdateras för det angivna innehållsfragmentet.

Detta kan helt enkelt vara titeln eller beskrivningen av ett innehållsfragment, ett enskilt element eller alla elementvärden och/eller metadata.

Ta bort delete

Användning sker via:

DELETE /{cfParentPath}/{cfName}

Begränsningar limitations

Det finns några begränsningar:

Statuskoder och felmeddelanden status-codes-and-error-messages

Följande statuskoder kan ses under de relevanta omständigheterna:

API-referens api-reference

Här finns detaljerade API-referenser:

Ytterligare resurser additional-resources

Mer information finns i: