Catalog Service API-guide

Catalog Service är registersystemet för dataplatser och datalinje inom Adobe Experience Platform. Catalog fungerar som ett metadataarkiv eller en katalog där du kan hitta information om dina data i Experience Platformutan att behöva komma åt själva data. Se Catalog översikt för mer information.

I den här utvecklarhandboken får du hjälp att börja använda Catalog API. Handboken innehåller sedan exempel på API-anrop för att utföra nyckelåtgärder med Catalog.

Förutsättningar

Catalog spårar metadata för flera olika typer av resurser och åtgärder i 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 dessa resurser:

  • Experience Data Model (XDM): Det standardiserade ramverk som Platform organiserar kundupplevelsedata.
  • Batchförtäring: Hur Experience Platform importerar och lagrar data från datafiler, som CSV och Parquet.
  • Direktinmatning: 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 har till hands för att kunna ringa till Catalog Service API.

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 konventionerna som används i dokumentationen för exempel-API-anrop finns i avsnittet om läsa exempel-API-anrop i Experience Platform felsökningsguide.

Samla in värden för obligatoriska rubriker

För att ringa Platform API:er måste du först slutföra självstudiekurs om autentisering. När du är klar med självstudiekursen för autentisering visas värdena för var och en av de obligatoriska rubrikerna i alla Experience Platform API-anrop enligt nedan:

  • Behörighet: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Alla resurser i Experience Platform isoleras till specifika virtuella sandlådor. Alla förfrågningar 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}
OBSERVERA

Mer information om sandlådor i Platform, se översiktsdokumentation för sandlåda.

Alla begäranden som innehåller en nyttolast (POST, PUT, PATCH) kräver ytterligare en rubrik:

  • Innehållstyp: application/json

Bästa tillvägagångssätt för Catalog API-anrop

Vid GET av begäranden till Catalog API, är det bästa sättet att ta med frågeparametrar i dina förfrågningar 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 svaren. Filter kan skickas som rubriker och som frågeparametrar, där de skickas som frågeparametrar har prioritet. Visa dokumentet på filtrera katalogdata för mer information.

Eftersom vissa frågor kan göra API:t mycket belastat har globala begränsningar implementerats på Catalog frågor för att ytterligare stödja bästa praxis.

Nästa steg

Det här dokumentet innehöll de nödvändiga kunskaperna som krävs för att ringa till Catalog API. Du kan nu gå vidare till exempelsamtalen i den här utvecklarhandboken och följa med i instruktionerna för dessa.

De flesta exemplen i den här handboken använder /dataSets slutpunkt, men principerna kan tillämpas på andra slutpunkter inom Catalog (till exempel /batches och /accounts). Se API-referens för katalogtjänst för en fullständig lista över alla anrop och åtgärder som är tillgängliga för varje slutpunkt.

Ett stegvis arbetsflöde som visar hur Catalog API:t är involverat i datainmatning, se självstudiekursen om skapa en datauppsättning.

På denna sida