[Beta]{class="badge informative"}
Erstellen einer Quellverbindung und eines Datenflusses für Chatlio mithilfe der Flow Service-API
Das folgende Tutorial führt Sie durch die Schritte zum Erstellen einer Quellverbindung und eines Datenflusses, um Chatlio Ereignisdaten mit der Flow Service API an Adobe Experience Platform zu übertragen.
Erste Schritte getting-started
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Experience Platform voraus:
- Quellen: Experience Platform ermöglicht die Erfassung von Daten aus verschiedenen Quellen und bietet Ihnen gleichzeitig die Möglichkeit, eingehende Daten mithilfe von Platform-Diensten zu strukturieren, zu beschriften und zu erweitern.
- Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse entwickeln und weiterentwickeln können.
Chatlio über die Flow Service-API mit Platform verbinden connect-platform-to-flow-api
Im Folgenden werden die Schritte beschrieben, die Sie zum Erstellen einer Quellverbindung und eines Datenflusses unternehmen müssen, um Ihre Chatlio -Ereignisdaten an Experience Platform zu bringen.
Erstellen einer Quellverbindung source-connection
Erstellen Sie eine Quellverbindung, indem Sie eine POST-Anfrage an die Flow Service -API richten und dabei die Verbindungsspezifikations-ID Ihrer Quelle, Details wie Name und Beschreibung und das Datenformat angeben.
API-Format
POST /sourceConnections
Anfrage
Die folgende Anfrage erstellt eine Quellverbindung für Chatlio:
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 Chatlio.",
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"description": "Streaming Source Connection for Chatlio.",
"connectionSpec": {
"id": "073127a3-26e3-496c-9d94-9f48fb93fba8",
"version": "1.0"
},
"data": {
"format": "json"
}
}'
name
description
connectionSpec.id
data.format
json
unterstützt.Antwort
Eine erfolgreiche Antwort gibt die eindeutige Kennung (id
) der neu erstellten Quellverbindung zurück. Diese ID ist in einem späteren Schritt erforderlich, um einen Datenfluss zu erstellen.
{
"id": "7689a40d-43eb-4f74-a3f1-092a55884f6c",
"etag": "\"01013ed0-0000-0200-0000-63f314d00000\""
}
Erstellen eines XDM-Zielschemas target-schema
Damit die Quelldaten in Platform verwendet werden können, muss ein Zielschema erstellt werden, das die Quelldaten entsprechend Ihren Anforderungen strukturiert. Das Zielschema wird dann verwendet, um einen Platform-Datensatz zu erstellen, in dem die Quelldaten enthalten sind.
Ein Ziel-XDM-Schema kann erstellt werden, indem eine POST-Anfrage an die Schema-Registrierungs-API durchgeführt wird.
Ausführliche Schritte zum Erstellen eines XDM-Zielschemas finden Sie im Tutorial zum Erstellen eines Schemas mithilfe der API.
Erstellen eines Zieldatensatzes target-dataset
Ein Zieldatensatz kann erstellt werden, indem eine POST-Anfrage an die Catalog Service API durchgeführt wird, wodurch die ID des Zielschemas in der Payload angegeben wird.
Ausführliche Anweisungen zum Erstellen eines Zieldatensatzes finden Sie im Tutorial zu Erstellen eines Datensatzes mithilfe der API.
Erstellen einer Zielverbindung target-connection
Eine Zielverbindung stellt die Verbindung zum Ziel dar, an dem die aufgenommenen Daten gespeichert werden sollen. Um eine Zielverbindung zu erstellen, müssen Sie die ID der Festnetzverbindungsspezifikation angeben, die dem Data Lake entspricht. Diese ID lautet: c604ff05-7f1a-43c0-8e18-33bf874cb11c
.
Sie verfügen jetzt über die eindeutigen Kennungen eines Zielschemas, eines Zieldatensatzes und der Verbindungsspezifikations-ID zum Data Lake. Anhand dieser Kennungen können Sie mit der Flow Service-API eine Zielverbindung erstellen, um den Datensatz anzugeben, der die eingehenden Quelldaten enthalten wird.
API-Format
POST /targetConnections
Anfrage
Die folgende Anfrage erstellt eine Zielverbindung für Chatlio:
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 a Chatlio.",
"description": "Streaming Target Connection for a Chatlio.",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "json",
"schema": {
"id": "https://ns.adobe.com/extconndev/schemas/49cecec83dd1a8da1aef4a96c67c06654e8c337a0a3b4262",
"version": "application/vnd.adobe.xed-full+json;version=1"
}
},
"params": {
"dataSetId": "63ef7df781f14a1bd02a7e49"
}
}'
name
description
connectionSpec.id
c604ff05-7f1a-43c0-8e18-33bf874cb11c
.data.format
params.dataSetId
Antwort
Eine erfolgreiche Antwort gibt die eindeutige Kennung der neuen Zielverbindung an (id
). Diese ID ist in späteren Schritten erforderlich.
{
"id": "f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5",
"etag": "\"7f0072bc-0000-0200-0000-63f314a50000\""
}
Erstellen einer Zuordnung mapping
Damit die Quelldaten in einen Zieldatensatz aufgenommen werden können, müssen sie zunächst dem Zielschema zugeordnet werden, zu dem der Zieldatensatz gehört. Dies wird erreicht, indem eine POST-Anfrage an Data Prep API mit in der Anfrage-Payload definierten Datenzuordnungen ausgeführt wird.
API-Format
POST /conversion/mappingSets
Anfrage
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.slackchannel_ID",
"sourceAttribute": "slackChannelId",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.slackchannel_name",
"sourceAttribute": "slackChannelName",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.UUID",
"sourceAttribute": "visitor.UUID",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.chatlio_email",
"sourceAttribute": "visitor.email",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.message",
"sourceAttribute": "message",
"identity": false,
"version": 0
},
{
"destinationXdmPath": "_extconndev.channel_ID",
"sourceAttribute": "channelId",
"identity": false,
"version": 0
}
]
}'
outputSchema.schemaRef.id
mappings.sourceType
mappings.source
mappings.destination
Antwort
Eine erfolgreiche Antwort gibt Details zur neu erstellten Zuordnung an, einschließlich der eindeutigen Kennung (id
). Dieser Wert ist in einem späteren Schritt zum Erstellen eines Datenflusses erforderlich.
{
"id": "4b7188aad69c44529a5e674ab5d3568b",
"version": 0,
"createdDate": 1676875099546,
"modifiedDate": 1676875099546,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
Erstellen eines Flusses flow
Der letzte Schritt beim Übertragen von Daten von Chatlio an Platform besteht darin, einen Datenfluss zu erstellen. Bislang haben Sie die folgenden erforderlichen Werte vorbereitet:
Ein Datenfluss ist für die Planung und Erfassung von Daten aus einer Quelle verantwortlich. Sie können einen Datenfluss erstellen, indem Sie eine POST-Anfrage ausführen und dabei die oben genannten Werte in der Payload angeben.
API-Format
POST /flows
Anfrage
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 Chatlio",
"description": "Streaming Dataflow for Chatlio",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"sourceConnectionIds": [
"7689a40d-43eb-4f74-a3f1-092a55884f6c"
],
"targetConnectionIds": [
"f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "4b7188aad69c44529a5e674ab5d3568b",
"mappingVersion": 0
}
}
]
}'
name
description
flowSpec.id
e77fde5a-22a8-11ed-861d-0242ac120002
.flowSpec.version
1.0
festgelegt.sourceConnectionIds
targetConnectionIds
transformations
transformations.name
transformations.params.mappingId
transformations.params.mappingVersion
0
festgelegt.Antwort
Bei einer erfolgreichen Antwort wird die ID (id
) des neu erstellten Datenflusses angegeben. Mit dieser ID können Sie Ihren Datenfluss überwachen, aktualisieren oder löschen.
{
"id": "d947e6a9-ea53-42c4-985c-c9379265491f",
"etag": "\"9b01c840-0000-0200-0000-63f3163e0000\""
}
Abrufen der Streaming-Endpunkt-URL get-streaming-endpoint
Mit dem erstellten Datenfluss können Sie jetzt Ihre Streaming-Endpunkt-URL abrufen. Sie werden diese Endpunkt-URL verwenden, um Ihre Quelle für einen Webhook zu abonnieren, sodass Ihre Quelle mit Experience Platform kommunizieren kann.
Um Ihre Streaming-Endpunkt-URL abzurufen, stellen Sie eine GET-Anfrage an den /flows
-Endpunkt und geben Sie die Kennung Ihres Datenflusses an.
API-Format
GET /flows/{FLOW_ID}
Anfrage
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}'
Antwort
Eine erfolgreiche Antwort gibt Informationen zu Ihrem Datenfluss zurück, einschließlich Ihrer Endpunkt-URL, die als inletUrl
markiert ist. Rufen Sie die Seite Webhook einrichten auf, um den erforderlichen Wert abzurufen.
{
"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 Chatlio",
"description": "Streaming Dataflow for Chatlio",
"flowSpec": {
"id": "e77fde5a-22a8-11ed-861d-0242ac120002",
"version": "1.0"
},
"state": "enabled",
"version": "\"9b012541-0000-0200-0000-63f316430000\"",
"etag": "\"9b012541-0000-0200-0000-63f316430000\"",
"sourceConnectionIds": [
"7689a40d-43eb-4f74-a3f1-092a55884f6c"
],
"targetConnectionIds": [
"f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5"
],
"inheritedAttributes": {
"properties": {
"isSourceFlow": true
},
"sourceConnections": [
{
"id": "7689a40d-43eb-4f74-a3f1-092a55884f6c",
"connectionSpec": {
"id": "073127a3-26e3-496c-9d94-9f48fb93fba8",
"version": "1.0"
}
}
],
"targetConnections": [
{
"id": "f7be8ab6-e5ea-4405-83b9-200cdfb2a9e5",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
}
}
]
},
"options": {
"inletUrl": "https://dcs.adobedc.net/collection/e71b6a6cd7270388674f8ab68ee438da58ba4434dea63cc547ee21547275923c"
},
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "4b7188aad69c44529a5e674ab5d3568b",
"mappingVersion": 0
}
}
],
"runs": "/runs?property=flowId==d947e6a9-ea53-42c4-985c-c9379265491f",
"providerRefId": "bfac26f5-9256-438c-b1a0-e07a7dc675f6",
"lastOperation": {
"started": 0,
"updated": 0,
"operation": "enable"
}
}
]
}
Anhang appendix
Im folgenden Abschnitt finden Sie Informationen zu den Schritten, mit denen Sie Ihren Datenfluss überwachen, aktualisieren und löschen können.
Überwachen Ihres Datenflusses monitor-dataflow
Nachdem Ihr Datenfluss erstellt wurde, können Sie die Datenaufnahme überwachen, um Informationen über die Datenflussausführungen, den Abschlussstatus und Fehler anzuzeigen. Vollständige API-Beispiele finden Sie im Handbuch zum Überwachen der Datenflüsse Ihrer Quellen mithilfe der API.
Aktualisieren des Datenflusses update-dataflow
Aktualisieren Sie die Details Ihres Datenflusses, z. B. seinen Namen und seine Beschreibung, sowie den Ausführungszeitplan und die zugehörigen Zuordnungssätze, indem Sie eine PATCH-Anfrage an den /flows
-Endpunkt der Flow Service -API richten und dabei die Kennung Ihres Datenflusses angeben. Bei einer PATCH-Anfrage müssen Sie die eindeutige etag
Ihres Datenflusses in der Kopfzeile If-Match
angeben. Die vollständigen API-Beispiele finden Sie im Handbuch zum Aktualisieren der Datenflüsse für Quellen mithilfe der API .
Konto aktualisieren update-account
Aktualisieren Sie den Namen, die Beschreibung und die Anmeldeinformationen Ihres Quellkontos, indem Sie eine PATCH-Anfrage an die Flow Service -API richten und dabei Ihre Basisverbindungs-ID als Abfrageparameter angeben. Bei einer PATCH-Anfrage müssen Sie die eindeutige etag
Ihres Quellkontos in der Kopfzeile If-Match
angeben. Die vollständigen API-Beispiele finden Sie im Handbuch unter Aktualisieren Ihres Quellkontos mit der API.
Löschen des Datenflusses delete-dataflow
Löschen Sie Ihren Datenfluss, indem Sie eine DELETE-Anfrage an die Flow Service -API richten und dabei die Kennung des Datenflusses angeben, den Sie im Rahmen des Abfrageparameters löschen möchten. Vollständige API-Beispiele finden Sie im Handbuch zum Löschen Ihrer Datenflüsse mit der API 🔗.
Konto löschen delete-account
Löschen Sie Ihr Konto, indem Sie eine DELETE-Anfrage an die Flow Service -API richten und dabei die Basisverbindungs-ID des Kontos angeben, das Sie löschen möchten. Die vollständigen API-Beispiele finden Sie im Handbuch zum Löschen Ihres Quellkontos mithilfe der API🔗.