三月 30, 2022 HubSpot

HubSpot API 串接中文教學指南 - 10 分鐘帶你了解如何串接 HubSpot

Hsiang L. | HubSpot 數位轉型專家

HubSpot API 串接中文教學指南 - 10 分鐘帶你了解如何串接 HubSpot

我們都知道,API 就是各個平台串接的橋樑,就好比把一個平台的門打開,將資料傳達到另外一個平台的門一樣的意思。

相信來到這裡的你,都已經對於 HubSpot 有基本的認識,但無論是否你目前是 HubSpot 的使用者,或者代表公司來協助串接 HubSpot 的導入,希望透過這個指南可以幫到你快速上手,將資料串接到 HubSpot 的系統內。

HubSpot API 的教學與資源

對於工程師或行銷來說,只要有 API,我們基本上都能將資料串進來,但你知道 HubSpot API 什麼時候會用到嗎?又或者,HubSpot 的 API 有哪些可以用呢?

使用 HubSpot 要達成行銷目的不難,解決方式也很廣,所以我們的第一步通常都會與客戶先有個 Discovery Call,確認好你的行銷目標,再了解系統以及公司內部現有的資料,給予建議。

因為在 HubSpot 內,要達成一個目標方法可能可以有兩三種以上的解決方式,但到底要怎麼用才用得精準、正確,這就需要有經驗的廠商來給予建議,才能發揮 HubSpot 最大的效益。

而我們公司常遇到的情況,讓我這邊來分享,你覺得 HubSpot 入門難嗎?No no,透過這個文章,我相信你可以很快就上手。

📕 HubSpot API 常見的串接、使用情況、與案例

以下整理了一些我們客戶常會遇到的情況跟使用情況,這些都完全可以透過 HubSpot 平台來達成,而跟我們合作的客戶都會收到我們專屬的串接指南與使用建議,所以無需擔心串接的問題。

  • 追蹤訪客在網站的瀏覽紀錄
    • 小明看了 A 網站的某某產品,到了 B 網站又看了某某服務
  • 紀錄訪客的行為軌跡,無論線上或線下,都能一覽追蹤到訪客,給予正確的資訊
    • 紀錄 Salesforce 或 ERP 等行為,同步更新到 HubSpot,給予廣告與追蹤網站的互動
  • 與第三方平台連結自動化的腳本,提高生產力
    • 可串接「任何一個」有開放 API 的平台
  • 批次匯入聯絡人或訂單資料
  • 更新聯絡人、訂單、公司、工單等屬性(Property)
  • 取得分眾名單的資料再拋轉到其他平台如 ERP 或寄信工具

🔗 HubSpot API 更多資源

導入和串接 HubSpot,要從哪裡開始?

HubSpot 的核心理念與訪客完整的旅程有非常大的關聯,因此不同廠商或開發者串接的基本都大致雷同,本篇文章整理了以下這幾個步驟

  1. 安裝追蹤碼
    • 安裝 HubSpot 追蹤碼的主要目的是要讓 HubSpot 認識這個訪客的身份
  2. 串接表單
    • 串接表單可選擇要不要驗證
    • 串接表單只要能知道 Form ID 跟 Portal ID 即可
    • 串接表單的目的是讓訪客遞交出資料時讓 HubSpot 能夠辨識當下訪客的身份,紀錄在網站上的行為軌跡
  3. 取得 API Key
    • 可透過 Portal API Key、OAuth 驗證、Private Key 等方式取得
  4. 串接 HubSpot Properties
    • 新增、讀取、更新、刪除 HubSpot 資料

不清楚怎麼開始嗎?首先,你要確保你同事或自己有 HubSpot Portal,再來就是安裝追蹤碼,安裝在自己的網站裡面。

安裝追蹤碼 - 追蹤數據的最基本

可於 HubSpot 後台 Tracking & Analytics 底下 Tracking Code,將追蹤碼貼到 HTML 或 GTM 內。追蹤碼會為每個訪客的拜訪給予一組 hubspotutk,這組 hubspotutk 日後會拿來判斷訪客的身份。

