Couchbaseコネクタはベータ版です。 ベータラベル付きコネクタの使用方法の詳細については、ソースの概要を参照してください。
Flow Service 様々な異なるソースから顧客データを収集して一元化し、Adobe Experience Platformに持ち込むために使用します。このサービスは、ユーザーインターフェイスとRESTful APIを提供し、サポートされるすべてのソースを接続できます。
このチュートリアルでは、Flow Service APIを使用してCouchbaseをExperience Platformに接続する手順を順を追って説明します。
このガイドでは、Adobe Experience Platform の次のコンポーネントに関する作業を理解している必要があります。
Flow Service APIを使用してCouchbaseに正しく接続するために知っておく必要のある追加情報については、以下の節で説明します。
Credential | 説明 |
---|---|
connectionString |
Couchbaseインスタンスへの接続に使用する接続文字列です。 Couchbaseの接続文字列パターンはServer={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; です。 接続文字列の取得についての詳細は、このCouchbaseドキュメントを参照してください。 |
connectionSpec.id |
接続を作成するために必要な識別子。 Couchbaseの固定接続仕様IDは1fe283f6-9bec-11ea-bb37-0242ac130002 です。 |
このチュートリアルでは、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
接続は、ソースを指定し、そのソースの資格情報を含みます。 異なるデータを取り込むために複数のソースコネクタを作成する場合に使用できるので、Couchbaseアカウントごとに1つのコネクタが必要です。
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は、Flow Service API ](…/…/explore/database-nosql.md)を使用して[データベースを調査する方法を学習する際に、次のチュートリアルで使用できます。