Show Menu
トピック×

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

IBM DB2 Connectorはベータ版です。 機能とドキュメントは、変更されることがあります。
フローサービスは、Adobe Experience Platform内の様々な異なるソースから顧客データを収集し、一元管理するために使用します。 このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。
このチュートリアルでは、Flow Service APIを使用して、IBM DB2(以下「DB2」と呼ばれる)をExperience Platformに接続する手順を順を追って説明します。

はじめに

このガイドでは、Adobe Experience Platformの次のコンポーネントについて、十分に理解している必要があります。
  • ソース : Experience Platformを使用すると、様々なソースからデータを取り込むと同時に、プラットフォームサービスを使用して、入力データの構造、ラベル付け、拡張を行うことができます。
  • サンドボックス : Experience Platformは、1つのプラットフォームインスタンスを別々の仮想環境に分割し、デジタルエクスペリエンスアプリケーションの開発と発展に役立つ仮想サンドボックスを提供します。
Flow Service APIを使用してDB2に正常に接続するために必要な追加情報については、以下の節で説明します。
Credential
説明
server
DB2サーバーの名前。 サーバー名の後に、コロンで区切ったポート番号を指定できます。 次に例を示します。 server:port.
database
DB2データベースの名前。
username
DB2データベースへの接続に使用するユーザー名。
password
ユーザー名に指定したユーザーアカウントのパスワード。
connectionSpec.id
接続を作成するために必要な一意の識別子。 DB2の接続仕様IDはで 09182899-b429-40c9-a15a-bf3ddbc8ced7 す。
使い始める前に詳しくは、 このDB2ドキュメントを参照してください

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

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

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

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

接続の作成

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

リクエスト
DB2接続を作成するには、一意の接続指定IDをPOST要求の一部として指定する必要があります。 DB2の接続仕様IDはで 09182899-b429-40c9-a15a-bf3ddbc8ced7 す。
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": "DB2 connection",
        "description": "DB2 test connection",
        "auth": {
            "specName": "Basic Authentication",
            "params": {
                    "server": "{SERVER}",
                    "database": "{DATABASE}",
                    "authenticationType": "{AUTHENTICATION_TYPE}",
                    "username": "{USERNAME}",
                    "password": "{PASSWORD}"
                }
        },
        "connectionSpec": {
            "id": "09182899-b429-40c9-a15a-bf3ddbc8ced7",
            "version": "1.0"
        }
    }'

パラメーター
説明
auth.params.connectionString
DB2アカウントに関連付けられている接続文字列。
connectionSpec.id
DB2接続仕様ID: 09182899-b429-40c9-a15a-bf3ddbc8ced7 .
応答
正常な応答は、新たに作成された接続の詳細(一意の識別子( id )を含む)を返します。 このIDは、次のチュートリアルでデータを調べるために必要です。
{
    "id": "575abae5-c99a-452c-9aba-e5c99ac52c4d",
    "etag": "\"e5012c89-0000-0200-0000-5eaa036b0000\""
}

次の手順

このチュートリアルに従って、Flow Service APIを使用してIBM DB2接続を作成し、接続の一意のID値を取得しました。 このIDは、Flow Service APIを使用してデータベースを 調査する方法を学習する際に、次のチュートリアルで使用できます