使用Flow Service API建立HubSpot基本連線

基礎連線代表來源和Adobe Experience Platform之間的已驗證連線。

本教學課程將逐步引導您使用Flow Service API為HubSpot建立基礎連線的步驟。

快速入門

本指南需要您深入了解下列 Adobe Experience Platform 元件:

  • 來源: Experience Platform允許從各種來源擷取資料,同時讓您能夠使用Experience Platform服務來建構、加標籤以及增強傳入的資料。
  • 沙箱: Experience Platform提供可將單一Experience Platform執行個體分割成個別虛擬環境的虛擬沙箱,以利開發及改進數位體驗應用程式。

下列章節提供您需瞭解的其他資訊,才能使用Flow Service API成功連線到HubSpot。

收集必要的認證

若要讓Flow Service與HubSpot連線,您必須提供下列連線屬性:

認證
說明
clientId
與您的HubSpot應用程式關聯的使用者端識別碼。
clientSecret
與您的HubSpot應用程式關聯的使用者端密碼。
accessToken
最初驗證您的OAuth整合時獲得的存取權杖。
refreshToken
重新整理權杖是在最初驗證您的OAuth整合時取得。
connectionSpec.id
連線規格會傳回來源的聯結器屬性,包括與建立基礎連線和來源連線相關的驗證規格。 HubSpot的連線規格識別碼為: cc6a4487-9e91-433e-a3a3-9cf6626c1806

如需開始使用的詳細資訊,請參閱此HubSpot檔案

使用Experience Platform API

如需如何成功呼叫Experience Platform API的詳細資訊,請參閱Experience Platform API快速入門指南。

建立基礎連線

基本連線會保留來源與Experience Platform之間的資訊,包括來源的驗證認證、連線的目前狀態,以及唯一的基本連線ID。 基礎連線ID可讓您從來源內部探索及導覽檔案,並識別您要擷取的特定專案,包括其資料型別和格式的資訊。

若要建立基底連線ID,請在提供您的HubSpot驗證認證作為要求引數的一部分時,對/connections端點提出POST要求。

API格式

POST /connections

要求

下列要求會建立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"
        }
    }
屬性
說明
auth.params.clientId
與您的HubSpot應用程式關聯的使用者端識別碼。
auth.params.clientSecret
與您的HubSpot應用程式關聯的使用者端密碼。
auth.params.accessToken
最初驗證您的OAuth整合時獲得的存取權杖。
auth.params.refreshToken
重新整理權杖是在最初驗證您的OAuth整合時取得。
connectionSpec.id
HubSpot連線規格識別碼: cc6a4487-9e91-433e-a3a3-9cf6626c1806

回應

成功的回應會傳回新建立的連線,包括其唯一的連線識別碼(id)。 在下個教學課程中探索您的資料時,需要此ID。

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

建立來源連線

來源連線由連線ID、尋找來源資料所需的資訊以及連線規格ID組成。 Source連線可與基礎連線、目標連線和對應ID搭配使用,以建立資料流。

若要建立來源連線,請向Flow Service API的/sourceConnections端點發出POST要求,提供您的基底連線ID和您要擷取的HubSpot資料表名稱。

API格式

POST /sourceConnections

要求

下列要求會建立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"
        }
    }'
屬性
說明
baseConnectionId
您在上一步建立的HubSpot基本連線的唯一連線識別碼。
params.columns
您要擷取至Experience Platform的特定資料表欄。 將此值保留為空白陣列以擷取所有欄。
params.tableName
您要擷取之HubSpot資料表的名稱,格式為<HubSpot Category>.<Sub Category>.<Object Name>。 例如: CRM.Commerce.Discounts
connectionSpec.id
HubSpot連線規格識別碼: cc6a4487-9e91-433e-a3a3-9cf6626c1806

回應

成功的回應會傳回新建立的來源連線,包括其唯一的連線識別碼(id)。

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

後續步驟

依照此教學課程,您已使用Flow Service API建立HubSpot基本連線和來源連線。 您可在下列教學課程中使用這些連線ID:

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