Erstellen einer SFTP-Basisverbindung mithilfe der Flow Service-API
Last update: Fri Apr 04 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
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 Aufnahme von Daten aus verschiedenen Quellen und bietet Ihnen die Möglichkeit, die eingehenden Daten mithilfe von Experience Platform-Services zu strukturieren, zu kennzeichnen und anzureichern.
- Sandboxes: Experience Platform bietet virtuelle Sandboxes, die eine einzelne Experience Platform-Instanz in separate virtuelle Umgebungen unterteilen, damit Sie Programme für digitale Erlebnisse besser entwickeln und weiterentwickeln können.
Es wird empfohlen, bei der Aufnahme von JSON-Objekten mit einer SFTP Quellverbindung Zeilenumbrüche oder Zeilenumbrüche zu vermeiden. Um die Einschränkung zu umgehen, verwenden Sie ein einzelnes JSON-Objekt pro Zeile und verwenden Sie mehrere Zeilen für nachfolgende Dateien.
Die folgenden Abschnitte enthalten zusätzliche Informationen, die Sie benötigen, um mithilfe der Flow Service-API eine Verbindung zu einem SFTP-Server herstellen zu können.
Sammeln erforderlicher Anmeldedaten
Lesen Sie SFTP Authentifizierungshandbuch, um ausführliche Schritte zum Abrufen Ihrer Authentifizierungsdaten zu erhalten.
Informationen zum erfolgreichen Aufrufen von Experience Platform-APIs finden Sie im Handbuch unter mit Experience Platform-APIs.
Erstellen einer Basisverbindung
Nach der Erstellung können Sie den Authentifizierungstyp einer SFTP Basisverbindung nicht mehr ändern. Um den Authentifizierungstyp zu ändern, müssen Sie eine neue Basisverbindung erstellen.
Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Experience Platform gespeichert, einschließlich der Authentifizierungsdaten Ihrer Quelle, des aktuellen Verbindungsstatus und Ihrer eindeutigen ID 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.
Die SFTP-Quelle unterstützt sowohl die einfache Authentifizierung als auch die Authentifizierung über einen öffentlichen SSH-Schlüssel. In diesem Schritt können Sie auch den Pfad zu dem Unterordner festlegen, auf den Sie Zugriff gewähren möchten.
Um eine Basisverbindungs-ID zu erstellen, stellen Sie eine POST-Anfrage an den /connections-Endpunkt beim Bereitstellen der SFTP-Authentifizierungs-Anmeldedaten als Teil der Anfrageparameter.
Der SFTP-Connector unterstützt einen OpenSSH-Schlüssel vom Typ RSA oder DSA. Stellen Sie sicher, dass Ihr Schlüsseldateiinhalt 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 Datei im PPK-Format handelt, verwenden Sie das PuTTY-Tool, um von PPK in das OpenSSH-Format zu konvertieren.
API-Format
Einfache Authentifizierung
| accordion |
| Anfrage |
| 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": "SFTP connector with password",
"description": "SFTP connector password",
"auth": {
"specName": "Basic Authentication for sftp",
"params": {
"host": "{HOST}",
"port": 22,
"userName": "{USERNAME}",
"password": "{PASSWORD}",
"maxConcurrentConnections": 5,
"folderPath": "acme/business/customers/holidaySales",
"disableChunking": "true"
}
},
"connectionSpec": {
"id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
"version": "1.0"
}
}'
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 |
|
| Eigenschaft |
Beschreibung |
auth.params.host |
Der Host-Name Ihres SFTP-Servers. |
auth.params.port |
Der Port des SFTP-Servers Der Standardwert für diese Ganzzahl ist 22. |
auth.params.username |
Der Benutzername, der Ihrem SFTP-Server zugeordnet ist. |
auth.params.password |
Das mit Ihrem SFTP-Server verknüpfte Kennwort. |
auth.params.maxConcurrentConnections |
Die maximale Anzahl gleichzeitiger Verbindungen, die beim Verbinden von Experience Platform mit SFTP angegeben wird. Wenn dieser Wert aktiviert ist, muss er auf mindestens 1 gesetzt werden. |
auth.params.folderPath |
Der Pfad zum Ordner, auf den Sie Zugriff gewähren möchten. |
auth.params.disableChunking |
Ein boolescher Wert, der bestimmt, ob der SFTP-Server die Unterteilung unterstützt oder nicht. |
connectionSpec.id |
Die SFTP-Server-Verbindungsspezifikations-ID: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| Antwort |
|
Bei einer erfolgreichen Antwort wird die eindeutige Kennung (id) der neu erstellten Verbindung zurückgegeben. Diese ID ist erforderlich, um Ihren SFTP-Server im nächsten Tutorial zu untersuchen.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|
SSH-Authentifizierung mit öffentlichem Schlüssel
| accordion |
| Anfrage |
| 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": "SFTP connector with SSH authentication",
"description": "SFTP connector with SSH authentication",
"auth": {
"specName": "SSH PublicKey Authentication for sftp",
"params": {
"host": "{HOST}",
"port": 22,
"userName": "{USERNAME}",
"privateKeyContent": "{PRIVATE_KEY_CONTENT}",
"passPhrase": "{PASSPHRASE}",
"maxConcurrentConnections": 5,
"folderPath": "acme/business/customers/holidaySales",
"disableChunking": "true"
}
},
"connectionSpec": {
"id": "b7bf2577-4520-42c9-bae9-cad01560f7bc",
"version": "1.0"
}
}'
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 |
|
| Eigenschaft |
Beschreibung |
auth.params.host |
Der Hostname Ihres SFTP. |
auth.params.port |
Der Port des SFTP-Servers Der Standardwert für diese Ganzzahl ist 22. |
auth.params.username |
Der Benutzername, der Ihrem SFTP-Server zugeordnet ist. |
auth.params.privateKeyContent |
Der mit Base64 kodierte Inhalt des privaten SSH-Schlüssels. Der Typ des OpenSSH-Schlüssels muss entweder als RSA oder als DSA klassifiziert werden. |
auth.params.passPhrase |
Die Passphrase oder das Passwort zum Entschlüsseln des privaten Schlüssels, wenn die Schlüsseldatei oder der Schlüsselinhalt durch eine Passphrase geschützt ist. Wenn PrivateKeyContent kennwortgeschützt ist, muss dieser Parameter mit der Passphrase von PrivateKeyContent als Wert verwendet werden. |
auth.params.maxConcurrentConnections |
Die maximale Anzahl gleichzeitiger Verbindungen, die beim Verbinden von Experience Platform mit SFTP angegeben wird. Wenn dieser Wert aktiviert ist, muss er auf mindestens 1 gesetzt werden. |
auth.params.folderPath |
Der Pfad zum Ordner, auf den Sie Zugriff gewähren möchten. |
auth.params.disableChunking |
Ein boolescher Wert, der bestimmt, ob der SFTP-Server die Unterteilung unterstützt oder nicht. |
connectionSpec.id |
Die Spezifikations-ID der SFTP-Server-Verbindung: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| Antwort |
|
Bei einer erfolgreichen Antwort wird die eindeutige Kennung (id) der neu erstellten Verbindung zurückgegeben. Diese ID ist erforderlich, um Ihren SFTP-Server im nächsten Tutorial zu untersuchen.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|