HubSpot 表單串接 - 紀錄訪客軌跡

訪客在網站的行為軌跡主要邏輯為:

透過訪客所留下的 Email,與此瀏覽器的 cookie 綁定

所以只要訪客透過以下任何一種方式傳遞 "Email",同時在傳送資料(API)的時候,帶入此 Session 的 cookie,就能綁定為同一個人。

  • 登入/註冊表單
  • 結帳表單
  • 客服或聊天機器人(HubSpot 聊天機器人)
  • 訂閱電子報等

串接 HubSpot 表單有很多種方式來因應各種不同的情況。但主要分別為 API 或者直接用 HubSpot 表單 Embed 嵌入,類似 Iframe,然後再更改 CSS。

  • API - 必須在 HubSpot 裡面建立表單,然後再透過官網伺服器 POST 資料至 HubSpot(HubSpot 這部分有直接提供 FORM 的 POST API,所以不一定要用後端的方式寫)
  • Embed - 必須再 HubSpot 裡面建立表單,生成之後會產生一段 Script,把這段 Script 嵌入在想要的 HTML 段落內,再寫 CSS 去更改樣式,讓整個表單看起來跟網站的樣式是一致的。

兩個都可以達成將表單的資料傳送到 HubSpot 內,只差在一個是需要寫 Javascript 的程式或後端的程式,把表單資料編譯成 JSON 檔案,透過 API 方式傳送到 HubSpot 內,另外一個則是直接嵌入。

嵌入 (Embed) 的方式則是直接一段程式碼嵌入到頁面上,再更改 CSS 即可,無需打 API。

兩個之間,若 CSS 是強項,並且樣式沒有複雜的下拉選單等等的狀況,建議可用 Embed 的方式,但若表單選項較爲複雜,則用 API 的方式。

🔌 WordPress 插件方式

而 HubSpot API 串接表單的方式,若官網的表單是用 WordPress 裡面的 Contact Form 7 或 Gravity Form,可考慮直接用這個插件:

這個插件會將 Contact Form 裡面的 Property Fields (欄位) Mapping (對應) 到 HubSpot 裡面的欄位。

🧪 客製化方式

另外一種方式,也是土法煉鋼最原始的方式,就是將資料用 HubSpot API 的方式傳送到 HubSpot。

  • 前端方法 - HubSpot 有提供前端串表單的方式,會寫 AJAX 的 POST 就會用!
    邏輯就是將表單資料存成 JSON 直接 POST 到 HubSpot 裡面。
  • 後端方法 - 跟上面的概念雷同,一樣就是依照你想要的方式將資料用 JSON 的方式 POST 到 HubSpot 裡面。

取得驗證 - API 串接最重要的第一步

HubSpot 的驗證有分兩種:

  1. HubSpot API Key (HAPI Key)
  2. OAuth App / Private App
  • HubSpot API Key

  • OAuth / Private App

🔑 HubSpot API Key

API Key 可以直接在 HubSpot 的後台內按一次就申請完成。

  1. 到後台選擇 Settings
  2. 點擊 Integrations
  3. 點擊 API Key
  4. 若沒有 API Key 的話,如畫面選擇 Create Key

🔐 OAuth / Private App

OAuth 的驗證方式是在 HubSpot 上面建置一個 Middleware 的 App。

  • App 會安裝在 HubSpot Portal 上面
  • 授權人須為 Admin

什麼時候該用 OAuth?什麼時候該用 Private App?

OAuth App 是當你會有很多個使用者驗證跟使用的時候,就需要 OAuth,Private App 則是驗證一次就好,但資安等級會比固定的 API Key 來得更好。

要注意 OAuth App 能開放的 Scope 還是會遠比 Private App 來得多,所以在開發的時候還是需要慎選。

HubSpot 有提供以下四個語言的 SDK,裡面點進去後會有 Sample App 教你如何建置 OAuth,非常容易上手。

延伸閱讀:Intro to Auth

Properties - 串接 CRM 最重要的資料

