Show Menu
ARGOMENTI×

Creare un connettore HubSpot utilizzando l'API del servizio di flusso

Flow Service è utilizzato per raccogliere e centralizzare i dati dei clienti da varie origini diverse all'interno di Adobe Experience Platform. Il servizio fornisce un'interfaccia utente e RESTful API da cui sono collegate tutte le origini supportate.
Questa esercitazione utilizza l’API del servizio di flusso per seguire i passaggi necessari per connettere Experience Platform a HubSpot.

Introduzione

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
  • Origini : Experience Platform consente di acquisire dati da varie fonti, fornendo al contempo la possibilità di strutturare, etichettare e migliorare i dati in arrivo tramite i servizi della piattaforma.
  • Sandbox : Experience Platform fornisce sandbox virtuali che dividono una singola istanza della piattaforma in ambienti virtuali separati per sviluppare e sviluppare applicazioni per esperienze digitali.
Le sezioni seguenti forniscono informazioni aggiuntive che sarà necessario conoscere per collegarsi correttamente a HubSpot utilizzando l'API del servizio di flusso.

Raccogli credenziali richieste

Affinché il servizio di flusso 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
Token di accesso ottenuto durante l'autenticazione iniziale dell'integrazione OAuth.
refreshToken
Token di aggiornamento ottenuto durante l'autenticazione iniziale dell'integrazione OAuth.
Per ulteriori informazioni su come iniziare, consulta questo documento oauth2-overview HubSpot.

Lettura di chiamate API di esempio

Questa esercitazione fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito un JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione come leggere le chiamate API di esempio nella guida alla risoluzione dei problemi della piattaforma Experience.

Raccogli valori per le intestazioni richieste

Per effettuare chiamate alle API della piattaforma, dovete prima completare l'esercitazione di autenticazione. Completando l'esercitazione sull'autenticazione, vengono forniti i valori per ciascuna delle intestazioni richieste in tutte le chiamate API di Experience Platform, come illustrato di seguito:
  • Autorizzazione: Portatore {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Tutte le risorse in Experience Platform, incluse quelle appartenenti al servizio di flusso, sono isolate in sandbox virtuali specifiche. Tutte le richieste alle API della piattaforma richiedono un'intestazione che specifica il nome della sandbox in cui avrà luogo l'operazione:
  • x-sandbox-name: {SANDBOX_NAME}
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un'intestazione aggiuntiva per il tipo di supporto:
  • Content-Type: application/json

Cercare le specifiche di connessione

Per creare una connessione HubSpot, in Flow Service deve essere presente un set di specifiche di connessione HubSpot. Il primo passo per collegare Platform a HubSpot è recuperare queste specifiche.
Formato API
Ogni origine disponibile dispone di un proprio set di specifiche di connessione per descrivere le proprietà del connettore, ad esempio i requisiti di autenticazione. L'invio di una richiesta GET all' /connectionSpecs endpoint restituirà le specifiche di connessione per tutte le origini disponibili. Potete anche includere la query property=name=="hubspot" per ottenere informazioni specifiche per HubSpot.
GET /connectionSpecs
GET /connectionSpecs?property=name=="hubspot"

Richiesta
La richiesta seguente recupera le specifiche di connessione per HubSpot.
curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connectionSpecs?property=name=="hubspot"' \
    -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}'

Risposta
Una risposta corretta restituisce la specifica di connessione per HubSpot, incluso il relativo identificatore univoco ( id ). Questo ID è richiesto nel passaggio successivo per creare una connessione per l'API.
{
    "items": [
        {
            "id": "cc6a4487-9e91-433e-a3a3-9cf6626c1806",
            "name": "hubspot",
            "providerId": "0ed90a81-07f4-4586-8190-b40eccef1c5a",
            "version": "1.0",
            "authSpec": [
                {
                    "name": "Basic Authentication",
                    "spec": {
                        "$schema": "http://json-schema.org/draft-07/schema#",
                        "type": "object",
                        "description": "defines auth params required for connecting to HubSpot",
                        "properties": {
                            "clientId": {
                                "type": "string",
                                "description": "The client ID associated with your HubSpot application."
                            },
                            "clientSecret": {
                                "type": "string",
                                "description": "The client secret associated with your HubSpot application.",
                                "format": "password"
                            },
                            "accessToken": {
                                "type": "string",
                                "description": "The access token obtained when initially authenticating your OAuth integration.",
                                "format": "password"
                            },
                            "refreshToken": {
                                "type": "string",
                                "description": "The refresh token obtained when initially authenticating your OAuth integration.",
                                "format": "password"
                            }
                        },
                        "required": [
                            "clientId",
                            "clientSecret",
                            "accessToken",
                            "refreshToken"
                        ]
                    }
                }
            ],
        }
    ]
}

Creare una connessione per l'API

Una connessione per l'API specifica le origini e contiene le credenziali per tale origine. Per l'account HubSpot è necessaria una sola connessione per l'API, in quanto può essere utilizzata per creare più connettori sorgente per inserire dati diversi.
Formato API
POST /connections

Richiesta
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": "connection for hubspot",
        "description": "connection for hubspot",
        "auth": {
            "specName": "Basic Authentication",
            "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
Token di accesso ottenuto durante l'autenticazione iniziale dell'integrazione OAuth.
auth.params.refreshToken
Token di aggiornamento ottenuto durante l'autenticazione iniziale dell'integrazione OAuth.
Risposta
Una risposta corretta restituisce i dettagli della nuova connessione creata per l'API, incluso il relativo identificatore univoco ( id ). Questo ID è necessario per esplorare i dati nell'esercitazione successiva.
{
    "id": "2eb9c78b-e8b8-4400-b9c7-8be8b86400b2",
    "etag": "\"05026cf5-0000-0200-0000-5e4c42920000\""
}

Seguendo questa esercitazione, hai creato una connessione HubSpot utilizzando l'API del servizio di flusso e hai ottenuto il valore ID univoco della connessione. Puoi utilizzare questo ID connessione nell'esercitazione successiva per imparare a esplorare i sistemi CRM utilizzando l'API del servizio di flusso.