DokumentationExperience PlatformAnleitung zu Quell-Connectoren

Erstellen einer Salesforce-Basisverbindung mithilfe der Flow Service-API

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler

Eine Basisverbindung stellt die authentifizierte Verbindung zwischen einer Quelle und Adobe Experience Platform dar.

Dieses Tutorial führt Sie durch die Schritte zum Erstellen einer Basisverbindung für Salesforce mithilfe der Flow Service -API.

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 Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
  • 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.

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

Sammeln erforderlicher Anmeldeinformationen

Die Quelle Salesforce unterstützt grundlegende Authentifizierung und OAuth2 Client Credential.

Grundlegende Authentifizierung

Um Ihr Salesforce-Konto mit Flow Service mittels einfacher Authentifizierung zu verbinden, geben Sie Werte für die folgenden Anmeldedaten an:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2
Anmeldedaten Beschreibung
environmentUrl Die URL der Quellinstanz Salesforce.
username Der Benutzername für das Salesforce -Benutzerkonto.
password Das Kennwort für das Salesforce -Benutzerkonto.
securityToken Das Sicherheits-Token für das Salesforce -Benutzerkonto.
apiVersion (Optional) Die REST-API-Version der von Ihnen verwendeten Salesforce-Instanz. Der Wert für die API-Version muss mit einer Dezimalzahl formatiert sein. Wenn Sie beispielsweise die API-Version 52 verwenden, müssen Sie den Wert als 52.0 eingeben. Wenn dieses Feld leer gelassen wird, verwendet Experience Platform automatisch die neueste verfügbare Version.
connectionSpec.id Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Verbindungsspezifikations-ID für Salesforce ist: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

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

OAuth 2 Client Credential

Geben Sie Werte für die folgenden Anmeldedaten an, um Ihr Salesforce-Konto mithilfe der OAuth 2-Client-Anmeldedaten mit Flow Service zu verbinden:

table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Anmeldedaten Beschreibung
environmentUrl Die URL der Quellinstanz Salesforce.
clientId Die Client-ID wird zusammen mit dem Client-Geheimnis als Teil der OAuth2-Authentifizierung verwendet. Gemeinsam ermöglichen es die Client-ID und das Client-Geheimnis Ihrer Anwendung, im Namen Ihres Kontos zu arbeiten, indem Sie Ihre Anwendung mit Salesforce identifizieren.
clientSecret Das Client-Geheimnis wird zusammen mit der Client-ID als Teil der OAuth2-Authentifizierung verwendet. Gemeinsam ermöglichen es die Client-ID und das Client-Geheimnis Ihrer Anwendung, im Namen Ihres Kontos zu arbeiten, indem Sie Ihre Anwendung mit Salesforce identifizieren.
apiVersion Die REST-API-Version der von Ihnen verwendeten Salesforce-Instanz. Der Wert für die API-Version muss mit einer Dezimalzahl formatiert sein. Wenn Sie beispielsweise die API-Version 52 verwenden, müssen Sie den Wert als 52.0 eingeben. Wenn dieses Feld leer gelassen wird, verwendet Experience Platform automatisch die neueste verfügbare Version. Dieser Wert ist für die Authentifizierung von OAuth2-Client-Anmeldedaten obligatorisch.
connectionSpec.id Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich der Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Verbindungsspezifikations-ID für Salesforce ist: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

Weitere Informationen zur Verwendung von OAuth für Salesforce finden Sie im Salesforce Handbuch zu OAuth-Autorisierungsflüssen.

Verwenden von Platform-APIs

Informationen zum Aufrufen von Platform-APIs finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.

Erstellen einer Basisverbindung

Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Platform gespeichert, einschließlich der Authentifizierungsdaten Ihrer Quelle, des aktuellen Verbindungsstatus und Ihrer eindeutigen Kennung 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 Basis-Verbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den /connections-Endpunkt und geben Sie Ihre Salesforce-Authentifizierungsdaten im Anfrageinhalt an.

API-Format

POST /connections

Anfrage

Grundlegende Authentifizierung

Die folgende Anfrage erstellt eine Basisverbindung für Salesforce mithilfe der einfachen Authentifizierung:

code language-shell 
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": "ACME Salesforce account",
      "description": "Salesforce account using basic authentication",
      "auth": {
          "specName": "Basic Authentication",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "username": "acme-salesforce",
            "password": "xxxx",
            "securityToken": "xxxx"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Eigenschaft Beschreibung
auth.params.environmentUrl Die URL Ihrer Salesforce -Instanz.
auth.params.username Der Benutzername, der Ihrem Salesforce -Konto zugeordnet ist.
auth.params.password Das Ihrem Salesforce-Konto zugeordnete Kennwort.
auth.params.securityToken Das Ihrem Salesforce-Konto zugeordnete Sicherheits-Token.
connectionSpec.id Die Salesforce Verbindungsspezifikations-ID: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.
OAuth 2 Client Credential

Die folgende Anfrage erstellt eine Basisverbindung für Salesforce mithilfe von OAuth 2 Client Credential:

code language-shell 
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": "ACME Salesforce account",
      "description": "Salesforce account using OAuth 2",
      "auth": {
          "specName": "OAuth2 Client Credential",
          "params":
            "environmentUrl": "https://acme-enterprise-3126.my.salesforce.com",
            "clientId": "xxxx",
            "clientSecret": "xxxx",
            "apiVersion": "60.0"
        }
      },
      "connectionSpec": {
          "id": "cfc0fee1-7dc0-40ef-b73e-d8b134c436f5",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Eigenschaft Beschreibung
auth.params.environmentUrl Die URL Ihrer Salesforce -Instanz.
auth.params.clientId Die mit Ihrem Salesforce-Konto verknüpfte Client-ID.
auth.params.clientSecret Das Client-Geheimnis, das Ihrem Salesforce-Konto zugeordnet ist.
auth.params.apiVersion Die REST-API-Version der von Ihnen verwendeten Salesforce-Instanz.
connectionSpec.id Die Salesforce Verbindungsspezifikations-ID: cfc0fee1-7dc0-40ef-b73e-d8b134c436f5.

Antwort

Bei einer erfolgreichen Antwort wird Ihre neu erstellte Basisverbindung zusammen mit der eindeutigen ID zurückgegeben.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700df7b-0000-0200-0000-5e3b424f0000\""
}

Nächste Schritte

In diesem Tutorial haben Sie eine Salesforce-Basisverbindung mithilfe der Flow Service-API erstellt. Sie können diese Basisverbindungs-ID in den folgenden Tutorials verwenden:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089