Erstellen einer SFTP-Basisverbindung mit der Flow Service-API

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 SFTP (Secure File Transfer Protocol) 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 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 erweitern.
  • 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.
WICHTIG

Es wird empfohlen, beim Erfassen von JSON-Objekten mit einer SFTP-Quellverbindung Zeilenumbrüche oder Zeilenumbrüche zu vermeiden. Um die Beschränkung zu umgehen, verwenden Sie ein einzelnes JSON-Objekt pro Zeile und verwenden mehrere Zeilen für die darauf folgenden Dateien.

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

Erforderliche Anmeldedaten sammeln

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

Berechtigung Beschreibung
host Der Name oder die IP-Adresse, die mit Ihrem SFTP-Server verknüpft ist.
username Der Benutzername mit Zugriff auf Ihren SFTP-Server.
password Das Kennwort für Ihren SFTP-Server.
privateKeyContent Der Base64-kodierte Inhalt mit privatem SSH-Schlüssel. Der Typ des OpenSSH-Schlüssels muss entweder als RSA oder als DSA klassifiziert werden.
passPhrase Der Ausdruck oder das Kennwort zum Entschlüsseln des privaten Schlüssels, wenn die Schlüsseldatei oder der Schlüsselinhalt durch einen Pass-Satz geschützt ist. Wenn privateKeyContent kennwortgeschützt ist, muss dieser Parameter mit der Passphrase des privaten Schlüsselinhalts als Wert verwendet werden.
connectionSpec.id Die Verbindungsspezifikation gibt die Connector-Eigenschaften einer Quelle zurück, einschließlich Authentifizierungsspezifikationen für die Erstellung der Basis- und Quellverbindungen. Die Verbindungsspezifikations-ID für SFTP lautet: b7bf2577-4520-42c9-bae9-cad01560f7bc.

Verwenden von Platform-APIs

Informationen dazu, wie Sie erfolgreich Aufrufe an Platform-APIs durchführen können, finden Sie im Handbuch Erste Schritte mit Platform-APIs.

Basisverbindung erstellen

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 Endpunkt /connections und geben Sie dabei Ihre SFTP-Authentifizierungsdaten als Teil der Anfrageparameter an.

Erstellen einer SFTP-Verbindung mithilfe einer einfachen Authentifizierung

Um eine SFTP-Basisverbindung mit Standardauthentifizierung zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service-API und geben Sie dabei Werte für host, userName und password an.

API-Format

POST /connections

Anfrage

Die folgende Anfrage erstellt eine Basisverbindung für SFTP mithilfe der einfachen 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: {IMS_ORG}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'Content-Type: application/json' \
    -d  '{
        "name": "SFTP connector with password",
        "description": "SFTP connector password",
        "auth": {
            "specName": "Basic Authentication for sftp",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
            "version": "1.0"
        }
    }'
Eigenschaft Beschreibung
auth.params.host Der Hostname Ihres SFTP-Servers.
auth.params.username Der Benutzername, der Ihrem SFTP-Server zugeordnet ist.
auth.params.password Das Ihrem SFTP-Server zugeordnete Kennwort.
connectionSpec.id Die Spezifikations-ID der SFTP-Server-Verbindung: b7bf2577-4520-42c9-bae9-cad01560f7bc

Antwort

Eine erfolgreiche Antwort gibt die eindeutige Kennung (id) der neu erstellten Verbindung zurück. Diese ID ist erforderlich, um Ihren SFTP-Server im nächsten Tutorial zu untersuchen.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Erstellen einer Verbindung SFTP mithilfe der Authentifizierung mit einem öffentlichen SSH-Schlüssel

Um eine SFTP-Basisverbindung mit der Authentifizierung mit öffentlichen SSH-Schlüsseln zu erstellen, stellen Sie eine POST-Anfrage an die Flow Service-API und geben Sie dabei Werte für host, userName, privateKeyContent und passPhrase an.

WICHTIG

Der Connector SFTP unterstützt einen OpenSSH-Schlüssel vom Typ RSA oder DSA. Stellen Sie sicher, dass der Inhalt Ihrer Schlüsseldatei mit "-----BEGIN [RSA/DSA] PRIVATE KEY-----" beginnt und mit "-----END [RSA/DSA] PRIVATE KEY-----" endet. Wenn es sich bei der privaten Schlüsseldatei um eine PPK-Datei handelt, verwenden Sie das PuTTY-Tool, um von PPK in das OpenSSH-Format zu konvertieren.

API-Format

POST /connections

Anfrage

Die folgende Anfrage erstellt eine Basisverbindung für SFTP mithilfe der Authentifizierung mit dem öffentlichen SSH-Schlüssel:

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": "SFTP connector with SSH authentication",
        "description": "SFTP connector with SSH authentication",
        "auth": {
            "specName": "SSH PublicKey Authentication for sftp",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "privateKeyContent": "{PRIVATE_KEY_CONTENT}",
                "passPhrase": "{PASSPHRASE}"
            }
        },
        "connectionSpec": {
            "id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
            "version": "1.0"
        }
    }'
Eigenschaft Beschreibung
auth.params.host Der Hostname Ihres SFTP-Servers.
auth.params.username Der Benutzername, der Ihrem SFTP-Server zugeordnet ist.
auth.params.privateKeyContent Der Base64-kodierte Inhalt mit privatem SSH-Schlüssel. Der Typ des OpenSSH-Schlüssels muss entweder als RSA oder als DSA klassifiziert werden.
auth.params.passPhrase Der Ausdruck oder das Kennwort zum Entschlüsseln des privaten Schlüssels, wenn die Schlüsseldatei oder der Schlüsselinhalt durch einen Pass-Satz geschützt ist. Wenn PrivateKeyContent kennwortgeschützt ist, muss dieser Parameter mit der Passphrase von PrivateKeyContent als Wert verwendet werden.
connectionSpec.id Die Kennung der Serververbindungsspezifikation SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc

Antwort

Eine erfolgreiche Antwort gibt die eindeutige Kennung (id) der neu erstellten Verbindung zurück. Diese ID ist erforderlich, um Ihren SFTP-Server im nächsten Tutorial zu untersuchen.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Nächste Schritte

In diesem Tutorial haben Sie eine SFTP-Verbindung mit der Flow Service-API erstellt und den eindeutigen ID-Wert der Verbindung erhalten. Sie können diese Verbindungs-ID verwenden, um Cloud-Speicher mithilfe der Flow Service-API oder Ermitteln von Parquet-Daten mithilfe der Flow Service-API zu untersuchen.

Auf dieser Seite