Documentation Experience Platform Source Connectors Guide

Create a Couchbase base connection using the Flow Service API

Last update: Fri Nov 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Sources

CREATED FOR:

Developer

WARNING

The Couchbase source will be deprecated at the end of May 2025.

A base connection represents the authenticated connection between a source and Adobe Experience Platform.

This tutorial walks you through the steps to create a base connection for Couchbase using the Flow Service API.

Getting started

This guide requires a working understanding of the following components of Adobe Experience Platform:

Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Platform services.
Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.

The following sections provide additional information that you will need to know in order to successfully connect to Couchbase using the Flow Service API.

Gather required credentials

Credential

Description

connectionString

The connection string used to connect to your Couchbase instance. The connection string pattern for Couchbase is Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];. For more information on acquiring a connection string, refer to this Couchbase document.

connectionSpec.id

The connection specification returns a source’s connector properties, including authentication specifications related to creating the base and source connections. The connection specification ID for Couchbase is 1fe283f6-9bec-11ea-bb37-0242ac130002.

Using Platform APIs

For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.

Create a base connection

A base connection retains information between your source and Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.

To create a base connection ID, make a POST request to the /connections endpoint while providing your Couchbase authentication credentials as part of the request parameters.

API format

POST /connections

Request

The following request creates a base connection for 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: {ORG_ID}' \
    -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"
        }
    }'

Property

Description

auth.params.connectionString

The connection string used to connect to a Couchbase account. The connection string pattern is: Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];.

connectionSpec.id

The Couchbase connection specification ID: 1fe283f6-9bec-11ea-bb37-0242ac130002.

Response

A successful response returns the details of the newly created connection, including its unique identifier (id). This ID is required to explore your data in the next tutorial.

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

Next steps

By following this tutorial, you have created a Couchbase base connection using the Flow Service API. You can use this base connection ID in the following tutorials:

recommendation-more-help

337b99bb-92fb-42ae-b6b7-c7042161d089