Een SFTP-basisverbinding maken met de Flow Service API
Last update: Mon Oct 30 2023 00:00:00 GMT+0000 (Coordinated Universal Time)
Een basisverbinding vertegenwoordigt de geverifieerde verbinding tussen een bron en Adobe Experience Platform.
Dit leerprogramma begeleidt u door de stappen om een basisverbinding tot stand te brengen voor SFTP (Secure File Transfer Protocol) met de Flow Service API.
Aan de slag
Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:
- Bronnen: Met Experience Platform kunnen gegevens uit verschillende bronnen worden ingepakt en kunt u inkomende gegevens structureren, labelen en verbeteren met behulp van de platformservices.
- Sandboxen: Experience Platform biedt virtuele sandboxen die één platforminstantie in afzonderlijke virtuele omgevingen verdelen om toepassingen voor digitale ervaringen te ontwikkelen en te ontwikkelen.
Het wordt aanbevolen nieuwe regels of regeleinden te vermijden bij het innemen van JSON-objecten met een SFTP bronverbinding. Als u de beperking wilt omzeilen, gebruikt u één JSON-object per regel en gebruikt u meerdere regels voor het uitvoeren van bestanden.
De volgende secties bevatten aanvullende informatie die u nodig hebt om verbinding te kunnen maken met een SFTP server die de Flow Service API.
Voor informatie over hoe te om vraag aan Platform APIs met succes te maken, zie de gids op aan de slag met platform-API's.
Een basisverbinding maken
Nadat u een verificatietype hebt gemaakt, kunt u dit type van een SFTP basisverbinding. Als u het verificatietype wilt wijzigen, moet u een nieuwe basisverbinding maken.
Een basisverbinding behoudt informatie tussen uw bron en Platform, met inbegrip van de de authentificatiegeloofsbrieven van uw bron, de huidige staat van de verbinding, en uw unieke identiteitskaart van de basisverbinding. Met de ID van de basisverbinding kunt u bestanden verkennen en door bestanden navigeren vanuit uw bron en kunt u de specifieke items identificeren die u wilt opnemen, inclusief informatie over hun gegevenstypen en indelingen.
De SFTP de bron steunt zowel basisauthentificatie als authentificatie via SSH openbare sleutel. Tijdens deze stap kunt u ook het pad naar de submap aangeven waartoe u toegang wilt verlenen.
Om een identiteitskaart van de basisverbinding te creëren, doe een verzoek van de POST aan /connections als u uw SFTP verificatiereferenties als onderdeel van de aanvraagparameters.
De SFTP de schakelaar steunt een RSA of DSA type OpenSSH sleutel. Zorg ervoor dat de inhoud van uw sleutelbestand begint met "-----BEGIN [RSA/DSA] PRIVATE KEY-----" en eindigt met "-----END [RSA/DSA] PRIVATE KEY-----". Als het bestand met de persoonlijke sleutel een PPK-bestand is, gebruikt u het gereedschap PuTTY om de PPK-indeling om te zetten in de OpenSSH-indeling.
API-indeling
Basisverificatie
| accordion |
| verzoek |
| 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"
}
},
"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 |
|
| Eigenschap |
Beschrijving |
auth.params.host |
De hostnaam van uw SFTP-server. |
auth.params.port |
De poort van de SFTP-server. Deze gehele waarde is standaard ingesteld op 22. |
auth.params.username |
De gebruikersnaam die aan uw SFTP-server is gekoppeld. |
auth.params.password |
Het wachtwoord dat aan uw SFTP-server is gekoppeld. |
auth.params.maxConcurrentConnections |
Het maximumaantal gezamenlijke verbindingen dat is opgegeven bij het verbinden van Platform met SFTP. Wanneer deze optie is ingeschakeld, moet deze waarde op ten minste 1 worden ingesteld. |
auth.params.folderPath |
Het pad naar de map waartoe u toegang wilt verlenen. |
connectionSpec.id |
De specificatie-id van de SFTP-serververbinding: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| Response |
|
Een geslaagde reactie retourneert de unieke id (id) van de nieuwe verbinding. Deze id is vereist om uw SFTP-server te verkennen in de volgende zelfstudie.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|
SSH-verificatie met openbare sleutel
| accordion |
| verzoek |
| 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"
}
},
"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 |
|
| Eigenschap |
Beschrijving |
auth.params.host |
De hostnaam van uw SFTP server. |
auth.params.port |
De poort van de SFTP-server. Deze gehele waarde is standaard ingesteld op 22. |
auth.params.username |
De gebruikersnaam die aan uw SFTP server. |
auth.params.privateKeyContent |
De Base64-gecodeerde SSH-inhoud voor persoonlijke sleutels. Het type van sleutel OpenSSH moet als of RSA of DSA worden geclassificeerd. |
auth.params.passPhrase |
De wachtwoordgroep of het wachtwoord voor het decoderen van de persoonlijke sleutel als het sleutelbestand of de sleutelinhoud wordt beveiligd door een wachtwoordgroep. Als PrivateKeyContent met een wachtwoord beveiligd is, moet deze parameter worden gebruikt met de wachtwoordzin van PrivateKeyContent als waarde. |
auth.params.maxConcurrentConnections |
Het maximumaantal gezamenlijke verbindingen dat is opgegeven bij het verbinden van Platform met SFTP. Wanneer deze optie is ingeschakeld, moet deze waarde op ten minste 1 worden ingesteld. |
auth.params.folderPath |
Het pad naar de map waartoe u toegang wilt verlenen. |
connectionSpec.id |
De SFTP server connection specification ID: b7bf2577-4520-42c9-bae9-cad01560f7bc |
|
| accordion |
| Response |
|
Een geslaagde reactie retourneert de unieke id (id) van de nieuwe verbinding. Deze id is vereist om uw SFTP-server te verkennen in de volgende zelfstudie.
| code language-json |
{
"id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
"etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
|
|