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

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 HubSpot 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 Experience Platform.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Experience 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 HubSpot usando a API Flow Service.

Coletar credenciais necessárias

Para que Flow Service se conecte a HubSpot, você deve fornecer as seguintes propriedades de conexão:

Credencial
Descrição
clientId
A ID do cliente associada ao aplicativo HubSpot.
clientSecret
O segredo do cliente associado ao aplicativo HubSpot.
accessToken
O token de acesso obtido ao autenticar inicialmente a integração OAuth.
refreshToken
O token de atualização obtido ao autenticar inicialmente a integração OAuth.
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 HubSpot é: cc6a4487-9e91-433e-a3a3-9cf6626c1806.

Para obter mais informações sobre a introdução, consulte este documento do HubSpot.

Uso de APIs do Experience Platform

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

Criar uma conexão básica

Uma conexão base retém informações entre sua origem e a Experience Platform, incluindo as credenciais de autenticação da origem, 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 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 ao fornecer suas credenciais de autenticação HubSpot 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 HubSpot:

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": "connection for HubSpot",
        "description": "connection for HubSpot",
        "auth": {
            "specName": "OAuth2 Refresh Code",
            "params": {
                "clientId": "{CLIENT_ID}",
                "clientSecret": "{CLIENT_SECRET}",
                "accessToken": "{ACCESS_TOKEN}",
                "refreshToken": "{REFRESH_TOKEN}"
            }
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }
Propriedade
Descrição
auth.params.clientId
A ID do cliente associada ao aplicativo HubSpot.
auth.params.clientSecret
O segredo do cliente associado ao aplicativo HubSpot.
auth.params.accessToken
O token de acesso obtido ao autenticar inicialmente a integração OAuth.
auth.params.refreshToken
O token de atualização obtido ao autenticar inicialmente a integração OAuth.
connectionSpec.id
A ID da especificação de conexão HubSpot: cc6a4487-9e91-433e-a3a3-9cf6626c1806.

Resposta

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

{
    "id": "2fce94c1-9a93-4971-8e94-c19a93097129",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0000\""
}

Criar uma conexão de origem

Uma conexão de origem consiste em uma ID de conexão, informações necessárias para localizar os dados de origem e uma ID de especificação de conexão. As conexões do Source são usadas em conjunto com conexões base, conexões de destino e IDs de mapeamento para criar um fluxo de dados.

Para criar uma conexão de origem, faça uma solicitação POST para o ponto de extremidade /sourceConnections da API Flow Service, fornecendo a ID da conexão básica e o nome da tabela HubSpot que deseja assimilar.

Formato da API

POST /sourceConnections

Solicitação

A solicitação a seguir cria uma conexão de origem para HubSpot:

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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": "HubSpot source connection",
        "baseConnectionId": "b4a738db-8696-4e2a-bf95-08d2927c911e",
        "description": "HubSpot source connection",
        "params": {
            "columns": [],
            "tableName": "CRM.Objects.Contacts"
        },
        "data": {
            "format": "tabular",
            "schema": null,
            "properties": null
        },
        "connectionSpec": {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "version": "1.0"
        }
    }'
Propriedade
Descrição
baseConnectionId
A ID de conexão exclusiva da conexão de base HubSpot que você criou na etapa anterior.
params.columns
As colunas de dados da tabela específica que você deseja assimilar na Experience Platform. Deixe esse valor como uma matriz vazia para assimilar todas as colunas.
params.tableName
O nome da tabela HubSpot que você deseja assimilar, no formato <HubSpot Category>.<Sub Category>.<Object Name>. Por exemplo: CRM.Commerce.Discounts.
connectionSpec.id
A ID da especificação de conexão HubSpot: cc6a4487-9e91-433e-a3a3-9cf6626c1806.

Resposta

Uma resposta bem-sucedida retorna a conexão de origem recém-criada, incluindo seu identificador de conexão exclusivo (id).

{
    "id": "cbfd6fe0-0d1f-4c26-bd06-f00d1f4c26fc",
    "etag": "\"d403848a-0000-0200-0000-5e978f7b0001\""
}

Próximas etapas

Seguindo este tutorial, você criou uma conexão de base e uma conexão de origem do HubSpot usando a API Flow Service. Você pode usar essas IDs de conexão nos seguintes tutoriais:

recommendation-more-help
experience-platform-help-sources