Flow Service API を使用して Couchbase ベース接続を作成する

メモ

Couchbase コネクタはベータ版です。 ベータラベルのコネクタの使用について詳しくは、「 ソースの概要 」を参照してください。

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

このチュートリアルでは、Flow Service API を使用して Couchbase の基本接続を作成する手順を説明します。

はじめに

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

  • ソース: Experience Platform を使用すると、様々なソースからデータを取り込みながら、サービスを使用して、受信データの構造化、ラベル付け、強化をおこなうことがで Platform きます。
  • サンドボックス：Experience Platform は、単一の Platform インスタンスを別々の仮想環境に分割して、デジタルエクスペリエンスアプリケーションの開発と発展を支援する仮想サンドボックスを提供します。

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

必要な資格情報の収集

資格情報 説明
connectionString Couchbase インスタンスへの接続に使用する接続文字列。 Couchbase の接続文字列パターンは Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; です。 接続文字列の取得について詳しくは、 この Couchbase ドキュメント を参照してください。
connectionSpec.id 接続仕様は、ベース接続とソース接続の作成に関連する認証仕様を含む、ソースのコネクタプロパティを返します。 Couchbase の接続仕様 ID は 1fe283f6-9bec-11ea-bb37-0242ac130002 です。

Platform API の使用

Platform API を正常に呼び出す方法について詳しくは、Platform API の使用の手引き を参照してください。

ベース接続を作成する

ベース接続は、ソースと Platform の間の情報を保持します。これには、ソースの認証資格情報、接続の現在の状態、一意のベース接続 ID などが含まれます。 ベース接続 ID を使用すると、ソース内からファイルを参照および移動し、取り込む特定の項目（データのタイプや形式に関する情報を含む）を特定できます。

ベースPOSTID を作成するには、要求パラメーターの一部として Couchbase 認証資格情報を指定しながら、/connections エンドポイントに接続要求を行います。

API 形式

POST /connections

リクエスト

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

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": "Couchbase test connection",
        "description": "A test connection for a Couchbase source",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                    "connectionString": "Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];"
                }
        },
        "connectionSpec": {
            "id": "1fe283f6-9bec-11ea-bb37-0242ac130002",
            "version": "1.0"
        }
    }'
プロパティ 説明
auth.params.connectionString Couchbase アカウントへの接続に使用する接続文字列。 接続文字列パターンは次のとおりです。Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];.
connectionSpec.id Couchbase 接続仕様 ID:1fe283f6-9bec-11ea-bb37-0242ac130002.

応答

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

{
    "id": "54997109-07b5-40b7-9971-0907b5a0b75a",
    "etag": "\"280168f5-0000-0200-0000-5ed72b230000\""
}

次の手順

このチュートリアルでは、Flow Service API を使用して Couchbase 接続を作成し、接続の一意の ID 値を取得しました。 この ID は、次のチュートリアルでフローサービス API🔗 を使用してデータベースを調べる方法を学ぶ際に使用できます。

このページ