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

Ökning overview

Läs om stödet för innehållsfragment i Assets HTTP API, en viktig del av Adobe Experience Manager headless-leveransfunktion (AEM).

Med Assets REST API kan utvecklare av Adobe Experience Manager as a Cloud Service komma åt innehåll (som lagras i AEM) direkt via HTTP-API:t via CRUD-åtgärder (Create, Read, Update, Delete).

Med API:t kan du använda Adobe Experience Manager as a Cloud Service 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.

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

AEM Core Components har ett 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. Detta beror på att 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 alla färdiga installationer av en nyligen använd Adobe Experience Manager as a Cloud Service-version.

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-parametrarna:

Svaret innehåller sidindelningsinformation 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 och titel. Assets visas som underordnade enheter till mappar och undermappar.

Assets assets

Om en resurs begärs returnerar svaret dess metadata, t.ex. 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 måste konsumenten känna till modellen för ett fragment (minst ett minimum), även om den mesta informationen kan härledas från nyttolasten, eftersom 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 inte.

Använda using

Användningen kan variera beroende på om du använder en AEM Author eller Publish-miljö, tillsammans med ditt specifika användningsexempel.

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: