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

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

トピック：

作成対象：

開発者

NOTE

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 の概要を参照してください。

ベース接続の作成

ベース接続は、ソースと Platform 間の情報（ソースの認証資格情報、現在の接続状態、固有のベース接続 ID など）を保持します。ベース接続 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）が返されます。この 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

337b99bb-92fb-42ae-b6b7-c7042161d089