Erstellen eines Microsoft Dynamics Connectors mit der Flow Service API

Flow Service wird zur Erfassung und Zentralisierung von Kundendaten aus unterschiedlichen Quellen innerhalb von Adobe Experience Platform verwendet. Der Dienst stellt eine Benutzeroberfläche und eine RESTful-API bereit, über die alle unterstützten Quellen verbunden werden können.

Dieses Lernprogramm verwendet die Flow Service API, um Sie durch die Schritte zur Verbindung Platform mit einem Microsoft Dynamics (nachfolgend "Dynamics") Konto zur Erfassung von CRM-Daten zu führen.

Wenn Sie lieber die Benutzeroberfläche in verwenden möchten, Experience Platformbietet das Dynamics source Connector-UI-Lernprogramm eine schrittweise Anleitung zum Durchführen ähnlicher Aktionen.

Erste Schritte

Dieses Handbuch setzt ein Verständnis der folgenden Komponenten von Adobe 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 verbessern.
  • Sandboxen: Experience Platform stellt virtuelle Sandboxes zur Verfügung, die eine einzelne Platform Instanz in separate virtuelle Umgebung unterteilen, um Anwendungen für digitale Erlebnisse zu entwickeln und weiterzuentwickeln.

The following sections provide additional information that you will need to know in order to successfully connect Platform to a Dynamics account using the Flow Service API.

Erforderliche Anmeldedaten sammeln

Damit eine Verbindung Flow Service zu Dynamicshergestellt werden kann, müssen Sie Werte für die folgenden Verbindungseigenschaften angeben:

Berechtigung Beschreibung
serviceUri Die Dienst-URL Ihrer Dynamics Instanz.
username Der Benutzername für Ihr Dynamics Benutzerkonto.
password Das Kennwort für Ihr Dynamics Konto.

Weitere Informationen zu den ersten Schritten finden Sie in diesem Dynamics Dokument.

Lesen von Beispiel-API-Aufrufen

In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform

Sammeln von Werten für erforderliche Kopfzeilen

In order to make calls to Platform APIs, you must first complete the authentication tutorial. Completing the authentication tutorial provides the values for each of the required headers in all Experience Platform API calls, as shown below:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

All resources in Experience Platform, including those belonging to the Flow Service, are isolated to specific virtual sandboxes. All requests to Platform APIs require a header that specifies the name of the sandbox the operation will take place in:

  • x-sandbox-name: {SANDBOX_NAME}

Bei allen Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Medientyp-Kopfzeile erforderlich:

  • Content-Type: application/json

Verbindungsspezifikationen nachschlagen

Bevor Sie eine Verbindung Platform zu einem Dynamics Konto herstellen, müssen Sie sicherstellen, dass die Verbindungsspezifikationen für dieses Konto vorhanden sind Dynamics. Wenn keine Verbindungsspezifikationen vorhanden sind, kann keine Verbindung hergestellt werden.

Jede verfügbare Quelle verfügt über einen eigenen Satz von Verbindungsspezifikationen, um Verbindungseigenschaften wie Authentifizierungsanforderungen zu beschreiben. Sie können Verbindungsspezifikationen nachschlagen, Dynamics indem Sie eine GET anfordern und Abfragen-Parameter verwenden.

API-Format

Beim Senden einer GET ohne Abfrage-Parameter werden Verbindungsspezifikationen für alle verfügbaren Quellen zurückgegeben. Sie können die Abfrage einbeziehen, property=name=="dynamics-online" um Informationen speziell für DynamicsSie zu erhalten.

GET /connectionSpecs
GET /connectionSpecs?property=name=="dynamics-online"

Anfrage

Die folgende Anforderung ruft die Verbindungsspezifikationen für Dynamicsab.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="dynamics-online"' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

Antwort

Eine erfolgreiche Antwort gibt die Verbindungsspezifikationen für Dynamicseinschließlich der eindeutigen Kennung (id) zurück. Diese ID ist im nächsten Schritt erforderlich, um eine Basisverbindung zu erstellen.

{
    "items": [
        {
            "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
            "name": "dynamics-online",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication for Dynamics-Online",
                    "settings": {
                        "authenticationType": "Office365",
                        "deploymentType": "Online"
                    },
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to dynamics-online",
                        "properties": {
                            "serviceUri": {
                                "type": "string",
                                "description": "The service URL of your Dynamics instance"
                            },
                            "username": {
                                "type": "string",
                                "description": "User name for the user account"
                            },
                            "password": {
                                "type": "string",
                                "description": "Password for the user account",
                                "format": "password"
                            }
                        },
                        "required": [
                            "username",
                            "password",
                            "serviceUri"
                        ]
                    }
                }
            ]
        }
    ]
}

Verbindung für die API erstellen

Eine Verbindung für die API gibt eine Quelle an und enthält Ihre Anmeldeinformationen für diese Quelle. Pro Dynamics Konto ist nur eine Verbindung für die API erforderlich, da sie zum Erstellen mehrerer Quell-Connectors verwendet werden kann, um verschiedene Daten einzubringen.

API-Format

POST /connections

Anfrage

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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d '{
        "name": "Dynamics Base Connection",
        "description": "Base connection for Dynamics account",
        "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"
        }
    }'
Eigenschaft Beschreibung
auth.params.serviceUri Der Dienst-URI, der Ihrer Dynamics Instanz zugeordnet ist.
auth.params.username Der mit Ihrem Dynamics Konto verknüpfte Benutzername.
auth.params.password Das Ihrem Dynamics Konto zugeordnete Kennwort.
connectionSpec.id Die Verbindungsspezifikation id Ihres Dynamics Kontos, die im vorherigen Schritt abgerufen wurde.

Antwort

Eine erfolgreiche Antwort enthält die eindeutige Kennung der Basisverbindung (id). Diese ID ist erforderlich, um Ihre Daten im nächsten Lernprogramm zu untersuchen.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

Nächste Schritte

In diesem Tutorial haben Sie eine Verbindung für Ihr Dynamics Konto mithilfe von APIs erstellt und eine eindeutige ID als Teil des Antwortkörpers erhalten. Sie können diese Verbindungs-ID im nächsten Lernprogramm verwenden, um zu erfahren, wie Sie CRM-Systeme mithilfe der Flow Service API erkunden.

Auf dieser Seite