Utforska AEM OpenAPI-baserade Content Fragment Delivery APIs

AEM Content Fragment Delivery med OpenAPI-API:er i AEM är ett kraftfullt sätt att leverera strukturerat innehåll till alla program och kanaler. I det här kapitlet utforskar vi hur du använder OpenAPI:er för att hämta innehållsfragment via dokumentationens Try -funktion.

Förutsättningar prerequisites

Det här är en självstudiekurs i flera delar där stegen som beskrivs i Skapa innehållsfragment har slutförts.

Se till att du har följande:

Mål objectives

Leverans-API:er

AEM Content Fragment Delivery med OpenAPI API:er har ett RESTful-gränssnitt för att hämta innehållsfragment. De API:er som beskrivs i den här självstudiekursen är bara tillgängliga för AEM Publish- och Preview-tjänster, och inte för Author-tjänsten. Det finns andra OpenAPI:er för interaktion med innehållsfragment i AEM Author-tjänsten.

Utforska API:erna

AEM Content Fragment Delivery with OpenAPIs documentation har en Try it-funktion som gör att du kan utforska API:erna och testa dem direkt från webbläsaren. Detta är ett bra sätt att bekanta sig med API-slutpunkterna och deras funktioner.

Öppna AEM Sites API-dokumenten i webbläsaren.

API:erna listas i den vänstra navigeringen under avsnittet Fragmentleverans. Du kan expandera det här avsnittet för att se tillgängliga API:er. Om du väljer ett API visas API-informationen på huvudpanelen och ett Try it -avsnitt till höger där du kan testa och utforska API:t direkt från webbläsaren.

Visa innehållsfragment

Med detta API kan du hämta en sidnumrerad lista över alla innehållsfragment från AEM per mapp. Det enklaste sättet att använda detta API är att ange sökvägen till mappen som innehåller innehållsfragmenten.

Eftersom vi använder AEM Publish-tjänsten anger du AEMS ID för publiceringstjänsten. Till exempel:

När bucket är inställt uppdateras fältet Målserver automatiskt till AEM Publish-tjänstens fullständiga API-URL, till exempel: https://publish-p138003-e1400351.adobeaemcloud.com/adobe/contentFragments

Hämta information om innehållsfragment

På samma sätt som API:t Visa alla innehållsfragment hämtar API:t Hämta ett innehållsfragment ett enstaka innehållsfragment med dess ID tillsammans med eventuella valfria referenser. För att utforska detta API begär vi teaminnehållsfragment som refererar till flera personinnehållsfragment.

I det här exemplet använder du ID:t för teaminnehållsfragmentet som hämtades i föregående avsnitt. Använd till exempel värdet i fältet i för det här innehållsfragmentssvaret i idVisa alla innehållsfragmentb954923a-0368-4fa2-93ea-2845f599f512. (Din id skiljer sig från värdet som används i självstudiekursen.)

{
    "path": "/content/dam/my-project/teams/team-alpha",
    "name": "",
    "title": "Team Alpha",
    "id": "50f28a14-fec7-4783-a18f-2ce2dc017f55", // This is the Content Fragment ID
    "description": "",
    "model": {},
    "fields": {}
}

Observera att arrayen teamMembers nu innehåller information om de refererade personinnehållsfragmenten. Med hjälp av hydringsreferenser kan du hämta alla nödvändiga data i ett enda API-anrop, vilket är särskilt användbart för att minska antalet begäranden som görs av klientprogram.

Grattis!

Du har skapat och kört flera AEM Content Fragment Delivery med OpenAPI-API-anrop med AEM-dokumentationens Try IT-funktion.

Nästa steg

I nästa kapitel, Bygg en React-app, utforskar du hur ett externt program kan interagera med AEM Content Fragment Delivery med OpenAPI:er.