Erstellen einer Microsoft Dynamics-Quellverbindung 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 API Flow Service, um Sie durch die Schritte zu führen, die notwendig sind, um die Plattform mit einem Microsoft Dynamics-Konto (nachstehend "Dynamics" genannt) zu verbinden, das die Flow Service API verwendet.

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 Plattformdiensten zu strukturieren, zu kennzeichnen und zu verbessern.
  • Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Anwendungen für digitale Erlebnisse entwickeln und weiterentwickeln können.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um die Plattform mit der Flow Service-API erfolgreich mit einem Dynamics-Konto zu verbinden.

Erforderliche Anmeldedaten sammeln

Damit Flow Service eine Verbindung zu Dynamics herstellen 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.
servicePrincipalId Die Client-ID Ihres Dynamics-Kontos. Diese ID ist bei der Verwendung der Dienstprinzipal- und der schlüsselbasierten Authentifizierung erforderlich.
servicePrincipalKey Der Hauptgeheimschlüssel des Dienstes. Diese Berechtigung ist bei der Verwendung der Dienstprinzipal- und der schlüsselbasierten Authentifizierung erforderlich.

Weitere Informationen zum Einstieg finden Sie unter this 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

Um Platform-APIs aufrufen zu können, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Im Rahmen des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Kopfzeilen in allen Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:

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

Alle Ressourcen in Experience Platform, einschließlich der Ressourcen von Flow Service, werden zu bestimmten virtuellen Sandboxen isoliert. Bei allen Anfragen an Platform-APIs ist eine Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:

  • 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

Verbindung erstellen

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

Eine Dynamics-Verbindung mit einfacher Authentifizierung erstellen

Um eine Dynamics-Verbindung mit einfacher Authentifizierung zu erstellen, stellen Sie eine POST an die Flow Service-API, während Sie Werte für serviceUri, username und password angeben.

API-Format

POST /connections

Anfrage

Um eine Dynamics-POST zu erstellen, muss die eindeutige Verbindungs-ID als Teil der Verbindungsanforderung angegeben werden. Die Verbindungs-Spezifikations-ID für Dynamics ist 38ad80fe-8b06-4938-94f4-d4ee80266b07.

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 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"
        }
    }'
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 gibt die neu erstellte Verbindung einschließlich der eindeutigen Kennung (id) zurück. Diese ID ist erforderlich, um Ihr CRM-System im nächsten Schritt zu untersuchen.

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

Eine Dynamics-Verbindung mit einer Service-Prinzipal-Key-basierten Authentifizierung erstellen

Um eine Dynamics-Verbindung mit der Hauptschlüssel-basierten Authentifizierung des Dienstes zu erstellen, stellen Sie eine POST an die Flow Service-API, während Sie Werte für serviceUri, servicePrincipalId und servicePrincipalKey eingeben.

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 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"
        }
    }'
Eigenschaft Beschreibung
auth.params.serviceUri Der Dienst-URI, der Ihrer Dynamics-Instanz zugeordnet ist.
auth.params.servicePrincipalId Die Client-ID Ihres Dynamics-Kontos. Diese ID ist bei der Verwendung der Dienstprinzipal- und der schlüsselbasierten Authentifizierung erforderlich.
auth.params.servicePrincipalKey Der Hauptgeheimschlüssel des Dienstes. Diese Berechtigung ist bei der Verwendung der Dienstprinzipal- und der schlüsselbasierten Authentifizierung erforderlich.

Antwort

Eine erfolgreiche Antwort gibt die neu erstellte Verbindung einschließlich der eindeutigen Kennung (id) zurück. Diese ID ist erforderlich, um Ihr CRM-System im nächsten Schritt zu untersuchen.

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

Nächste Schritte

In diesem Lernprogramm haben Sie eine Dynamics-Verbindung mit der Flow Service-API erstellt und den eindeutigen ID-Wert der Verbindung erhalten. Sie können diese ID im nächsten Lernprogramm verwenden, um zu lernen, wie Sie CRM-Systeme mithilfe der Flow Service API](…/…/explore/crm.md) untersuchen.[

Auf dieser Seite