Creare una connessione di base HubSpot utilizzando l’API Flow Service

Una connessione di base rappresenta la connessione autenticata tra un’origine e Adobe Experience Platform.

Questo tutorial illustra i passaggi necessari per creare una connessione di base per HubSpot utilizzando Flow Service API.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Origini: Experience Platform consente l’acquisizione di dati da varie origini e consente di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi Experience Platform.
  • Sandbox: Experience Platform fornisce sandbox virtuali che suddividono una singola istanza di Experience Platform in ambienti virtuali separati, utili per le attività di sviluppo e aggiornamento delle applicazioni di esperienza digitale.

Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettersi correttamente a HubSpot utilizzando l’API Flow Service.

Raccogli le credenziali richieste

Affinché Flow Service possa connettersi a HubSpot, è necessario fornire le seguenti proprietà di connessione:

Credenziali
Descrizione
clientId
L’ID client associato all’applicazione HubSpot.
clientSecret
Il segreto client associato all’applicazione HubSpot.
accessToken
Il token di accesso ottenuto durante l’autenticazione iniziale dell’integrazione OAuth.
refreshToken
Il token di aggiornamento ottenuto durante l’autenticazione iniziale dell’integrazione OAuth.
connectionSpec.id
La specifica di connessione restituisce le proprietà del connettore di un’origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. ID della specifica di connessione per HubSpot: cc6a4487-9e91-433e-a3a3-9cf6626c1806.

Per ulteriori informazioni su come iniziare, consulta questo documento HubSpot.

Utilizzo delle API di Experience Platform

Per informazioni su come effettuare correttamente chiamate alle API di Experience Platform, consulta la guida introduttiva alle API di Experience Platform.

Creare una connessione di base

Una connessione di base mantiene le informazioni tra l’origine e Experience Platform, incluse le credenziali di autenticazione dell’origine, lo stato corrente della connessione e l’ID univoco della connessione di base. L’ID della connessione di base consente di esplorare e navigare tra i file dall’interno dell’origine e identificare gli elementi specifici che desideri acquisire, comprese le informazioni relative ai tipi di dati e ai formati.

Per creare un ID connessione di base, eseguire una richiesta POST all’endpoint /connections fornendo le credenziali di autenticazione HubSpot come parte dei parametri della richiesta.

Formato API

POST /connections

Richiesta

La richiesta seguente crea una connessione di base per 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"
        }
    }
Proprietà
Descrizione
auth.params.clientId
L’ID client associato all’applicazione HubSpot.
auth.params.clientSecret
Il segreto client associato all’applicazione HubSpot.
auth.params.accessToken
Il token di accesso ottenuto durante l’autenticazione iniziale dell’integrazione OAuth.
auth.params.refreshToken
Il token di aggiornamento ottenuto durante l’autenticazione iniziale dell’integrazione OAuth.
connectionSpec.id
ID della specifica di connessione HubSpot: cc6a4487-9e91-433e-a3a3-9cf6626c1806.

Risposta

In caso di esito positivo, la risposta restituisce la connessione appena creata, incluso l’identificatore univoco (id). Questo ID è necessario per esplorare i dati nell’esercitazione successiva.

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

Creare una connessione sorgente

Una connessione di origine è costituita da un ID connessione, dalle informazioni necessarie per individuare i dati di origine e da un ID specifica di connessione. Le connessioni Source vengono utilizzate insieme alle connessioni di base, alle connessioni di destinazione e agli ID di mappatura per creare un flusso di dati.

Per creare una connessione di origine, effettuare una richiesta POST all’endpoint /sourceConnections dell’API Flow Service, fornendo l’ID connessione di base e il nome della tabella HubSpot che si desidera acquisire.

Formato API

POST /sourceConnections

Richiesta

La richiesta seguente crea una connessione di origine per 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"
        }
    }'
Proprietà
Descrizione
baseConnectionId
ID di connessione univoco della connessione di base HubSpot creata nel passaggio precedente.
params.columns
Le colonne di tabella specifiche dei dati che desideri acquisire in Experience Platform. Lascia questo valore come array vuoto per acquisire tutte le colonne.
params.tableName
Nome della tabella HubSpot da acquisire, nel formato <HubSpot Category>.<Sub Category>.<Object Name>. Ad esempio: CRM.Commerce.Discounts.
connectionSpec.id
ID della specifica di connessione HubSpot: cc6a4487-9e91-433e-a3a3-9cf6626c1806.

Risposta

In caso di esito positivo, la risposta restituisce la connessione di origine appena creata, incluso il relativo identificatore univoco di connessione (id).

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

Passaggi successivi

Seguendo questa esercitazione, è stata creata una connessione di base HubSpot e una connessione di origine utilizzando l’API Flow Service. Puoi utilizzare questi ID di connessione nelle seguenti esercitazioni:

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