Properties 是 CRM 的核心,想要在 HubSpot 裡面看到聯絡人、訂單等的資料,則要用 HubSpot 底下各個 Objects 相關的 API 來去做串接,HubSpot API 的文件裡面有很明確的說明。

HubSpot 的核心在於 Properties,你可以想像幾乎所有的資料都是用 Properties 去存取的。

在串接 Properties 之前,首先你必須知道 HubSpot 的架構,Properties 更上層是 Objects。

什麼是 Objects?

HubSpot CRM 就好比一個資料庫,大量儲存資料的地方。而 Objects 就是資料庫裡面的資料表,由各種資料欄位 (Properties) 所組成。例如:聯絡人 Object 就是所有聯絡人裡面的 Properties 所組成。

我們來看以下這張圖,這張圖有呈現每個 Objects 裡面底下的一些 Properties。

HubSpot API_1
HubSpot CRM Objects 可以有:

  • Contacts - 儲存聯絡人個別的資料,無論是行銷自動化還是要用 Smart Content,善用 Contacts 的 Property 可以將 HubSpot CRM 的功能發揮到最大。

  • Companies - 儲存公司個別的資料,可以將不同的聯絡人關聯到同一間公司來代表公司的架構或組織。

  • Deals - 跟聯絡人或跟公司有關連的訂單,這個 Deals 不一定要是網站上面的訂單,只要有收入利益的訂單都可以。

  • Products - 代表服務或產品,建立一個產品資料庫可以加到訂單、產品報價單、或產品的銷售成效報告等。

  • Line Item - 代表訂單裡面的產品項目,當產品關聯到訂單的時候,他就會成為 Line Item,你可以依照不同的訂單建立不同的 Line Item,這些 Line Item 都是獨立的,不會新增回去產品資料庫。

  • Tickets - 代表客戶請求資源或內部管理的工單。

Properties 是什麼?

Properties 可以讓你儲存任何你想要在 HubSpot 的資料,這些資料可以讓你任意使用去分眾名單、紀錄、追蹤在報表上。

預設來說,每個 Objects 底下都有預設的 Properties,而使用者可以依照公司的流程、狀況、使用方式,來客製化的新增欄位。

Properties 可以是哪些?

  • 姓名
  • 電話
  • 電子郵件
  • 地址
  • 興趣
  • 會員等級
  • 會員狀態

... 等等的

Custom Properties

可以透過 Custom Properties 的方式來儲存更多需要客製化的資料或欄位。

Properties 跟 Custom Properties 有什麼差異?

Properties 是 HubSpot 原生有的資料欄位,例如:姓名、電話、生日,這些都是系統原生就有的。

Custom Properties 是 HubSpot 沒有的資料欄位,因應不同產業需求,使用者所自行新增的資料欄位,例如:網路商店 ID、Line ID、會員編號等等

Groups

當 Properties 存在其中一個 Object 底下的時候,難免會因為 Properties 過多難以管理,這時可以用 Group 的方式來管理。

好比說,Contact Object 底下,你可以建立:

  • Contact Information - 客戶基本資料,裡面可以涵蓋:
    • First Name、Last Name(姓名)
    • Birthday(生日)
  • Contact Web Information - 客戶網上的行為資料,可以涵蓋:
    • Last Interaction(最後一次聯絡時間)
    • Last form submitted(最後一次遞交的表單)

Object Relationship

以下的圖是 HubSpot Entity Relationship Diagram (ERD) 來具體分享 HubSpot CRM 與 Object 的架構跟關聯。

Object Relationship 主要就是做關聯,什麼意思呢?

既然你知道 Contact、Deal、Ticket 等等都是單獨的 Object,這代表你可以將 Contact 關聯到相關的訂單。

這個關聯的製作的故事會落在:陳小明在實體商路消費了 2 次,在線上商店又買了 3 次,這時系統會這樣分:

  • Contact Object (聯絡人) - 陳小明
  • Deal Object(訂單) - #005, #012, #015, #020, #035 等都是跟陳小明有關的訂單

我們就可以用 Object Relationship 的方式,將聯絡人跟訂單關聯起來,這樣在 HubSpot 系統內,你就可以在瀏覽陳小明這位客戶的時候,旁邊多出 5 個關聯訂單。

HubSpot API 串接 ERD

HubSpot 使用情境與問題

在使用 HubSpot 的過程中,你遇到的問題大部分的人也會有其他人一樣,這裡整理了一份你在串接過程中可能會遇到的問題:

  1. 我可以用 HubSpot 跟表單串接的時候,一樣發出自動的感謝信嗎?
    可以的,使用 HubSpot API 跟表單串接起來之後,透過 Workflow 的方式寄出感謝信。
  2. 某個聯絡人的生日到了,發 Line 或簡訊訊息給他嗎?
    可以的,使用 HubSpot API 裡面的 Workflow API 來達成這件事。
  3. 我想知道聯絡人在官網搜索了什麼關鍵字,這是可以用 HubSpot 記錄下來嗎?
    可以的,使用 HubSpot API 裡面的 Properties 與 Timeline API 即可達成這件事。
  4. 我可以在訂單跟產品出貨後,發送一個關心的信或滿意度調查給使用者嗎?
    可以的,這個無需透過 HubSpot API 就能簡單地達成。
  5. 我在其他工具寄送了信件想要判斷客戶是否有開信,想要把開信用戶加入 List 來觸發廣告是否可以做到?
    可以的,其他工具看是用哪個平台,大致上都會有開放 API,只要把有符合這個開信條件的客戶加到一個名單上,透過 HubSpot API 裡面的 List API,再配合 HubSpot 內建的 Workflow 就能達成這件事。
  6. 我們的 Website 裝Hubspot的外掛設計表單讓客戶回填產品的註冊資料,因為會請客戶填購買日期,然後可能我們得根據機種在後台產生對應的保固到期日,Hubspot於到期日前三個月時自動發通知信給客戶,像這種情境是可做到的嗎?
    可以的,在 HubSpot 內直接處理即可,無需透過 HubSpot API 即能簡單地達成。
  7. 可否針對買過特定有使用週期商品的用戶,時間內未回購自動化發送回購通知?
    可以的,這個部分直接在 Workflow 內處理,無需透過 HubSpot API 即可簡單處理完成。
  8. HubSpot 可以在原有的頁面上寫客製的 JS 嗎?
    可以的,在 HubSpot 內直接處理即可,無需透過 HubSpot API 即能簡單地達成。
  9. 我可以根據客戶購買的商品,來推薦相關商品或文章嗎?
    可以的,在 HubSpot 內直接處理即可,無需透過 HubSpot API 即能簡單地達成。
  10. HubSpot 可以跟 XXX 串接 API 嗎?
    可以的,通通可以的,前提下是只要對方有開放 API,HubSpot API 都能處理。我這邊遇到的情況,比較多是行銷這邊對於想要串些什麼樣的資料比較沒有概念,假設這些部分行銷已經有一定的想法,HubSpot 在有一定的資源下,沒有什麼是無法串接的。

以上僅供參考,若你對於這部分還有疑問,歡迎跟我們接談,來探討更多以及合作的可能性。

HubSpot API 的使用與數量次數限制

如同每一家平台一樣,HubSpot API 的使用次數還是會有一定的限制。可以參考官方的 HubSpot API Usage Guideline,裡面有詳細的告知如何查詢 API 目前的使用次數以及上限。

重點的部分,小編幫你拉出來:

使用 OAuth 的 API 數量跟限制

每 10 秒可以有 100 個 request,除了 Search API 之外。有額外購買 API Add-on 的不限於此。

使用 Private App 的 API 數量跟限制

  Product Tier 每 10 秒 每天
Private Apps (Any Hub)
Free and Starter
100 / private app 250,000 / account
(Any Hub)
Pro and Enterprise
150 / private app 500,000 / account
Private Apps with API Add-on (Any Hub)
Free, Starter, Professional, and Enterprise
200 / private app 1,000,000 / account
 

使用 API Key 的 API 數量跟限制

