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

メモ

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

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

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

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する作業を理解している必要があります。

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

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

必要な資格情報の収集

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

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

Platform APIの使用

Platform APIを正常に呼び出す方法について詳しくは、Platform APIの使用の手引きを参照してください。

ベース接続を作成する

ベース接続は、ソースとプラットフォームの間の情報(ソースの認証資格情報、接続の現在の状態、一意のベース接続IDなど)を保持します。 ベース接続IDを使用すると、ソース内からファイルを参照およびナビゲートし、取得する特定の項目(データのタイプや形式に関する情報を含む)を特定できます。

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

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: {IMS_ORG}' \
    -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を使用してフローサービスAPIまたはフローサービスAPIを使用してParquetデータを取り込み、クラウドストレージを調べることができます。

このページ