Flow Service APIを使用してMicrosoft SQL Server ベース接続を作成します

ベース接続は、ソースと Adobe Experience Platform 間の認証済み接続を表します。

このチュートリアルでは、Flow Service APIを使用してMicrosoft SQL Serverのベース接続を作成する方法について説明します。

基本を学ぶ

このガイドは、Adobe Experience Platform の次のコンポーネントを実際に利用および理解しているユーザーを対象としています。

  • ​ ソース ​: Experience Platformを使用すると、様々なソースからデータを取り込むことができますが、Experience Platform サービスを使用して着信データを構造化、ラベル付け、強化することができます。
  • ​ サンドボックス ​: Experience Platformは、1つのExperience Platform インスタンスを個別のバーチャル環境に分割して、デジタルエクスペリエンスアプリケーションの開発と進化に役立つバーチャルサンドボックスを提供します。

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

必要な資格情報の収集 gather-required-credentials

Microsoft SQL Serverに接続するには、次の接続プロパティを指定する必要があります。

資格情報
説明
connectionString

Microsoft SQL Server アカウントに関連付けられている接続文字列。 接続文字列パターンは、データソースにサーバー名またはインスタンス名を使用しているかどうかに応じて異なります。

  • サーバー名を使用した接続文字列:Data Source={SERVER_NAME};Initial Catalog={DATABASE};Integrated Security=False;User ID={USER_ID};Password={PASSWORD};
  • インスタンス名を使用した接続文字列:Data Source={INSTANCE_NAME};Initial Catalog={DATABASE};Integrated Security=False;User ID={USER_ID};Password={PASSWORD};
Data Source=mssqlserver.database.windows.net;Initial Catalog=mssqlserver_e2e_db;Integrated Security=False;User ID=mssqluser;Password=mssqlpassword
connectionSpec.id
接続仕様は、ベース接続とソース接続の作成に関連する認証仕様などの、ソースのコネクタプロパティを返します。 Microsoft SQL Serverの接続仕様IDは1f372ff9-38a4-4492-96f5-b9a4e4bd00ecです。

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

Experience Platform APIの使用

Experience Platform APIの呼び出しを正常に行う方法について詳しくは、Experience Platform APIの概要に関するガイドを参照してください。

ベース接続の作成

ベース接続は、ソースの認証情報、接続の現在の状態、一意のベース接続IDなど、ソースとExperience Platform間の情報を保持します。 ベース接続 ID により、ソース内からファイルを参照および移動し、データタイプやフォーマットに関する情報を含む、取り込みたい特定の項目を識別することができます。

ベース接続 ID を作成するには、/connections エンドポイントに POST リクエストを実行し、Microsoft SQL Server 認証資格情報をリクエストパラメーターの一部として使用します。

API 形式

POST /connections

リクエスト

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

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: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Base connection for sql-server",
      "description": "Base connection for sql-server",
      "auth": {
          "specName": "Connection String Based Authentication",
          "params": {
              "connectionString": "Data Source=mssqlserver.database.windows.net;Initial Catalog=mssqlserver_e2e_db;Integrated Security=False;User ID=mssqluser;Password=mssqlpassword"
          }
      },
      "connectionSpec": {
          "id": "1f372ff9-38a4-4492-96f5-b9a4e4bd00ec",
          "version": "1.0"
  }'
プロパティ
説明
auth.params.connectionString
Microsoft SQL Server アカウントに関連付けられている接続文字列。 詳しくは、必要な資格情報の収集に関する節を参照してください。
connectionSpec.id
Microsoft SQL Server 接続仕様 ID は 1f372ff9-38a4-4492-96f5-b9a4e4bd00ec です。

応答

リクエストが成功した場合は、一意の ID(id)を含む、新しく作成した接続の詳細が返されます。 このIDは、次のチュートリアルでデータベースを探索するために必要です。

{
    "id": "0b8224e4-0de8-4293-8224-e40de80293c6",
    "etag": "\"5802c519-0000-0200-0000-5e4d89520000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Microsoft SQL Server ベース接続を作成しました。 このベース接続 ID は、次のチュートリアルで使用できます。

recommendation-more-help
experience-platform-help-sources