Beta
Skapa en källanslutning och ett dataflöde för Pendo med API:t för Flow Service
Skapat för:
- Utvecklare
OBSERVERAI följande självstudiekurs får du hjälp med att skapa en källanslutning och ett dataflöde för att skicka Pendo händelsedata till Adobe Experience Platform med Flow Service API.
Komma igång
Handboken kräver en fungerande förståelse av följande komponenter i Experience Platform:
- Källor: Med Experience Platform kan data hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med hjälp av Experience Platform-tjänster.
- Sandlådor: Experience Platform tillhandahåller virtuella sandlådor som partitionerar en enda Experience Platform-instans till separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.
Anslut Pendo till Experience Platform med API:t Flow Service
Följande beskriver de steg du måste utföra för att skapa en källanslutning och ett dataflöde för att kunna överföra Pendo-händelsedata till Experience Platform.
Skapa en källanslutning
Skapa en källanslutning genom att göra en POST-begäran till API:t Flow Service, och ange källans anslutningsspec-ID, information som namn och beskrivning samt dataformatet.
API-format
POST /sourceConnections
Begäran
Följande begäran skapar en källanslutning för Pendo:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Streaming Source Connection for Pendo",
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"description": "Streaming Source Connection for Pendo",
"connectionSpec": {
"id": "6ff5654f-19d5-427d-bd3e-c0ebc802389a",
"version": "1.0"
},
"data": {
"format": "json"
}
}'
namedescriptionconnectionSpec.iddata.formatjson.Svar
Ett lyckat svar returnerar den unika identifieraren (id) för den nyligen skapade källanslutningen. Detta ID krävs i ett senare steg för att skapa ett dataflöde.
{
"id": "76b968ff-3ff0-4e98-98bb-f3205d4d370c",
"etag": "\"0301c198-0000-0200-0000-63f32ba50000\""
}
Skapa ett mål-XDM-schema
För att källdata ska kunna användas i Experience Platform måste ett målschema skapas för att strukturera källdata efter dina behov. Målschemat används sedan för att skapa en Experience Platform-datauppsättning där källdata finns.
Ett mål-XDM-schema kan skapas genom att en POST-begäran till schemats register-APIutförs.
Detaljerade steg om hur du skapar ett mål-XDM-schema finns i självstudiekursen Skapa ett schema med API:t.
Skapa en måldatauppsättning
En måldatauppsättning kan skapas genom att en POST-begäran till katalogtjänstens API utförs, med ID:t för målschemat i nyttolasten.
Detaljerade steg om hur du skapar en måldatauppsättning finns i självstudiekursen Skapa en datauppsättning med API:t.
Skapa en målanslutning
En målanslutning representerar anslutningen till målet där inmatade data ska lagras. Om du vill skapa en målanslutning måste du ange det fasta anslutningsspecifikations-ID som motsvarar datasjön. Detta ID är: c604ff05-7f1a-43c0-8e18-33bf874cb11c.
Nu har du de unika identifierarna ett målschema, en måldatamängd och ett anslutningsspec-ID till datasjön. Med hjälp av dessa identifierare kan du skapa en målanslutning med API:t Flow Service för att ange den datauppsättning som ska innehålla inkommande källdata.
API-format
POST /targetConnections
Begäran
Följande begäran skapar en målanslutning för Pendo:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Streaming Target Connection for Pendo",
"description": "Streaming Target Connection for Pendo",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "json",
"schema": {
"id": "https://ns.adobe.com/extconndev/schemas/b48de0b204046e65a4c50232e7946401946b4c519fd7c172",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "63dca52231a6031c07280614"
}
}'
namedescriptionconnectionSpec.idc604ff05-7f1a-43c0-8e18-33bf874cb11c.data.formatparams.dataSetIdSvar
Ett svar returnerar den nya målanslutningens unika identifierare (id). Detta ID krävs i senare steg.
{
"id": "c63978c1-df7e-4611-aa32-3657eab5704b",
"etag": "\"7f0045f1-0000-0200-0000-63f32c9d0000\""
}
Skapa en mappning
För att källdata ska kunna hämtas till en måldatamängd måste den först mappas till målschemat som måldatamängden följer. Detta uppnås genom att utföra en POST-begäran till Data Prep API med datamappningar definierade i nyttolasten för begäran.
API-format
POST /conversion/mappingSets
Begäran
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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}' \
-H 'Content-Type: application/json' \
-d '{
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/945546112b746524bfd9f1264b26c2b7d8e7f5b7fadb953a",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"destinationXdmPath": "_extconndev.accountid",
"sourceAttribute": "accountId",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.uniqueid",
"sourceAttribute": "uniqueId",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.name1",
"sourceAttribute": "properties.guideProperties.name",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.timestamp1",
"sourceAttribute": "timestamp",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.visitorid",
"sourceAttribute": "visitorId",
"identity": false,
"version": 0
}
]
}'
outputSchema.schemaRef.idmappings.sourceTypemappings.sourcemappings.destinationSvar
Ett lyckat svar returnerar information om den nyligen skapade mappningen inklusive dess unika identifierare (id). Detta värde krävs i ett senare steg för att skapa ett dataflöde.
{
"id": "a126ae1a1d134c4b82bd00c2d01a039e",
"version": 0,
"createdDate": 1676881164541,
"modifiedDate": 1676881164541,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
Skapa ett flöde
Det sista steget mot att överföra data från Pendo till Experience Platform är att skapa ett dataflöde. Nu har du förberett följande obligatoriska värden:
Ett dataflöde ansvarar för att schemalägga och samla in data från en källa. Du kan skapa ett dataflöde genom att utföra en POST-begäran samtidigt som du anger de tidigare nämnda värdena i nyttolasten.
API-format
POST /flows
Begäran
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Streaming Dataflow for Pendo",
"description": "Streaming Dataflow for Pendo",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"sourceConnectionIds": [
"339d60a5-9ff6-4eba-8197-e8887eeb3c08"
],
"targetConnectionIds": [
"df7c660e-3484-463b-b01a-1835e9b04ac9"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "bae11501021646e58cecc1182451af22",
"mappingVersion": 0
}
}
]
}'
namedescriptionflowSpec.ide77fde5a-22a8-11ed-861d-0242ac120002.flowSpec.version1.0.sourceConnectionIdstargetConnectionIdstransformationstransformations.nametransformations.params.mappingIdtransformations.params.mappingVersion0.Svar
Ett lyckat svar returnerar ID:t (id) för det nyskapade dataflödet. Du kan använda det här ID:t för att övervaka, uppdatera eller ta bort dataflödet.
{
"id": "c341617b-e143-43d5-aff1-da02b3e028b6",
"etag": "\"9c01173c-0000-0200-0000-63f32d7c0000\""
}
Hämta din URL för direktuppspelningsslutpunkt
När dataflödet har skapats kan du nu hämta URL:en för direktuppspelningsslutpunkten. Du kommer att använda den här slutpunkts-URL:en för att prenumerera på en webkrok så att källan kan kommunicera med Experience Platform.
Om du vill hämta URL:en för direktuppspelningsslutpunkten gör du en GET-begäran till slutpunkten /flows och anger ID:t för dataflödet.
API-format
GET /flows/{FLOW_ID}
Begäran
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/flows/4982698b-e6b3-48c2-8dcf-040e20121fd2' \
-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 information om ditt dataflöde, inklusive din slutpunkts-URL, markerad som inletUrl. Gå till sidan Konfigurera webkrok för att hämta det värde som krävs.
{
"items": [
{
"id": "d947e6a9-ea53-42c4-985c-c9379265491f",
"createdAt": 1676875325841,
"updatedAt": 1676875331938,
"createdBy": "acme@AdobeID",
"updatedBy": "acme@AdobeID",
"createdClient": "{CREATED_CLIENT}",
"updatedClient": "{UPDATED_CLIENT}",
"sandboxId": "{SANDBOX_ID}",
"sandboxName": "{SANDBOX_NAME}",
"imsOrgId": "{ORG_ID}",
"name": "Streaming Dataflow for Pendo",
"description": "Streaming Dataflow for Pendo",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"state": "enabled",
"version": "\"9801a366-0000-0200-0000-63f2f92c0000\"",
"etag": "\"9801a366-0000-0200-0000-63f2f92c0000\"",
"sourceConnectionIds": [
"339d60a5-9ff6-4eba-8197-e8887eeb3c08"
],
"targetConnectionIds": [
"df7c660e-3484-463b-b01a-1835e9b04ac9"
],
"inheritedAttributes": {
"properties": {
"isSourceFlow": true
},
"sourceConnections": [
{
"id": "339d60a5-9ff6-4eba-8197-e8887eeb3c08",
"connectionSpec": {
"id": "6ff5654f-19d5-427d-bd3e-c0ebc802389a",
"version": "1.0"
}
}
],
"targetConnections": [
{
"id": "df7c660e-3484-463b-b01a-1835e9b04ac9",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"options": {
"inletUrl": "https://dcs.adobedc.net/collection/e389c18dbc7f5de8b95df07b1b89d76ddd9b1e88d5423abc71b6ac9161491373"
},
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "bae11501021646e58cecc1182451af22",
"mappingVersion": 0
}
}
],
"runs": "/runs?property=flowId==4d90b316-1c9b-469d-935f-5a27d5deefdf",
"providerRefId": "19d9fb14-9cb9-42a5-bb8b-23dc545e766a",
"lastOperation": {
"started": 0,
"updated": 0,
"operation": "enable"
},
"lastRunDetails": {
"id": "d6972216-2332-41f6-8ed3-2ac82e6550b7",
"state": "partialSuccess",
"startedAtUTC": 1676862000000,
"completedAtUTC": 1676867880000
}
}
]
}
Bilaga
Följande avsnitt innehåller information om hur du övervakar, uppdaterar och tar bort dataflödet.
Övervaka dataflödet
När dataflödet har skapats kan du övervaka de data som importeras genom det för att se information om flödeskörningar, slutförandestatus och fel. Fullständiga API-exempel finns i handboken om att övervaka källans dataflöden med API:t.
Uppdatera ditt dataflöde
Uppdatera informationen om dataflödet, till exempel namn och beskrivning, samt körningsschema och associerade mappningsuppsättningar genom att göra en PATCH-begäran till /flows-slutpunkten för Flow Service API, samtidigt som du anger ID:t för dataflödet. När du gör en PATCH-begäran måste du ange dataflödets unika etag i rubriken If-Match. Fullständiga API-exempel finns i handboken om att uppdatera källkodsdataflöden med API
Uppdatera ditt konto
Uppdatera namn, beskrivning och autentiseringsuppgifter för källkontot genom att utföra en PATCH-begäran till Flow Service-API:t och ange ditt grundläggande anslutnings-ID som en frågeparameter. När du gör en PATCH-begäran måste du ange källkontots unika etag i rubriken If-Match. Fullständiga API-exempel finns i handboken Uppdatera ditt källkonto med API.
Ta bort ditt dataflöde
Ta bort dataflödet genom att utföra en DELETE-begäran till Flow Service-API:t och ange ID:t för det dataflöde som du vill ta bort som en del av frågeparametern. Fullständiga API-exempel finns i guiden om att ta bort dataflöden med API:t.
Ta bort ditt konto
Ta bort ditt konto genom att utföra en DELETE-begäran till Flow Service-API:t och ange det grundläggande anslutnings-ID:t för kontot som du vill ta bort. Fullständiga API-exempel finns i guiden om att ta bort ditt källkonto med API.