DokumentationExperience PlatformAnvändarhandbok om Source Connectors

Skapa en SFTP-basanslutning med API:t Flow Service

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare

En basanslutning representerar den autentiserade anslutningen mellan en källa och Adobe Experience Platform.

I den här självstudiekursen får du hjälp med att skapa en basanslutning för SFTP (Secure File Transfer Protocol) med Flow Service API.

Komma igång

Handboken kräver en fungerande förståelse av följande komponenter i Adobe Experience Platform:

  • Källor: Experience Platform tillåter data att hämtas från olika källor samtidigt som du kan strukturera, etikettera och förbättra inkommande data med hjälp av plattformstjänster.
  • Sandlådor: Experience Platform tillhandahåller virtuella sandlådor som partitionerar en enda plattformsinstans till separata virtuella miljöer för att utveckla och utveckla program för digitala upplevelser.
IMPORTANT
Du bör undvika radmatningar och radmatningar när du importerar JSON-objekt med en SFTP-källanslutning. Du kan undvika begränsningarna genom att använda ett enda JSON-objekt per rad och flera rader för att skapa filer.

I följande avsnitt finns ytterligare information som du behöver känna till för att kunna ansluta till en SFTP-server med API:t Flow Service.

Samla in nödvändiga inloggningsuppgifter

För att Flow Service ska kunna ansluta till SFTP måste du ange värden för följande anslutningsegenskaper:

Autentiseringsuppgifter
Beskrivning
host
Namnet eller IP-adressen som är associerad med SFTP-servern.
port
Den SFTP-serverport som du ansluter till. Om det inte anges används standardvärdet 22.
username
Användarnamnet med åtkomst till din SFTP-server.
password
Lösenordet för din SFTP-server.
privateKeyContent
Base64-kodat innehåll för privat SSH-nyckel. Typen av OpenSSH-nyckel måste klassificeras som antingen RSA eller DSA.
passPhrase
Lösenordsfrasen eller lösenordet för att dekryptera den privata nyckeln om nyckelfilen eller nyckelinnehållet skyddas av en lösenordsfras. Om privateKeyContent är lösenordsskyddad måste den här parametern användas med den privata nyckelinnehållets lösenfras som värde.
maxConcurrentConnections
Med den här parametern kan du ange en maxgräns för hur många samtidiga anslutningar som plattformen skapar vid anslutning till SFTP-servern. Du måste ange att det här värdet ska vara mindre än gränsen som anges av SFTP. Obs! När den här inställningen är aktiverad för ett befintligt SFTP-konto påverkas bara framtida dataflöden och inte befintliga dataflöden.
folderPath
Sökvägen till mappen som du vill ge åtkomst till. SFTP-källan kan du ange mappsökvägen för att ange användaråtkomst till en undermapp som du väljer.
connectionSpec.id
Anslutningsspecifikationen returnerar en källas kopplingsegenskaper, inklusive autentiseringsspecifikationer för att skapa bas- och källanslutningarna. Anslutningsspecifikations-ID för SFTP är: b7bf2577-4520-42c9-bae9-cad01560f7bc.

Använda plattforms-API:er

Mer information om hur du kan anropa plattforms-API:er finns i guiden Komma igång med plattforms-API:er.

Skapa en basanslutning

TIP
När du väl har skapat den kan du inte ändra autentiseringstypen för en SFTP-basanslutning. Om du vill ändra autentiseringstypen måste du skapa en ny basanslutning.

En basanslutning bevarar information mellan källan och plattformen, inklusive källans autentiseringsuppgifter, anslutningsstatus och ditt unika basanslutnings-ID. Med det grundläggande anslutnings-ID:t kan du utforska och navigera bland filer inifrån källan och identifiera de specifika objekt som du vill importera, inklusive information om deras datatyper och format.

Källan SFTP stöder både grundläggande autentisering och autentisering via den offentliga nyckeln för SSH. Under det här steget kan du även ange sökvägen till den undermapp som du vill ge åtkomst till.

Om du vill skapa ett grundläggande anslutnings-ID skickar du en POST till slutpunkten /connections och anger dina autentiseringsuppgifter för SFTP som en del av parametrarna för begäran.

IMPORTANT
SFTP-anslutningen stöder en OpenSSH-nyckel av RSA- eller DSA-typ. Kontrollera att nyckelfilsinnehållet börjar med "-----BEGIN [RSA/DSA] PRIVATE KEY-----" och slutar med "-----END [RSA/DSA] PRIVATE KEY-----". Om den privata nyckelfilen är en PPK-formatfil använder du PuTTY-verktyget för att konvertera från PPK till OpenSSH-format.

API-format

POST /connections
Grundläggande autentisering
accordion
Begäran
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
Egenskap Beskrivning
auth.params.host Värdnamnet för SFTP-servern.
auth.params.port Porten för SFTP-servern. Det här heltalsvärdet är som standard 22.
auth.params.username Användarnamnet som är associerat med SFTP-servern.
auth.params.password Lösenordet som är kopplat till SFTP-servern.
auth.params.maxConcurrentConnections Det maximala antalet samtidiga anslutningar som anges vid anslutning av plattformen till SFTP. När det här värdet är aktiverat måste det vara minst 1.
auth.params.folderPath Sökvägen till mappen som du vill ge åtkomst till.
connectionSpec.id SFTP-serveranslutningsspecifikation-ID: b7bf2577-4520-42c9-bae9-cad01560f7bc
accordion
svar

Ett lyckat svar returnerar den unika identifieraren (id) för den nyligen skapade anslutningen. Detta ID krävs för att utforska din SFTP-server i nästa självstudiekurs.

code language-json 
{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}
SSH-autentisering med offentlig nyckel
accordion
Begäran
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
Egenskap Beskrivning
auth.params.host Värdnamnet för SFTP-servern.
auth.params.port Porten för SFTP-servern. Det här heltalsvärdet är som standard 22.
auth.params.username Användarnamnet som är associerat med din SFTP-server.
auth.params.privateKeyContent Base64-kodat innehåll för privat SSH-nyckel. Typen av OpenSSH-nyckel måste klassificeras som antingen RSA eller DSA.
auth.params.passPhrase Lösenordsfrasen eller lösenordet för att dekryptera den privata nyckeln om nyckelfilen eller nyckelinnehållet skyddas av en lösenordsfras. Om PrivateKeyContent är lösenordsskyddat måste den här parametern användas med PrivateKeyContent-innehållets lösenfras som värde.
auth.params.maxConcurrentConnections Det maximala antalet samtidiga anslutningar som anges vid anslutning av plattformen till SFTP. När det här värdet är aktiverat måste det vara minst 1.
auth.params.folderPath Sökvägen till mappen som du vill ge åtkomst till.
connectionSpec.id ID för serveranslutningsspecifikationen SFTP: b7bf2577-4520-42c9-bae9-cad01560f7bc
accordion
svar

Ett lyckat svar returnerar den unika identifieraren (id) för den nyligen skapade anslutningen. Detta ID krävs för att utforska din SFTP-server i nästa självstudiekurs.

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

Nästa steg

Genom att följa den här självstudiekursen har du skapat en SFTP-anslutning med API:t Flow Service och fått anslutningens unika ID-värde. Du kan använda det här anslutnings-ID:t för att utforska molnlagring med API:t för Flow Service.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089