Flow Service APIを使用してPostgreSQLをExperience Platformに接続します

このガイドでは、Flow Service APIを使用してPostgreSQL データベースをAdobe Experience Platformに接続する方法について説明します。

はじめに

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

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

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

Experience Platform APIの使用

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

必要な資格情報の収集

認証について詳しくは、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

PostgreSQLをAzure上のExperience Platformに接続 azure

PostgreSQL アカウントをAzure上のExperience Platformに接続する方法については、以下の手順を参照してください。

ベース接続の作成 azure-base

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

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

API 形式

POST /connections
アカウントキーベースの認証

リクエスト

次のリクエストは、アカウントキーベースの認証を使用してPostgreSQLのベース接続を作成します。

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": "PostgreSQL base connection",
      "description": "PostgreSQL base connection via connection string",
      "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"
      }
  }'
table 0-row-2 1-row-2 2-row-2
プロパティ 説明
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)が返されます。

accordion
応答の例を表示
code language-json
{
    "id": "056dd1b4-da33-42f9-add1-b4da3392f94e",
    "etag": "\"1700e582-0000-0200-0000-5e3c85180000\""
}
基本認証

リクエスト

次のリクエストは、基本認証を使用してPostgreSQLのベース接続を作成します。

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": "PostgreSQL base connection",
      "description": "PostgreSQL base connection via basic authentication",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "server": "localhost",
              "port": "3306",
              "database": "postgresql-acme",
              "username": "acme",
              "password": "xxxx",
              "sslMode": "Allow"
          }
      },
      "connectionSpec": {
          "id": "74a1c565-4e59-48d7-9d67-7c03b8a13137",
          "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
プロパティ 説明
auth.params.server PostgreSQL データベースの名前またはIP アドレス。
auth.params.port データベース・サーバのポート番号。
auth.params.database PostgreSQL データベースの名前。
auth.params.username PostgreSQL データベース認証に関連付けられているユーザー名。
auth.params.password PostgreSQL データベース認証に関連付けられているパスワード。
auth.params.sslMode データ転送時にデータを暗号化する方法。 使用可能な値は、DisableAllowPreferVerify CaおよびVerify Fullです。
connectionSpec.id PostgreSQL接続仕様ID: 74a1c565-4e59-48d7-9d67-7c03b8a13137

応答

応答が成功すると、新しく作成されたベース接続の一意の識別子(id)が返されます。

accordion
応答の例を表示
code language-json
{
    "id": "2c15b1c5-73bf-47ab-9098-0467fcd854d9",
    "etag": "\"2600fc39-0000-0200-0000-67dd48f80000\""
}

PostgreSQLをAmazon Web Services上のExperience Platformに接続 aws

AVAILABILITY
この節は、Amazon Web Services(AWS)で動作するExperience Platformの実装に適用されます。 AWS上で動作するExperience Platformは、現在、一部のお客様にご利用いただけます。 サポートされているExperience Platform インフラストラクチャについて詳しくは、Experience Platform マルチクラウドの概要を参照してください。

PostgreSQL データベースをAWS上のExperience Platformに接続する方法について詳しくは、以下の手順を参照してください。

ベース接続の作成 aws-base

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

API 形式

POST /connections

リクエスト

次のリクエストは、PostgreSQLがAWS上のExperience Platformに接続するためのベース接続を作成します。

リクエストの例を表示
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": "PostgreSQL base connection",
      "description": "PostgreSQL base connection via basic authentication",
      "auth": {
          "specName": "Basic Authentication",
          "params": {
              "server": "localhost",
              "port": "3306",
              "database": "postgresql-acme",
              "username": "acme",
              "password": "xxxx",
              "sslMode": "false"
          }
      },
      "connectionSpec": {
          "id": "74a1c565-4e59-48d7-9d67-7c03b8a13137",
          "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
プロパティ 説明
auth.params.server PostgreSQL データベースの名前またはIP アドレス。
auth.params.port データベース・サーバのポート番号。
auth.params.database PostgreSQL データベースの名前。
auth.params.username PostgreSQL データベース認証に関連付けられているユーザー名。
auth.params.password PostgreSQL データベース認証に関連付けられているパスワード。
sslMode サーバーサポートに応じて、SSLが適用されるかどうかを制御するブール値。 この設定のデフォルト値はfalseです。
connectionSpec.id PostgreSQL接続仕様ID: 74a1c565-4e59-48d7-9d67-7c03b8a13137

応答

応答が成功すると、新しく作成されたベース接続の一意の識別子(id)が返されます。

応答の例を表示
code language-json
{
    "id": "2c15b1c5-73bf-47ab-9098-0467fcd854d9",
    "etag": "\"2600fc39-0000-0200-0000-67dd48f80000\""
}

次の手順

これで、PostgreSQL データベースとExperience Platform間の接続が作成されました。次の手順に進み、PostgreSQL データをExperience Platformに取り込むことができます。 詳しくは、次のドキュメントを参照してください。

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