Verbinden von Microsoft Dynamics mit Experience Platform mithilfe der Flow Service-API
Erstellt für:
- Entwickler
Lesen Sie dieses Handbuch, um zu erfahren, wie Sie Ihre Microsoft Dynamics mithilfe der Flow Service API) mit Adobe Experience Platform.
Erste Schritte
Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe Experience Platform voraus:
- Quellen: Experience Platform ermöglicht die Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Experience Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
- Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Experience Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse besser entwickeln und weiterentwickeln können.
Verwenden von Experience Platform-APIs
Informationen zum erfolgreichen Aufrufen von Experience Platform-APIs finden Sie im Handbuch unter mit Experience Platform-APIs.
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um Experience Platform mithilfe der Flow Service-API erfolgreich mit einem Dynamics-Konto verbinden zu können.
Sammeln erforderlicher Anmeldedaten
Um Flow Service mit Dynamics zu verbinden, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:
Anmeldedaten | Beschreibung |
---|---|
serviceUri | Die Service-URL Ihrer Dynamics. |
username | Der Benutzername für Ihr Dynamics Benutzerkonto. |
password | Das Kennwort für Ihr Dynamics. |
Anmeldedaten | Beschreibung |
---|---|
servicePrincipalId | Die Client-ID Ihres Dynamics. Diese ID ist erforderlich, wenn die Service-Prinzipal- und schlüsselbasierte Authentifizierung verwendet wird. |
servicePrincipalKey | Der geheime Schlüssel des Service-Prinzipals. Diese Berechtigung ist erforderlich, wenn die Authentifizierung über einen Service-Prinzipal und einen Schlüssel verwendet wird. |
Weitere Informationen zu den ersten Schritten finden Sie diesem Dynamics Dokument.
Erstellen einer Basisverbindung
Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Experience Platform gespeichert, einschließlich der Authentifizierungsdaten Ihrer Quelle, des aktuellen Verbindungsstatus und Ihrer eindeutigen ID der Basisverbindung. Mit der Kennung der Basisverbindung können Sie Dateien aus Ihrer Quelle heraus analysieren und darin navigieren und die spezifischen Elemente identifizieren, die Sie erfassen möchten, einschließlich Informationen zu ihren Datentypen und Formaten.
Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den Endpunkt /connections
und geben Sie dabei Ihre Dynamics-Authentifizierungs-Anmeldedaten als Teil der Anfrageparameter an.
API-Format
POST /connections
Um eine Dynamics Basisverbindung mit einfacher Authentifizierung zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service-API und geben dabei Werte für die serviceUri
, username
und password
Ihrer Verbindung an.
Anfrage
Die folgende Anfrage erstellt eine Basisverbindung für eine Dynamics mit einfacher Authentifizierung.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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": "Dynamics connection",
"description": "Dynamics connection using basic auth",
"auth": {
"specName": "Basic Authentication for Dynamics-Online",
"params": {
"serviceUri": "{SERVICE_URI}",
"username": "{USERNAME}",
"password": "{PASSWORD}"
}
},
"connectionSpec": {
"id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
"version": "1.0"
}
}'
auth.params.serviceUri
auth.params.username
auth.params.password
connectionSpec.id
38ad80fe-8b06-4938-94f4-d4ee80266b07
Antwort
Eine erfolgreiche Antwort gibt die neu erstellte Basisverbindung zurück, einschließlich ihrer eindeutigen Kennung (id
).
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
Um eine Dynamics Basisverbindung mit Authentifizierung über einen Schlüssel des Service zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service-API und geben dabei Werte für die serviceUri
, servicePrincipalId
und servicePrincipalKey
Ihrer Verbindung an.
Anfrage
Die folgende Anfrage erstellt eine Basisverbindung für eine Dynamics mit einer schlüsselbasierten Authentifizierung, die einen einfachen Service-Prinzipal verwendet.
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-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": "Dynamics connection",
"description": "Dynamics connection using key-based authentication",
"auth": {
"specName": "Service Principal Key Based Authentication",
"params": {
"serviceUri": "{SERVICE_URI}",
"servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
"servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
}
},
"connectionSpec": {
"id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
"version": "1.0"
}
}'
auth.params.serviceUri
auth.params.servicePrincipalId
auth.params.servicePrincipalKey
connectionSpec.id
38ad80fe-8b06-4938-94f4-d4ee80266b07
Antwort
Eine erfolgreiche Antwort gibt die neu erstellte Verbindung zurück, einschließlich ihrer eindeutigen Kennung (id
).
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
Erkunden von Datentabellen
Um Ihre Dynamics-Datentabellen zu untersuchen, stellen Sie eine GET-Anfrage an den /connections/{BASE_CONNECTION_ID}/explore
-Endpunkt und geben Sie Ihre Basisverbindungs-ID als Teil der Abfrageparameter an.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
{BASE_CONNECTION_ID}
Anfrage
Mit der folgenden Anfrage wird die Liste der verfügbaren Tabellen und Ansichten für eine Dynamics mit der Basisverbindungs-ID abgerufen: dd668808-25da-493f-8782-f3433b976d1e
.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/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}' \
-H 'Content-Type: application/json' \
Antwort
Eine erfolgreiche Antwort gibt die Dynamics Tabellen und Ansichten des Ordners auf der Stammebene zurück.
[
{
"type": "table",
"name": "systemuserlicenses",
"path": "systemuserlicenses",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Process Dependency",
"path": "workflowdependency",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "view",
"name": "accountView1",
"path": "accountView1",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "view",
"name": "Inactive_ACC_custom",
"path": "Inactive_ACC_custom",
"canPreview": true,
"canFetchSchema": true
}
]
Verwenden des Primärschlüssels zur Optimierung der Datenexploration
Sie können Ihre Erkundungsabfragen optimieren, indem Sie primaryKey
als Teil Ihrer Abfrageparameter bereitstellen. Sie müssen den Primärschlüssel der Dynamics angeben, wenn Sie primaryKey
als Abfrageparameter angeben.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?preview=true&object={OBJECT}&objectType={OBJECT_TYPE}&previewCount=10&primaryKey={PRIMARY_KEY}
{BASE_CONNECTION_ID}
preview
{OBJECT}
{OBJECT_TYPE}
previewCount
{PRIMARY_KEY}
Anfrage
curl -X GET \
'https://platform-stage.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?preview=true&object=lead&objectType=table&previewCount=10&primaryKey=leadid' \
-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' \
Überprüfen der Tabellenstruktur
Um die Struktur einer bestimmten Tabelle zu überprüfen, stellen Sie eine GET-Anfrage an /connections/{BASE_CONNECTION_ID}/explore
und geben Sie den Pfad zur bestimmten Tabelle als Abfrageparameter an.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?object={TABLE_PATH}&objectType=table
{BASE_CONNECTION_ID}
{TABLE_PATH}
Anfrage
Die folgende Anfrage ruft die Struktur und den Inhalt einer Dynamics mit dem Pfad workflowdependency
ab.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?object=workflowdependency&objectType=table' \
-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' \
Antwort
Eine erfolgreiche Antwort gibt den Inhalt des Pfads workflowdependency
zurück.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "first_name",
"type": "string",
"meta": {
"originalType": "String"
}
},
{
"name": "last_name",
"type": "string",
"meta": {
"originalType": "String"
}
},
{
"name": "email",
"type": "string",
"meta": {
"originalType": "String"
}
}
]
}
}
Prüfen der Struktur einer Ansicht
In Dynamics bezieht sich eine Ansicht auf die anzuzeigenden Spalten, die Breite jeder Spalte, das Standardsystem, in dem eine Liste von Datensätzen sortiert wird, und die Standardfilter, die angewendet werden, um zu beschränken, welche Datensätze in der Liste angezeigt werden.
Um die Ansichtsstruktur zu überprüfen, stellen Sie eine GET-Anfrage an /connections/{BASE_CONNECTION_ID}/explore
und geben Sie den Ansichtspfad in Ihren Abfrageparametern an. Darüber hinaus müssen Sie objectType
als view
angeben.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?object={VIEW_PATH}&objectType=view
{BASE_CONNECTION_ID}
{VIEW_PATH}
Anfrage
Mit der folgenden Anfrage werden accountView1
abgerufen.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?object=accountView1&objectType=view' \
-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' \
Antwort
Eine erfolgreiche Antwort gibt die Struktur von accountView1
zurück.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "name",
"type": "string",
"meta": {
"originalType": "string"
},
"xdm": {
"type": "string"
}
},
{
"name": "fetchxml",
"type": "string",
"meta": {
"originalType": "string"
},
"xdm": {
"type": "string"
}
},
{
"name": "querytype",
"type": "integer",
"meta": {
"originalType": "int"
},
"xdm": {
"type": "integer",
"minimum": -2147483648,
"maximum": 2147483647
}
},
{
"name": "userqueryid",
"type": "string",
"meta": {
"originalType": "guid"
},
"xdm": {
"type": "string"
}
}
]
}
}
Vorschau der Entitätstypansicht
Um eine Vorschau des Inhalts einer Ansicht anzuzeigen, stellen Sie eine GET-Anfrage an /connections/{BASE_CONNECTION_ID}/explore
und nehmen Sie den Ansichtspfad sowie preview=true
in die Abfrageparameter auf.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?object={VIEW_PATH}&preview=true&objectType=view
{BASE_CONNECTION_ID}
{VIEW_PATH}
Anfrage
Mit der folgenden Anfrage wird eine Vorschau des Inhalts von accountView1
angezeigt.
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?object=accountView1&preview=true&objectType=view' \
-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' \
Antwort
Eine erfolgreiche Antwort gibt den Inhalt von accountView1
zurück.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "emailaddress1",
"type": "string",
"meta": {
"originalType": "string"
},
"xdm": {
"type": "string"
}
},
{
"name": "contactid",
"type": "string",
"meta": {
"originalType": "guid"
},
"xdm": {
"type": "string"
}
},
{
"name": "fullname",
"type": "string",
"meta": {
"originalType": "string"
},
"xdm": {
"type": "string"
}
}
]
},
"data": [
{
"contactid": "396e19de-0852-ec11-8c62-00224808a1df",
"fullname": "Tim Barr",
"emailaddress1": "barrtim@googlemedia.com"
}
]
}
Erstellen einer Quellverbindung zur Aufnahmeansicht
Um eine Quellverbindung zu erstellen und eine Ansicht aufzunehmen, stellen Sie eine POST-Anfrage an den /sourceConnections
-Endpunkt, geben Sie den Tabellennamen an und geben Sie entityType
wie im Anfragetext view
an.
API-Format
POST /sourceConnections
Anfrage
Die folgende Anfrage erstellt eine Dynamics Quellverbindung und nimmt Ansichten auf.
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": "Dynamics Source Connection",
"description": "Dynamics Source Connection",
"baseConnectionId": "dd668808-25da-493f-8782-f3433b976d1e",
"data": {
"format": "tabular",
"schema": null,
"properties": null
},
"params": {
"tableName": "Contacts with name TIM",
"entityType": "view"
},
"connectionSpec": {
"id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
"version": "1.0"
}
}'
Antwort
Bei einer erfolgreichen Antwort werden die neu generierte Quellverbindungs-ID und das entsprechende eTag zurückgegeben.
{
"id": "e566bab3-1b58-428c-b751-86b8cc79a3b4",
"etag": "\"82009592-0000-0200-0000-678121030000\""
}
Verwenden des Primärschlüssels zur Optimierung des Datenflusses
Sie können Ihren Dynamics Datenfluss auch optimieren, indem Sie den Primärschlüssel als Teil der Parameter Ihres Anfragetexts angeben.
API-Format
POST /sourceConnections
Anfrage
Die folgende Anfrage erstellt eine Dynamics-Quellverbindung, während der Primärschlüssel als contactid
angegeben wird.
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": "Dynamics Source Connection",
"description": "Dynamics Source Connection",
"baseConnectionId": "dd668808-25da-493f-8782-f3433b976d1e",
"data": {
"format": "tabular"
},
"params": {
"tableName": "contact",
"primaryKey": "contactid"
},
"connectionSpec": {
"id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
"version": "1.0"
}
}'
baseConnectionId
data.format
params.tableName
params.primaryKey
connectionSpec.id
Antwort
Bei einer erfolgreichen Antwort werden die neu generierte Quellverbindungs-ID und das entsprechende eTag zurückgegeben.
{
"id": "e566bab3-1b58-428c-b751-86b8cc79a3b4",
"etag": "\"82009592-0000-0200-0000-678121030000\""
}
Nächste Schritte
In diesem Tutorial haben Sie eine Microsoft Dynamics-Basisverbindung mithilfe der Flow Service-API erstellt. Sie können diese Basisverbindungs-ID in den folgenden Tutorials verwenden: