DokumentationExperience PlatformAnleitung zu Quell-Connectoren

Erstellen einer Phoenix-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.

In diesem Tutorial erfahren Sie, wie Sie mithilfe der Flow Service -API eine Basisverbindung erstellen und Ihr Phoenix-Konto mit Adobe Experience Platform verbinden.

Erste Schritte

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 Experience Platform-Diensten zu strukturieren, zu beschriften und zu erweitern.
  • Sandboxes: Experience Platform stellt virtuelle Sandboxes bereit, die eine einzelne Experience Platform-Instanz in separate virtuelle Umgebungen aufteilen, um die Entwicklung und Weiterentwicklung von Programmen für digitale Erlebnisse zu erleichtern.

Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um mithilfe der Flow Service -API erfolgreich eine Verbindung zu Phoenix herstellen zu können.

Sammeln erforderlicher Anmeldeinformationen

Sie müssen die folgenden Authentifizierungsberechtigungen angeben, um Ihr Phoenix-Konto mit Experience Platform zu verbinden.

Anmeldedaten
Beschreibung
host
Die IP-Adresse oder der Hostname des Phoenix -Servers.
username
Der Benutzername, mit dem Sie auf Phoenix Server zugreifen.
password
Das dem Benutzer entsprechende Kennwort.
port
Der TCP-Port, den der Phoenix -Server verwendet, um auf Clientverbindungen zu warten. Wenn Sie eine Verbindung zu Azure HDInsights herstellen, geben Sie den Port als 443 an. Wenn dieser Parameter nicht angegeben wird, wird der Standardwert 8765 verwendet.
httpPath
Die Teil-URL, die dem Phoenix -Server entspricht. Geben Sie /hbasephoenix0 an, wenn Sie den HDInsights-Cluster verwenden.Azure
enableSsl
Ein boolean -Wert. Gibt an, ob die Verbindungen zum Server mit SSL verschlüsselt werden.
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 Phoenix lautet: 102706fb-a5cd-42ee-afe0-bc42f017ff43

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

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 Basisverbindung zu erstellen, stellen Sie eine POST-Anfrage an den /connections -Endpunkt und geben Sie dabei Ihre Phoenix-Authentifizierungsdaten im Anfrageinhalt an.

API-Format

POST /connections

Anfrage

Die folgende Anfrage erstellt eine Basisverbindung für Phoenix:

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": "Phoenix test connection",
      "description": "Phoenix test connection",
      "auth": {
          "specName": "Basic Authentication",
      "params": {
          "host":  "{HOST}",
          "username": "{USERNAME}",
          "password":"{PASSWORD}",
          "port": {PORT},
          "httpPath": "{PATH}",
          "enableSsl": {SSL}
          }
      },
      "connectionSpec": {
          "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
          "version": "1.0"
      }
  }'
Eigenschaft
Beschreibung
auth.params.host
Der Host des Phoenix-Servers.
auth.params.username
Der Benutzername, der Ihrer Phoenix-Verbindung zugeordnet ist.
auth.params.password
Das Kennwort für Ihre Phoenix-Verbindung.
auth.params.port
Der TCP-Port für Ihre Phoenix-Verbindung.
auth.params.httpPath
Der teilweise HTTP-Pfad für Ihre Phoenix-Verbindung.
auth.params.enableSsl
Der boolesche Wert, der angibt, ob die Verbindungen zum Server mit SSL verschlüsselt werden.
connectionSpec.id
Die Phoenix Verbindungsspezifikations-ID: 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Antwort

Eine erfolgreiche Antwort gibt Details der neu erstellten Verbindung zurück, einschließlich ihrer eindeutigen Kennung (id). Diese ID ist erforderlich, um Ihre Daten im nächsten Tutorial zu untersuchen.

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

Nächste Schritte

In diesem Tutorial haben Sie eine Phoenix-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