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

NOTE
FTP コネクタはベータ版です。 機能とドキュメントは変更される可能性があります。 ベータ版のラベル付きコネクタの使用について詳しくは、​ ソースの概要を参照してください。

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

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

はじめに

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

  • ソース:Experience Platform を使用すると、データを様々なソースから取得しながら、Experience Platform サービスを使用して受信データの構造化、ラベル付け、拡張を行うことができます。
  • サンドボックス:Experience Platform には、単一の Experience Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスが用意されています。

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

必要な資格情報の収集

Flow Service を FTP に接続するには、次の接続プロパティの値を指定する必要があります。

資格情報
説明
host
FTP サーバーに関連付けられている名前またはIP アドレス。
username
FTP サーバーへのアクセス権を持つユーザー名。
password
FTP サーバーのパスワード。
connectionSpec.id
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。 FTP の接続仕様 ID は fb2e94c9-c031-467d-8103-6bd6e0a432f2 です。

Experience Platform APIの使用

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

ベース接続の作成

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

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

API 形式

POST /connections

リクエスト

次のリクエストは、FTP のベース接続を作成します。

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": "FTP connector with password",
        "description": "FTP connector password",
        "auth": {
            "specName": "Basic Authentication for FTP",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "fb2e94c9-c031-467d-8103-6bd6e0a432f2",
            "version": "1.0"
        }
    }'
プロパティ
説明
auth.params.host
FTP サーバーのホスト名。
auth.params.username
FTP サーバーに関連付けられているユーザー名。
auth.params.password
FTP サーバーに関連付けられているパスワード。
connectionSpec.id
FTP サーバー接続仕様ID: fb2e94c9-c031-467d-8103-6bd6e0a432f2

応答

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

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

次の手順

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

recommendation-more-help
experience-platform-help-sources