Show Menu
トピック×

Flow Service APIを使用したPostgreSQLコネクタの作成

PostgreSQLコネクタはベータ版です。 ベータラベル付きのコネクタの使用について詳しくは、 ソースの概要 「」を参照してください。
フローサービスは、Adobe Experience Platform内のさまざまな異なるソースから顧客データを収集および一元化するために使用します。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。
このチュートリアルでは、Flow Service APIを使用して、Experience PlatformをPostgreSQLに接続する手順(以下「PSQL」と呼びます)を順を追って説明します。

はじめに

このガイドでは、次のAdobe Experience Platformのコンポーネントについて、十分に理解している必要があります。
  • ソース : Experience Platformを使用すると、Platformサービスを使用して、様々なソースからデータを取り込み、データの構造、ラベル付け、および入力データの拡張を行うことができます。
  • サンドボックス : Experience Platformは、1つのPlatformインスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。
次の節では、Flow Service APIを使用してPSQLに正常に接続するために知っておく必要がある追加情報について説明します。

必要な資格情報の収集

フローサービスがPSQLと接続するには、次の接続プロパティを指定する必要があります。
Credential
説明
connectionString
PSQLアカウントに関連付けられている接続文字列です。 PSQL接続文字列パターンは次のとおりです。 Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD} .
connectionSpec.id
接続の生成に使用するID。 PSQLの固定接続仕様IDはで 74a1c565-4e59-48d7-9d67-7c03b8a13137 す。
接続文字列の取得の詳細については、 このPSQLドキュメントを参照してください

サンプルAPI呼び出しの読み取り

このチュートリアルでは、リクエストをフォーマットする方法を示すAPI呼び出しの例を提供します。 例えば、パス、必須のヘッダー、適切にフォーマットされた要求ペイロードなどです。 API応答で返されるサンプルJSONも提供されます。 サンプルAPI呼び出しのドキュメントで使用される規則について詳しくは、Experience PlatformトラブルシューティングガイドのAPI呼び出し例 の読み方に関する節 を参照してください。

必要なヘッダーの値の収集

PlatformAPIを呼び出すには、まず 認証チュートリアルを完了する必要があります 。 次に示すように、Experience PlatformAPIのすべての呼び出しに必要な各ヘッダーの値を認証チュートリアルで説明します。
  • 認証: 無記名 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
フローサービスに属するリソースを含む、Experience Platform内のすべてのリソースは、特定の仮想サンドボックスに分離されます。 PlatformAPIへのすべてのリクエストには、操作が実行されるサンドボックスの名前を指定するヘッダーが必要です。
  • x-sandbox-name: {SANDBOX_NAME}
ペイロード(POST、PUT、PATCH)を含むすべての要求には、追加のメディアタイプヘッダーが必要です。
  • Content-Type: application/json

接続の作成

接続は、ソースを指定し、そのソースの資格情報を含みます。 異なるデータを取り込むために複数のソースコネクタを作成する場合に使用できるため、PSQLアカウントごとに必要な接続は1つだけです。
API形式
POST /connections

リクエスト
PSQL接続を作成するには、一意の接続仕様IDをPOST要求の一部として指定する必要があります。 PSQLの接続仕様IDはで 74a1c565-4e59-48d7-9d67-7c03b8a13137 す。
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": "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
PSQLアカウントに関連付けられている接続文字列です。 PSQL接続文字列パターンは次のとおりです。 Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD} .
connectionSpec.id
PSQLの接続仕様ID: 74a1c565-4e59-48d7-9d67-7c03b8a13137 .
応答
正常な応答は、新たに作成されたベース接続の固有な識別子( id )を返します。 このIDは、次のチュートリアルでPSQLデータベースを調べるために必要です。
{
    "id": "056dd1b4-da33-42f9-add1-b4da3392f94e",
    "etag": "\"1700e582-0000-0200-0000-5e3c85180000\""
}

次の手順

このチュートリアルに従うと、Flow Service APIを使用してPSQL接続を作成し、接続の一意のID値を取得したことになります。 この接続IDは、Flow Service APIを使用してデータベースやNoSQLシステムを 探索する方法を学ぶ際に、次のチュートリアルで使用できます