DocumentaçãoExperience PlatformGuia dos conectores de origem

Criar uma conexão de base PostgreSQL usando a API Flow Service

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

Criado para:

  • Desenvolvedor

Uma conexão base representa a conexão autenticada entre uma origem e o Adobe Experience Platform.

Este tutorial guiará você pelas etapas para criar uma conexão básica para PostgreSQL usando a Flow Service API.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

  • Fontes: Experience Platform permite que os dados sejam assimilados de várias fontes e fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços do Platform.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.

As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito ao PostgreSQL usando a API Flow Service.

Coletar credenciais necessárias

Para que Flow Service se conecte a PostgreSQL, você deve fornecer a seguinte propriedade de conexão:

Credencial
Descrição
connectionString
A cadeia de conexão associada à sua conta PostgreSQL. O padrão da cadeia de conexão PostgreSQL é: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}.
connectionSpec.id
A especificação de conexão retorna as propriedades do conector de uma origem, incluindo especificações de autenticação relacionadas à criação das conexões de base e de origem. A ID da especificação de conexão para PostgreSQL é 74a1c565-4e59-48d7-9d67-7c03b8a13137.

Para obter mais informações sobre como obter uma cadeia de conexão, consulte este PostgreSQL documento.

Habilitar criptografia SSL para sua cadeia de conexão

Você pode habilitar a criptografia SSL para a cadeia de conexão PostgreSQL anexando sua cadeia de conexão com as seguintes propriedades:

Propriedade
Descrição
Exemplo
EncryptionMethod
Permite habilitar a criptografia SSL nos dados do PostgreSQL.
  • EncryptionMethod=0(Desabilitado)
  • EncryptionMethod=1(Habilitado)
  • EncryptionMethod=6(RequestSSL)
ValidateServerCertificate
Valida o certificado enviado pelo banco de dados PostgreSQL quando EncryptionMethod é aplicado.
  • ValidationServerCertificate=0(Desabilitado)
  • ValidationServerCertificate=1(Habilitado)

Este é um exemplo de uma cadeia de conexão PostgreSQL anexada com criptografia SSL: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD};EncryptionMethod=1;ValidateServerCertificate=1.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual sobre introdução às APIs da Platform.

Criar uma conexão básica

Uma conexão base retém informações entre sua origem e a Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e sua ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.

Para criar uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections enquanto fornece suas credenciais de autenticação PostgreSQL como parte dos parâmetros de solicitação.

Formato da API

POST /connections

Solicitação

A solicitação a seguir cria uma conexão 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"
        }
    }'
Propriedade
Descrição
auth.params.connectionString
A cadeia de conexão associada à sua conta PostgreSQL. O padrão da cadeia de conexão PostgreSQL é: Server={SERVER};Database={DATABASE};Port={PORT};UID={USERNAME};Password={PASSWORD}.
connectionSpec.id
As IDs de especificação de conexão PostgreSQL: 74a1c565-4e59-48d7-9d67-7c03b8a13137.

Resposta

Uma resposta bem-sucedida retorna o identificador exclusivo (id) da conexão base recém-criada. Essa ID é necessária para explorar o banco de dados do PostgreSQL no próximo tutorial.

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

Próximas etapas

Seguindo este tutorial, você criou uma conexão da base de conexão PostgreSQL usando a API Flow Service. Você pode usar essa ID de conexão básica nos seguintes tutoriais:

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