DocumentaciónExperience PlatformGuía de conectores de origen

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

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador

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 PostgreSQL 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 PostgreSQL mediante la API Flow Service.

Recopilar credenciales necesarias

Para que Flow Service se conecte con PostgreSQL, debe proporcionar la siguiente propiedad de conexión:

Credencial
Descripción
connectionString
La cadena de conexión asociada a su cuenta de PostgreSQL. El patrón de cadena de conexión PostgreSQL es: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}.
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 PostgreSQL es 74a1c565-4e59-48d7-9d67-7c03b8a13137.

Para obtener más información sobre cómo obtener una cadena de conexión, consulte este PostgreSQL documento.

Habilitar el cifrado SSL para la cadena de conexión

Puede habilitar el cifrado SSL para la cadena de conexión PostgreSQL adjuntando la cadena de conexión con las siguientes propiedades:

Propiedad
Descripción
Ejemplo
EncryptionMethod
Permite habilitar el cifrado SSL en los datos de PostgreSQL.
  • EncryptionMethod=0(deshabilitado)
  • EncryptionMethod=1(Habilitado)
  • EncryptionMethod=6(RequestSSL)
ValidateServerCertificate
Valida el certificado enviado por la base de datos PostgreSQL cuando se aplica EncryptionMethod.
  • ValidationServerCertificate=0(deshabilitado)
  • ValidationServerCertificate=1(Habilitado)

El siguiente es un ejemplo de una cadena de conexión PostgreSQL anexada con cifrado SSL: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD};EncryptionMethod=1;ValidateServerCertificate=1.

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 PostgreSQL como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

La siguiente solicitud crea una conexión base para PostgreSQL:

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": "Test connection for PostgreSQL",
        "description": "Test connection for PostgreSQL",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "74a1c565-4e59-48d7-9d67-7c03b8a13137",
            "version": "1.0"
        }
    }'
Propiedad
Descripción
auth.params.connectionString
La cadena de conexión asociada a su cuenta de PostgreSQL. El patrón de cadena de conexión PostgreSQL es: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}.
connectionSpec.id
Los identificadores de especificación de conexión PostgreSQL: 74a1c565-4e59-48d7-9d67-7c03b8a13137.

Respuesta

Una respuesta correcta devuelve el identificador único (id) de la conexión base recién creada. Este identificador es necesario para explorar la base de datos PostgreSQL en el siguiente tutorial.

{
    "id": "056dd1b4-da33-42f9-add1-b4da3392f94e",
    "etag": "\"1700e582-0000-0200-0000-5e3c85180000\""
}

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión base de conexión PostgreSQL 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