Product tier Limits
Free and Starter Burst: 100/10 seconds
Daily: 250,000
Professional and Enterprise Burst: 150/10 seconds
Daily: 500,000
API Add-on (any tier) Burst: 200/10 seconds
Daily: 1,000,000

HubSpot 與 Salesforce 的串接

疑問!我們公司有在用 Salesforce,他也可以跟 HubSpot 串接嗎?

這當然沒有問題,就如我上面所說的,基本上有 API 平台的系統都可以跟 HubSpot 做串接,問題是在開發的難易度,共分兩種:

  • 廠商開發好的 - 比較知名的,HubSpot 或第三方廠商都會有已經做好的 APP 串接了,所以只要點點幾下設定,就可完成串接。
  • 自行客製化開發 - 這是 HubSpot 或沒其他廠商開發的話,就會遇到需要請工程師自行開發串接 HubSpot 與其他平台的可能。

所以回到 Salesforce 的問題,是否 HubSpot 已經有開發好的串接了呢?是的,HubSpot 跟 Salesforce 因應客戶不同的使用情況,因此已經完成 APP 串接,只要點幾下就可以設定了。

但 HubSpot 與 Salesforce 真的就那麼簡單嗎?對於我們的經驗來說,設定上雖然簡單,但後面必須思考的是,如何將這兩套平台做串接跟應用,什麼時候該在 Salesforce 看資料,以及什麼時候在 HubSpot 看資料,是公司必須考量的。

最重要的一環,是公司內部也必須很清楚知道 Salesforce 的資料可以對應 HubSpot 什麼資料,這樣一來,才會將資料無縫接軌的使用。

HubSpot API 串接與導入服務

HubSpot API 串接的重要性與挑戰

無論你現在只有一個網站,或者已經使用了非常多套行銷軟體、平台等,對於剛購買一套 HubSpot 產品來說,導入是是非常重要的,但通常是許多人可能無法在一開始就清楚的了解這個的重要性,這個會因為公司不同而遇到不同的挑戰。

Blog - Whats HubSpot _1

舊系統的習慣與新系統轉移的挑戰

改變,對於每個來說都是個挑戰。對於一個習慣既有的軟體的人來說,就算 HubSpot 把所有東西都簡化,讓每一個都很好用,始終會比較難去接受或改變產品的使用方式。

網站串接的挑戰

要將現有個官網跟 HubSpot 串接,會是需要專家的協助,因為這往往會涵蓋的程式碼的應用。若導入或串接出了問題,很容易無意間的破壞了 SEO 或導致使用者體驗下降。

多樣軟體、平台互相串接

公司若有許多行銷工具,一但沒有串接好,很容易導致資料過程中漏掉,間接的因為要修復或解決而影響到效率或報表。

匯入時聯絡人資料混亂的挑戰

將聯絡人會進系統裡面,過程中不只是要匯入好,而是要對上正確的聯絡人資訊(Properties),若沒有匯入完整,或者是沒有將這些資訊對好的話,到時候會因為系統的資料散亂,無法篩選出正確的結果,影響到要執行的行銷策略。

各種報表與數據混亂的挑戰

報表做的不對,會產生錯誤的資料結果,影響到行銷決定以及策略。沒有正確的使用 data driven 策略,會降低成長的機會。

自動化的挑戰

自動化應該幫你解省時間跟提高效率,若沒有專家的介入,您可能無法發揮各種應用,但時候可能會對於其功能就如殺雞用牛刀一樣,沒辦法將 HubSpot 的全部發揮出來。

小提醒 👋
在沒有專家的協助下,以上這些挑戰會都是公司遇到的,而透過我們協助,可以讓你們盡快上手,順利導入 HubSpot 至公司 HubSpot 導入專業服務

HubSpot 導入基礎服務項目

以下是你可以在導入過程中可以期待我們會幫您處理的事情:

  • HubSpot 技術設定
    • Domain 設定
    • 追蹤碼設定
    • Email Domain 設定
    • 團隊的帳號加入以及權限管理
  • 建置電子報模板 & Landing Page 設計
  • 電子報模組化設計
  • 網站的模組化設計
  • 建置行銷活動的 Landing Page
  • 建置自動化流程
  • 設定 Sales Pipeline 的流程
  • 建立 HubSpot CRM 聯絡人資料(Properties)
  • 串接其他第三方軟體
  • 開發 HubSpot 軟體
  • 匯入聯絡人
  • 名單分眾
  • 建置表單
  • 網站串接表單至 HubSpot
  • 其他更多...

