API-guide för Query Service
Den här utvecklarhandboken innehåller steg för att utföra olika åtgärder i API:t för Adobe Experience Platform Query Service.
Komma igång
Den här guiden kräver en fungerande förståelse av de olika Adobe Experience Platform-tjänster som används med Query Service.
- Query Service: Ger möjlighet att fråga datauppsättningar och hämta de resulterande frågorna som nya datauppsättningar i Experience Platform.
- Experience Data Model (XDM) System: Det standardiserade ramverket som Experience Platform organiserar kundupplevelsedata med.
- Sandboxes: Experience Platform innehåller virtuella sandlådor som partitionerar en enskild Platform-instans till separata virtuella miljöer för att hjälpa till att utveckla och utveckla program för digitala upplevelser.
I följande avsnitt finns ytterligare information som du behöver känna till för att kunna använda Query Service med API:t.
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 den här 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 Experience 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 Platform API-anrop, vilket visas nedan:
- Behörighet:
Bearer {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 ett huvud som anger namnet på den sandlåda där åtgärden ska utföras:
- x-sandbox-name:
{SANDBOX_NAME}
Exempel på API-anrop
Nu när du förstår vilka rubriker som ska användas kan du börja ringa anrop till API:t Query Service. Följande dokument går igenom de olika API-anropen som du kan göra med API:t Query Service. Varje exempelanrop innehåller det allmänna API-formatet, en exempelbegäran med obligatoriska rubriker och ett exempelsvar.
Nästa steg
Nu när du har lärt dig att ringa anrop med API:t Query Service kan du skapa egna icke-interaktiva frågor. Mer information om hur du skapar frågor finns i SQL-referenshandboken.