API-guide för Catalog Service
Catalog Service är arkivsystemet för dataplatser och datalänkning inom Adobe Experience Platform. Catalog fungerar som ett metadataarkiv eller en katalog där du kan hitta information om dina data i Experience Platform, utan att behöva komma åt själva data. Mer information finns i Catalog översikten.
Den här utvecklarhandboken innehåller steg som hjälper dig att börja använda API:t för Catalog. Guiden innehåller sedan exempel på API-anrop för att utföra nyckelåtgärder med Catalog.
Förhandskrav
Catalog spårar metadata för flera typer av resurser och åtgärder inom Experience Platform. Den här utvecklarhandboken kräver en fungerande förståelse av de olika Experience Platform-tjänster som används för att skapa och hantera de här resurserna:
- Experience Data Model (XDM): Det standardiserade ramverket som Platform organiserar kundupplevelsedata med.
- Gruppinmatning: Hur Experience Platform importerar och lagrar data från datafiler, till exempel CSV och Parquet.
- Direktuppspelningsuppläsning: Hur Experience Platform importerar och lagrar data från klient- och serverenheter i realtid.
I följande avsnitt finns ytterligare information som du behöver känna till eller ha till hands för att kunna anropa API:t Catalog Service.
Läser exempel-API-anrop
Den här guiden innehåller exempel på API-anrop som visar hur du formaterar dina begäranden. Det kan vara sökvägar, obligatoriska rubriker och korrekt formaterade begärandenyttolaster. Ett exempel på JSON som returneras i API-svar finns också. Information om de konventioner som används i dokumentationen för exempel-API-anrop finns i avsnittet Så här läser du exempel-API-anrop i felsökningsguiden för Experience Platform.
Samla in värden för obligatoriska rubriker
För att kunna anropa Platform API:er måste du först slutföra autentiseringssjälvstudiekursen. När du slutför självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop, vilket visas nedan:
- Behörighet: Bärare
{ACCESS_TOKEN} - x-api-key:
{API_KEY} - x-gw-ims-org-id:
{ORG_ID}
Alla resurser i Experience Platform är isolerade till specifika virtuella sandlådor. Alla begäranden till Platform API:er kräver en rubrik som anger namnet på sandlådan som åtgärden ska utföras i:
- x-sandbox-name:
{SANDBOX_NAME}
Alla begäranden som innehåller en nyttolast (POST, PUT, PATCH) kräver ytterligare en rubrik:
- Content-Type: application/json
God praxis för Catalog API-anrop
När du utför GET-begäranden till API:t Catalog är det bäst att ta med frågeparametrar i dina begäranden för att bara returnera de objekt och egenskaper som du behöver. Ofiltrerade begäranden kan göra att svarsnyttolasterna når över 3 GB, vilket kan göra den totala prestandan långsammare.
Du kan visa specifika objekt genom att ta med deras ID i den begärda sökvägen eller använda frågeparametrar som properties och limit för att filtrera svar. Filter kan skickas som rubriker och som frågeparametrar, där de skickas som frågeparametrar har prioritet. Mer information finns i dokumentet om filtrering av katalogdata.
Eftersom vissa frågor kan göra API:t mycket belastat har globala begränsningar implementerats på Catalog-frågor för ytterligare stöd för bästa praxis.
Nästa steg
Det här dokumentet innehöll den nödvändiga kunskapen som krävs för att anropa API:t Catalog. Du kan nu gå vidare till exempelsamtalen i den här utvecklarhandboken och följa med i instruktionerna för dessa.
I de flesta av exemplen i den här handboken används slutpunkten /dataSets, men principerna kan tillämpas på andra slutpunkter inom Catalog (till exempel /batches). I API-referensen för katalogtjänsten finns en fullständig lista över alla anrop och åtgärder som är tillgängliga för varje slutpunkt.
Ett steg-för-steg-arbetsflöde som demonstrerar hur Catalog-API:t är involverat i datainmatning finns i självstudiekursen Skapa en datamängd.