Erstellen einer SFTP-Basisverbindung mit der Flow Service-API
Last update: Tue Sep 24 2024 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 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.
Es wird empfohlen, beim Erfassen von JSON-Objekten mit einer Quellverbindung vom Typ SFTP 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.
Sammeln erforderlicher Anmeldedaten
Ausführliche Anweisungen zum Abrufen Ihrer Authentifizierungsberechtigungen finden Sie im SFTP Authentifizierungshandbuch .
Informationen zum Aufrufen von Platform-APIs finden Sie im Handbuch unter Erste Schritte mit Platform-APIs.
Erstellen einer Basisverbindung
Nach der Erstellung können Sie den Authentifizierungstyp einer Basis-Verbindung vom Typ SFTP nicht mehr ändern. Um den Authentifizierungstyp zu ändern, müssen Sie eine neue Basisverbindung erstellen.
Bei einer Basisverbindung werden Informationen zwischen Ihrer Quelle und Platform gespeichert, einschließlich der Authentifizierungs-Anmeldedaten 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.
Die Quelle SFTP unterstützt sowohl die einfache Authentifizierung als auch die Authentifizierung über den öffentlichen SSH-Schlüssel. Während dieses Schritts können Sie auch den Pfad zum Unterordner angeben, 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 Connector SFTP unterstützt einen RSA- oder DSA-Typ OpenSSH-Schlüssel. Stellen Sie sicher, dass der Inhalt der 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
Grundlegende 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 Hostname Ihres SFTP-Servers. |
auth.params.port |
Der Port des SFTP-Servers. Dieser ganzzahlige Wert ist standardmäßig auf 22 festgelegt. |
auth.params.username |
Der Benutzername, der Ihrem SFTP-Server zugeordnet ist. |
auth.params.password |
Das Ihrem SFTP-Server zugeordnete Kennwort. |
auth.params.maxConcurrentConnections |
Die maximale Anzahl gleichzeitiger Verbindungen, die beim Verbinden von Platform mit SFTP angegeben wird. Wenn diese Option aktiviert ist, muss dieser Wert auf mindestens 1 gesetzt werden. |
auth.params.folderPath |
Der Pfad zu dem Ordner, auf den Sie Zugriff gewähren möchten. |
auth.params.disableChunking |
Ein boolean -Wert, der bestimmt, ob Ihr SFTP-Server das Blockieren unterstützt oder nicht. |
connectionSpec.id |
Die Spezifikations-ID der SFTP-Server-Verbindung: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| 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.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|
Authentifizierung mit öffentlichen SSH-Schlüsseln
| 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 -Servers. |
auth.params.port |
Der Port des SFTP-Servers. Dieser ganzzahlige Wert ist standardmäßig auf 22 festgelegt. |
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. |
auth.params.maxConcurrentConnections |
Die maximale Anzahl gleichzeitiger Verbindungen, die beim Verbinden von Platform mit SFTP angegeben wird. Wenn diese Option aktiviert ist, muss dieser Wert auf mindestens 1 gesetzt werden. |
auth.params.folderPath |
Der Pfad zu dem Ordner, auf den Sie Zugriff gewähren möchten. |
auth.params.disableChunking |
Ein boolean -Wert, der bestimmt, ob Ihr SFTP-Server das Blockieren unterstützt oder nicht. |
connectionSpec.id |
Die SFTP Server-Verbindungsspezifikations-ID: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| 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.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|