Flow Service APIを使用したSFTP ベース接続の作成

最終更新日： 2025年10月14日

トピック：
Sources

作成対象：

Developer

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このチュートリアルでは、Flow Service APIを使用してSFTP （セキュアファイル転送プロトコル）のベース接続を作成する手順について説明します。

はじめに

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

ソース : Experience Platformを使用すると、様々なソースからデータを取り込むことができますが、Experience Platform サービスを使用して着信データを構造化、ラベル付け、強化することができます。
サンドボックス : Experience Platformは、1つのExperience Platform インスタンスを個別のバーチャル環境に分割して、デジタルエクスペリエンスアプリケーションの開発と進化に役立つバーチャルサンドボックスを提供します。

IMPORTANT

SFTP ソース接続でJSON オブジェクトを取り込む場合は、改行または改行を避けることをお勧めします。この制限を回避するには、1行につき1つのJSON オブジェクトを使用し、続くファイルには複数行を使用します。

次の節では、Flow Service APIを使用してSFTP サーバーに正常に接続するために知っておく必要がある追加情報を示します。

必要な資格情報の収集

認証情報を取得する方法の詳細な手順については、SFTP 認証ガイドを参照してください。

Experience Platform APIの使用

Experience Platform APIの呼び出しを正常に行う方法について詳しくは、Experience Platform APIの概要に関するガイドを参照してください。

ベース接続の作成

TIP

作成したら、SFTP ベース接続の認証タイプを変更することはできません。認証タイプを変更するには、新しいベース接続を作成する必要があります。

ベース接続は、ソースの認証情報、接続の現在の状態、一意のベース接続IDなど、ソースとExperience Platform間の情報を保持します。ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

SFTP ソースは、基本認証とSSH公開鍵による認証の両方をサポートしています。この手順では、アクセスを提供するサブフォルダーへのパスを指定することもできます。

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、SFTP 認証資格情報をリクエストパラメーターの一部として使用します。

IMPORTANT

SFTP コネクタは、ed25519、RSAまたはDSA タイプのOpenSSH キーをサポートしています。キーファイルの内容が"-----BEGIN [RSA/DSA] PRIVATE KEY-----"で始まり、"-----END [RSA/DSA] PRIVATE KEY-----"で終わることを確認してください。秘密鍵ファイルがPPK形式のファイルの場合は、PuTTY ツールを使用してPPKからOpenSSH形式に変換します。

API 形式

POST /connections

基本認証

accordion

リクエスト

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
プロパティ	説明
`auth.params.host`	SFTP サーバーのホスト名。
`auth.params.port`	SFTP サーバーのポート。この整数値はデフォルトで22です。
`auth.params.username`	SFTP サーバーに関連付けられているユーザー名。
`auth.params.password`	SFTP サーバーに関連付けられているパスワード。
`auth.params.maxConcurrentConnections`	Experience PlatformをSFTPに接続する際に指定される同時接続の最大数。有効にした場合、この値は少なくとも1に設定する必要があります。
`auth.params.folderPath`	アクセス権を付与するフォルダーへのパス。
`auth.params.disableChunking`	SFTP サーバーがチャンク処理をサポートしているかどうかを判断するために使用されるブール値。
`connectionSpec.id`	SFTP サーバー接続仕様ID: `b7bf2577-4520-42c9-bae9-cad01560f7bc`

accordion

応答

応答が成功すると、新しく作成された接続の一意の識別子（id）が返されます。このIDは、次のチュートリアルでSFTP サーバーを探索するために必要です。

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

SSH公開鍵認証

accordion

リクエスト

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
プロパティ	説明
`auth.params.host`	SFTP サーバーのホスト名。
`auth.params.port`	SFTP サーバーのポート。この整数値はデフォルトで22です。
`auth.params.username`	SFTP サーバーに関連付けられているユーザー名。
`auth.params.privateKeyContent`	Base64でエンコードされたSSH秘密鍵コンテンツ。サポートされているOpenSSH キーの種類は`ed25519`、`RSA`、`DSA`です。
`auth.params.passPhrase`	キーファイルまたはキーコンテンツがパスフレーズで保護されている場合に、秘密鍵を復号化するためのパスフレーズまたはパスワード。 PrivateKeyContentがパスワードで保護されている場合、このパラメーターはPrivateKeyContentのパスフレーズを値として使用する必要があります。
`auth.params.maxConcurrentConnections`	Experience PlatformをSFTPに接続する際に指定される同時接続の最大数。有効にした場合、この値は少なくとも1に設定する必要があります。
`auth.params.folderPath`	アクセス権を付与するフォルダーへのパス。
`auth.params.disableChunking`	SFTP サーバーがチャンク処理をサポートしているかどうかを判断するために使用されるブール値。
`connectionSpec.id`	SFTP サーバー接続仕様ID: `b7bf2577-4520-42c9-bae9-cad01560f7bc`

accordion

応答

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

次の手順

このチュートリアルでは、Flow Service APIを使用してSFTP接続を作成し、接続の一意のID値を取得しました。この接続IDを使用して、Flow Service API🔗を使用してクラウドストレージを探索できます。

recommendation-more-help

experience-platform-help-sources