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

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

このチュートリアルでは、Flow Service API を使用して、PostgreSQL のベース接続を作成する手順を説明します。

はじめに

このガイドでは、Adobe Experience Platform の次のコンポーネントに関する十分な知識が必要です。

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

次の節では、Flow Service API を使用してに正常に接続するために必要な追加情報を示 PostgreSQL ています。

必要な資格情報の収集

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

資格情報
説明
connectionString
PostgreSQL アカウントに関連付けられた接続文字列。 PostgreSQL の接続文字列パターンは Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD} です。
connectionSpec.id
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。PostgreSQL の接続仕様 ID は 74a1c565-4e59-48d7-9d67-7c03b8a13137 です。

接続文字列の取得について詳しくは、この PostgreSQL ドキュメントを参照してください。

接続文字列の SSL 暗号化を有効にする

次のプロパティを使用して接続文字列を追加することで、PostgreSQL 接続文字列の SSL 暗号化を有効にできます。

プロパティ
説明
EncryptionMethod
PostgreSQL データに対して SSL 暗号化を有効にできます。
  • EncryptionMethod=0 (無効)
  • EncryptionMethod=1 (有効)
  • EncryptionMethod=6 (RequestSSL)
ValidateServerCertificate
EncryptionMethod ータの適用時に PostgreSQL データベースから送信された証明書を検証します。
  • ValidationServerCertificate=0 (無効)
  • ValidationServerCertificate=1 (有効)

次に、SSL 暗号化が追加された PostgreSQL 接続文字列の例を示します。Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD};EncryptionMethod=1;ValidateServerCertificate=1

Platform API の使用

Platform API への呼び出しを正常に実行する方法について詳しくは、Platform API の概要を参照してください。

ベース接続の作成

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

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

API 形式

POST /connections

リクエスト

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

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": "Test connection for PostgreSQL",
        "description": "Test connection for PostgreSQL",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "74a1c565-4e59-48d7-9d67-7c03b8a13137",
            "version": "1.0"
        }
    }'
プロパティ
説明
auth.params.connectionString
PostgreSQL アカウントに関連付けられた接続文字列。 PostgreSQL の接続文字列パターンは Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD} です。
connectionSpec.id
PostgreSQL 接続仕様 ID:74a1c565-4e59-48d7-9d67-7c03b8a13137

応答

リクエストが成功した場合は、新しく作成したベース接続の一意の ID (id)が返されます。 この ID は、次のチュートリアルで PostgreSQL データベースを探索するために必要です。

{
    "id": "056dd1b4-da33-42f9-add1-b4da3392f94e",
    "etag": "\"1700e582-0000-0200-0000-5e3c85180000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して PostgreSQL 接続ベース接続を作成しました。 このベース接続 ID は、次のチュートリアルで使用できます。

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