HubSpot Service Finder

每間公司的需求都不同,導入的狀況跟需求對我們來說都是獨一無二的,因此,我們準備了許多模板與導入項目,之後可以參考我們的 HubSpot Service Finder,透過我們的協助,相信可以為您的公司在使用 HubSpot 上如虎添翼。

Blog - Whats HubSpot _2-

找到有經驗的 HubSpot API 開發人員

HubSpot API 串接是一件非常重要的任務,首先團隊需要先釐清所需要的資料。Properties 是 CRM 的核心,想要在 HubSpot 裡面看到聯絡人、訂單等的資料,則要用 HubSpot 底下各個 Objects 相關的 API 來去做串接。 HubSpot 也提供了完整的開發文件。

建議您與 Hububble 顧問一起協助您們 IT 團隊與行銷團隊了解 API 與您的行銷腳本互相配合,有了這些資料後才能夠進行後續的行銷自動化。

Hububble 有豐富的企業導入經驗,我們協助過 BenQ 資料轉移,並全球導入 HubSpot 可以提供您更進階的 HubSpot 行銷與銷售整合與 API 開發服務。

hububble 於 2021 年晉級為 HubSpot 台灣區「第一家」鑽石級(Diamond-tier Parter)合作夥伴,每個月至少需銷售 19000 美金以上,為台灣最高銷售額的代理商。

致力提供全方位的集客式行銷服務以及 HubSpot 導入服務。
擅於為客戶量身打造數據驅動的數位行銷計畫,幫助客戶有效率的達到行銷目的並獲得持續性的業務成長。

針對不同的產業及業務需求提供客製化服務 :

  • Web Design & Development | 網站設計 & 網站後台建置
  • Marketing & SEO | 客製化行銷內容及策略、SEO 搜尋引擎優化
  • CRM and 3rd party API Integration Solutions | 數位平台間的整合
  • Server & Infrastructure Solutions | 主機託管與規劃服務
  • HubSpot Implementation & Migration Services | HubSpot 中文導入與教育訓練
  • 2020-2021 年服務客戶 : BenQ 明基電通、ADATA 威剛科技、Appier 沛星互動科技、SEMI Taiwan 台灣半導體協會、InQuartik 孚創雲端、DFI 友通資訊、Allxon 奧暢雲、KKStream 香港商科科串流、EVERPADS 永沛得、Chin Nan 佳楠精密電子、Family First 台灣家庭第一協會、JTRweb Limited、SL Motor、朗峰國際移民、丘山旅行社、Forchem 台灣原料行、Yale Chen、Jabez foundation、WE.LOCK、TAITRA 外貿協會、丰采美學牙醫診所、毛寶股份有限公司、TSC Printers、AuthMe ……

HubSpot 台灣唯一鑽石代理商的價格優勢

透過我們購買 HubSpot 與在 HubSpot 官網購買有什麼不同?

  • 價格 - Hububble 作為台灣第一家鑽石級代理商,我們會盡力幫台灣的企業爭取更好的折扣,我們會根據您購買的方案提出優惠申請。
  • 服務 - 除了HubSpot 的服務支援,若您是我們的客戶,我們都會特別專為我們的客戶依照他們串接的需求,以及目標等,根據客戶的腳本客製化你們公司的串接 HubSpot 以及 API 導入文件,讓他們可以很快上手 HubSpot 的 API。

你可能會喜歡

本文章為哈帕博數位行銷有限公司所有,其些素材為 HubSpot 官方提供並官方授權,未經同意,請勿隨意轉載

Share this on

Subscribe to
Learning Hub

掌握趨勢、深度學習,獲得數位產業最佳的執行觀念,使用內容行銷捕捉廣大的網路受眾,一起學習成長 !