Utforska ett automatiserat marknadsföringssystem med API:t för Flow Service
Skapat för:
- Utvecklare
Flow Service används för att samla in och centralisera kunddata från olika källor inom Adobe Experience Platform. Tjänsten tillhandahåller ett användargränssnitt och RESTful API som alla källor som stöds kan anslutas från.
I den här självstudien används Flow Service-API:t för att utforska automatiserade marknadsföringssystem.
Komma igång
Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:
- Källor: Experience Platform tillåter att data kan hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med Experience Platform-tjänster.
- Sandlådor: Experience Platform innehåller virtuella sandlådor som partitionerar en enskild Experience 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 ansluta till ett automatiserat marknadsföringssystem med API:t Flow Service.
Samla in nödvändiga inloggningsuppgifter
Den här självstudiekursen kräver att du har en giltig anslutning till det program för automatiserad marknadsföring från tredje part som du vill importera data från. En giltig anslutning innefattar programmets anslutningsspecifikations-ID och anslutnings-ID. Mer information om hur du skapar en anslutning för automatiserad marknadsföring och hämtar dessa värden finns i självstudiekursen Koppla en källa för automatiserad marknadsföring till Experience Platform.
Läser exempel-API-anrop
I den här självstudiekursen finns exempel-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 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 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, inklusive de som tillhör Flow Service, isoleras till specifika virtuella sandlådor. Alla begäranden till Experience 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 en extra medietypsrubrik:
- Innehållstyp:
application/json
Utforska era datatabeller
Med hjälp av basanslutningen för ert automatiseringssystem för marknadsföring kan ni utforska era datatabeller genom att utföra GET-förfrågningar. Använd följande anrop för att hitta sökvägen till tabellen som du vill inspektera eller importera till Experience Platform.
API-format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
{BASE_CONNECTION_ID}Begäran
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=root' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Svar
Ett framgångsrikt svar är en mängd tabeller från ert marknadsföringssystem. Hitta tabellen som du vill hämta till Experience Platform och notera dess path-egenskap, eftersom du måste ange den i nästa steg för att inspektera dess struktur.
[
{
"type": "table",
"name": "Hubspot.All_Deals",
"path": "Hubspot.All_Deals",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Hubspot.Blog_Authors",
"path": "Hubspot.Blog_Authors",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Hubspot.Blog_Comments",
"path": "Hubspot.Blog_Comments",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Hubspot.Contacts",
"path": "Hubspot.Contacts",
"canPreview": true,
"canFetchSchema": true
},
]
Inspektera strukturen i en tabell
Om du vill inspektera tabellstrukturen utifrån ditt automatiseringssystem för marknadsföring, ska du utföra en GET-begäran och samtidigt ange sökvägen till en tabell som en frågeparameter.
API-format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
{BASE_CONNECTION_ID}{TABLE_PATH}Begäran
curl -X GET \
'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=table&object=Hubspot.Contacts' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
Svar
Ett lyckat svar returnerar strukturen för en tabell. Information om var och en av tabellens kolumner finns inom elementen i arrayen columns.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "Properties_Firstname_Value",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Properties_Lastname_Value",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Added_At",
"type": "string",
"meta:xdmType": "date-time",
"xdm": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Portal_Id",
"type": "string",
"xdm": {
"type": "string"
}
},
]
}
}
Nästa steg
Genom att följa den här självstudiekursen har du utforskat ditt automatiseringssystem för marknadsföring, hittat sökvägen till tabellen som du vill hämta till Experience Platform och fått information om dess struktur. Du kan använda den här informationen i nästa självstudiekurs för att samla in data från ditt automatiseringssystem för marknadsföring och överföra dem till Experience Platform.