Criar uma conexão básica do SQL Server Microsoft usando a API Flow Service

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

Este tutorial o orienta pelas etapas para criar uma conexão básica para Microsoft SQL Server usando a Flow Service API.

Introdução

Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

  • Fontes: Experience Platform O permite que os dados sejam assimilados de várias fontes, além de fornecer a você a capacidade de estruturar, rotular e aprimorar os dados recebidos usando Platform serviços.
  • Sandboxes: Experience Platform O fornece sandboxes virtuais que particionam uma única Platform instância 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 a Microsoft SQL Server usando a API Flow Service.

Obter credenciais necessárias

Para se conectar a Microsoft SQL Server, você deve fornecer a seguinte propriedade de conexão:

Credencial Descrição
connectionString A cadeia de conexão associada à sua conta Microsoft SQL Server. O padrão da string de conexão Microsoft SQL Server é: Data Source={SERVER_NAME}\\<{INSTANCE_NAME} if using named instance>;Initial Catalog={DATABASE};Integrated Security=False;User ID={USERNAME};Password={PASSWORD};.
connectionSpec.id A especificação de conexão retorna as propriedades do conector de origem, incluindo especificações de autenticação relacionadas à criação das conexões base e de origem. A ID de especificação de conexão para Microsoft SQL Server é 1f372ff9-38a4-4492-96f5-b9a4e4bd00ec.

Para obter mais informações sobre como obter uma string de conexão, consulte este Microsoft SQL Server documento.

Uso de APIs da plataforma

Para obter informações sobre como fazer chamadas para APIs da plataforma com êxito, consulte o guia sobre como começar a usar APIs da plataforma.

Criar uma conexão base

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

Para criar uma ID de conexão base, faça uma solicitação de POST ao endpoint /connections, fornecendo as credenciais de autenticação Microsoft SQL Server como parte dos parâmetros da solicitação.

Formato da API

POST /connections

Solicitação

A solicitação a seguir cria uma conexão base para Microsoft SQL Server:

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": "Base connection for sql-server",
        "description": "Base connection for sql-server",
        "auth": {
            "specName": "Connection String Based Authentication",
            "params": {
                "connectionString": "Data Source={SERVER_NAME}\\<{INSTANCE_NAME} if using named instance>;Initial Catalog={DATABASE};Integrated Security=False;User ID={USERNAME};Password={PASSWORD};"
            }
        },
        "connectionSpec": {
            "id": "1f372ff9-38a4-4492-96f5-b9a4e4bd00ec",
            "version": "1.0"
    }'
Propriedade Descrição
auth.params.connectionString A cadeia de conexão associada à sua conta Microsoft SQL Server. O padrão da string de conexão Microsoft SQL Server é: Data Source={SERVER_NAME}\\<{INSTANCE_NAME} if using named instance>;Initial Catalog={DATABASE};Integrated Security=False;User ID={USERNAME};Password={PASSWORD};.
connectionSpec.id A ID da especificação de conexão Microsoft SQL Server é: 1f372ff9-38a4-4492-96f5-b9a4e4bd00ec.

Resposta

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

{
    "id": "0b8224e4-0de8-4293-8224-e40de80293c6",
    "etag": "\"5802c519-0000-0200-0000-5e4d89520000\""
}

Próximas etapas

Ao seguir este tutorial, você criou uma conexão Microsoft SQL Server usando a API Flow Service e obteve o valor de ID exclusivo da conexão. Você pode usar essa ID de conexão no próximo tutorial à medida que aprende a explorar bancos de dados ou sistemas NoSQL usando a API do Serviço de Fluxo.

Nesta página