Show Menu
TEMAS×

Creación de un conector Couchbase mediante la API de servicio de flujo

El conector Couchbase está en fase beta. Las funciones y la documentación están sujetas a cambios.
El servicio de flujo se utiliza para recopilar y centralizar datos de clientes de distintas fuentes para incluirlos en la plataforma de Adobe Experience. El servicio proporciona una interfaz de usuario y una API RESTful desde la que se pueden conectar todas las fuentes admitidas.
Este tutorial utiliza la API de servicio de flujo para guiarle por los pasos necesarios para conectar Couchbase a la plataforma de experiencia.

Primeros pasos

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:
  • Fuentes : La plataforma de experiencia permite la ingesta de datos de diversas fuentes, al tiempo que le permite estructurar, etiquetar y mejorar los datos entrantes mediante los servicios de plataforma.
  • Simuladores : La plataforma de experiencia proporciona entornos limitados virtuales que dividen una instancia de plataforma única en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.
Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente a Couchbase mediante la API de servicio de flujo.

Recopilar las credenciales necesarias

Credencial
Descripción
connectionString
La cadena de conexión utilizada para conectarse a la instancia de Couchbase. El patrón de cadena de conexión para Couchbase es Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; . Para obtener más información sobre la adquisición de una cadena de conexión, consulte este documento Couchbase.
connectionSpec.id
Identificador necesario para crear una conexión. El ID de especificación de conexión fija para Couchbase es 1fe283f6-9bec-11ea-bb37-0242ac130002 .

Leer llamadas de API de muestra

Este tutorial proporciona ejemplos de llamadas a API para mostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados requeridos y cargas de solicitud con el formato adecuado. También se proporciona el JSON de muestra devuelto en las respuestas de API. Para obtener más información sobre las convenciones utilizadas en la documentación de las llamadas de API de muestra, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas de la plataforma de experiencia.

Recopilar valores para encabezados necesarios

Para realizar llamadas a las API de plataforma, primero debe completar el tutorial de autenticación. Al completar el tutorial de autenticación se proporcionan los valores para cada uno de los encabezados necesarios en todas las llamadas de API de la plataforma de experiencia, como se muestra a continuación:
  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Todos los recursos de la plataforma de experiencia, incluidos los que pertenecen al servicio de flujo, están aislados en entornos limitados virtuales específicos. Todas las solicitudes a las API de plataforma requieren un encabezado que especifique el nombre del simulador para pruebas en el que tendrá lugar la operación:
  • x-sandbox-name: {SANDBOX_NAME}
Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medio adicional:
  • Content-Type: application/json

Crear una conexión

Una conexión especifica un origen y contiene sus credenciales para ese origen. Solo se requiere un conector por cuenta Couchbase, ya que se puede utilizar para crear varios conectores de origen para traer datos diferentes.
Formato API
POST /connections

Solicitud
La siguiente solicitud crea una nueva conexión Couchbase, configurada por las propiedades proporcionadas en la carga útil:.
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"
        }
    }'

Propiedad
Descripción
auth.params.connectionString
La cadena de conexión utilizada para conectarse a una cuenta Couchbase. El patrón de cadena de conexión es: Server={SERVER}; Port={PORT};AuthMech=1;CredString=[{\"user\": \"{USER}\", \"pass\":\"{PASS}\"}]; .
connectionSpec.id
ID 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 Couchbase mediante la API de servicio de flujo y ha obtenido el valor de ID exclusivo de la conexión. Puede utilizar este ID en el siguiente tutorial cuando aprenda a explorar bases de datos mediante la API de servicio de flujo.