Flow Service API を使用して Phoenix ベース接続を作成する

メモ

Phoenix コネクタはベータ版です。 ベータラベルのコネクタの使用について詳しくは、「 ソースの概要 」を参照してください。

Flow Service は、Adobe Experience Platform内の様々な異なるソースから顧客データを収集し、一元化するために使用されます。このサービスは、ユーザーインターフェイスと RESTful API を提供し、サポートされているすべてのソースから接続できます。

このチュートリアルでは、Flow Service API を使用して、Phoenix データベースを Experience Platform に接続する手順を説明します。

はじめに

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

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

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

必要な資格情報の収集

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

資格情報 説明
host Phoenix サーバの IP アドレスまたはホスト名。
username Phoenix サーバーにアクセスする際に使用するユーザー名。
password ユーザーに対応するパスワード。
port Phoenix サーバーがクライアント接続をリッスンするために使用する TCP ポート。 Azure HDInsights に接続する場合は、ポートを 443 に指定します。
httpPath Phoenix サーバーに対応する URL の一部。 Azure HDInsights クラスターを使用する場合は、/hbasephoenix0 を指定します。
enableSsl ブール値。 サーバーへの接続が SSL を使用して暗号化されるかどうかを指定します。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。 Phoenix の接続仕様 ID は次のとおりです。102706fb-a5cd-42ee-afe0-bc42f017ff43

始め方の詳細は、 この Phoenix の文書 を参照してください。

Platform API の使用

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

ベース接続を作成する

ベース接続は、ソースと Platform の間の情報を保持します。これには、ソースの認証資格情報、接続の現在の状態、一意のベース接続 ID などが含まれます。 ベース接続 ID を使用すると、ソース内からファイルを参照および移動し、取り込む特定の項目(データのタイプや形式に関する情報を含む)を特定できます。

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

API 形式

POST /connections

リクエスト

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

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": "Phoenix test connection",
        "description": "Phoenix test connection",
        "auth": {
            "specName": "Basic Authentication",
        "params": {
            "host" :  "{HOST}",
            "username" : "{USERNAME}",
            "password" :"{PASSWORD}",
            "port" : {PORT},
            "httpPath" : "{PATH}",
            "enableSsl" : {SSL}
            }
        },
        "connectionSpec": {
            "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.host Phoenix サーバのホスト。
auth.params.username Phoenix 接続に関連付けられたユーザー名。
auth.params.password Phoenix 接続に関連付けられたパスワード。
auth.params.port Phoenix 接続の TCP ポート。
auth.params.httpPath Phoenix 接続の HTTP パスの一部。
auth.params.enableSsl サーバーへの接続が SSL を使用して暗号化されるかどうかを指定する boolean 値です。
connectionSpec.id Phoenix 接続仕様 ID:102706fb-a5cd-42ee-afe0-bc42f017ff43.

応答

正常な応答は、新しく作成された接続の詳細 ( 一意の識別子 (id) を含む ) を返します。 この ID は、次のチュートリアルでデータを調べるために必要です。

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Phoenix 接続を作成し、接続の一意の ID 値を取得しました。 この ID は、次のチュートリアルでフローサービス API🔗 を使用してデータベースを調べる方法を学ぶ際に使用できます。

このページ