Crear una conexión base Couchbase mediante la API Flow Service

NOTE
El conector Couchbase está en versión beta. Consulte Resumen de fuentes para obtener más información sobre el uso de conectores con etiqueta beta.

Una conexión base representa la conexión autenticada entre un origen y Adobe Experience Platform.

Este tutorial lo guiará para crear una conexión base para Couchbase mediante la Flow Service API.

Introducción

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos de varias fuentes al tiempo que le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de Platform.
  • Zonas protegidas: Experience Platform proporciona zonas protegidas virtuales que dividen una sola instancia de Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que necesitará conocer para conectarse correctamente a Couchbase mediante la API Flow Service.

Recopilar credenciales necesarias

Credencial
Descripción
connectionString
Cadena de conexión utilizada para conectarse a la instancia Couchbase. El patrón de cadena de conexión de Couchbase es Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];. Para obtener más información sobre cómo adquirir una cadena de conexión, consulte este documento de Couchbase.
connectionSpec.id
La especificación de conexión devuelve las propiedades del conector de origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. El id. de especificación de conexión para Couchbase es 1fe283f6-9bec-11ea-bb37-0242ac130002.

Uso de API de Platform

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía sobre introducción a las API de Platform.

Crear una conexión base

Una conexión base retiene información entre el origen y Platform, incluidas las credenciales de autenticación del origen, el estado actual de la conexión y el ID único de conexión base. El ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar los elementos específicos que desea introducir, incluida la información sobre sus tipos de datos y formatos.

Para crear un identificador de conexión base, realice una solicitud de POST al extremo /connections y proporcione las credenciales de autenticación Couchbase como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para 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"
        }
    }'
Propiedad
Descripción
auth.params.connectionString
Cadena de conexión utilizada para conectarse a una cuenta de Couchbase. El patrón de cadena de conexión es: Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}];.
connectionSpec.id
Identificador de especificación de conexión Couchbase: 1fe283f6-9bec-11ea-bb37-0242ac130002.

Respuesta

Una respuesta correcta devuelve los detalles de la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar los datos en el siguiente tutorial.

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

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión base Couchbase mediante la API Flow Service. Puede utilizar este ID de conexión base en los siguientes tutoriales:

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089