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

メモ

MySQL Connectorはベータ版です。 ベータラベル付きコネクタの使用方法の詳細については、ソースの概要を参照してください。

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

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

はじめに

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

  • ソース: Experience Platform 様々なソースからデータを取り込むことができ、 Platform サービスを使用してデータの構造化、ラベル付け、および入力データの拡張を行うことができます。
  • サンドボックス: Experience Platform は、1つの Platform インスタンスを個別の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。

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

必要な資格情報の収集

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

Credential 説明
connectionString アカウントに関連付けられているMySQL接続文字列。 MySQLの接続文字列パターンは次のとおりです。Server={SERVER};Port={PORT};Database={DATABASE};UID={USERNAME};PWD={PASSWORD}.
connectionSpec.id 接続の生成に使用するID。 MySQLの固定接続仕様IDは26d738e0-8963-47ea-aadf-c60de735468aです。

接続文字列の取得について詳しくは、このMySQLドキュメントを参照してください。

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

接続の作成

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

API 形式

POST /connections

リクエスト

MySQL接続を作成するには、POST要求の一部として一意の接続仕様IDを指定する必要があります。 MySQLの接続仕様IDは26d738e0-8963-47ea-aadf-c60de735468aです。

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": "MySQL Test Connection",
        "description": "MySQL Test Connection",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Server={SERVER};Port={PORT};Database={DATABASE};UID={USERNAME};PWD={PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "26d738e0-8963-47ea-aadf-c60de735468a",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.connectionString アカウントに関連付けられているMySQL接続文字列。 MySQLの接続文字列パターンは次のとおりです。Server={SERVER};Port={PORT};Database={DATABASE};UID={USERNAME};PWD={PASSWORD}.
connectionSpec.id MySQLの固定接続仕様ID:26d738e0-8963-47ea-aadf-c60de735468a.

応答

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

{
    "id": "1a444165-3439-4c16-8441-653439dc166a",
    "etag": "\"5b04c219-0000-0200-0000-5e179c8f0000\""
}

次の手順

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

このページ