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 は、1つの Platform インスタンスを個別の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

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

必要な資格情報の収集

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

Credential 説明
host PhoenixサーバーのIPアドレスまたはホスト名。
username Phoenixサーバーへのアクセスに使用するユーザー名です。
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 呼び出し例の表記について詳しくは、 トラブルシューテングガイドのAPI 呼び出し例の読み方に関する節を参照してください。Experience Platform

必須ヘッダーの値の収集

Platform APIを呼び出すには、まず認証チュートリアルを完了する必要があります。 次に示すように、すべてのExperience Platform API呼び出しに必要な各ヘッダーの値を認証チュートリアルで説明します。

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Experience Platform内のすべてのリソース(Flow Serviceに属するリソースを含む)は、特定の仮想サンドボックスに分離されます。 Platform APIへのすべてのリクエストには、操作が行われるサンドボックスの名前を指定するヘッダーが必要です。

  • x-sandbox-name: {SANDBOX_NAME}

ペイロード(POST、PUT、PATCH)を含むすべてのリクエストには、メディアのタイプを指定する以下のような追加ヘッダーが必要です。

  • Content-Type: application/json

接続の作成

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

API 形式

POST /connections

リクエスト

Phoenix接続を作成するには、POST要求の一部として一意の接続指定IDを指定する必要があります。 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 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は、Flow Service API ](…/…/explore/database-nosql.md)を使用して[データベースを調査する方法を学習する際に、次のチュートリアルで使用できます。

このページ