Show Menu
トピック×

Flow Service APIを使用してPhoenixコネクタを作成する

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

はじめに

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

必要な資格情報の収集

フローサービスがPhoenixと接続するには、次の接続プロパティの値を指定する必要があります。
Credential
説明
host
PhoenixサーバーのIPアドレスまたはホスト名。
username
Phoenix Serverへのアクセスに使用するユーザー名です。
password
ユーザーに対応するパスワード。
port
Phoenixサーバーがクライアント接続のリッスンに使用するTCPポートです。 Azure HDInsightsに接続する場合は、ポートを443に指定します。
httpPath
Phoenixサーバーに対応する部分的なURLです。 Azure HDInsightsクラスターを使用する場合は、/hbasephoenix0を指定します。
enableSsl
boolean値。 サーバーへの接続をSSLを使用して暗号化するかどうかを指定します。
connectionSpec.id
接続を作成するために必要な一意の識別子。 Phoenixの接続仕様IDは次のとおりです。 102706fb-a5cd-42ee-afe0-bc42f017ff43

サンプル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

接続の作成

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

リクエスト
Phoenix接続を作成するには、一意の接続仕様IDをPOST要求の一部として指定する必要があります。 Phoenixの接続仕様IDはで 102706fb-a5cd-42ee-afe0-bc42f017ff43 す。
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
フェニックス・サーバのホスト。
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は、Flow Service APIを使用してデータベースを 調査する方法を学習する際に、次のチュートリアルで使用できます