HubSpot

HubSpotで使用可能なAPIの機能をまとめました

HubSpotAPIにはアナリティクスAPI、CMSAPI、CRMAPI などの種類があります。 これらのAPIはHubSpotの管理画面外からも操作可能で、外部のツールと連携する際に必要になります。 そこで今回は、HubSpotのAPIを使ってできることとその操作方法を紹介していきます。


Hubspotで利用できるAPIとは?

HubspotAPIの紹介

普段みなさんがブラウザというUI(ユーザーインターフェース)で行う情報の確認や編集をAPIで行うことによって、些末な事務作業から人手が解放され、ビジネスのよりコアな部分にリソースを集中させることができます。また、人手では到底無理なスピードや量の情報処理を行えることで、ライバル企業と大きく差をつける価値の創造につながります。

こう書くと、SaaSのAPIを利用することは一種の産業革命であり、皆さんが避けては通れない未来であると言えるかもしれません。

この記事ではHubspotと外部ツールとの連携に必須なAPIについて、具体的にできることを簡潔にさらっていく形でご紹介していきます。

プログラムを使えばどんなことができるのか、「自社のこの作業はもしかして自動化できるんじゃないか」といったイメージの形成の一助になりましたら幸いです。

今回はAPIについて詳しく紹介します。HubSpot全体でできることやマーケター向けのHubSpot活用については以下の記事をご覧ください。

→HubSpot使用者必見|サービス連携と開発でHubSpotを使いこなそう!

 

API自体についての詳細は以下の記事をご覧ください。

→API通信についての詳細記事はこちら

 

アナリティクスAPI

アナリティクスツールのダッシュボードで見るような、

  • フォームのビュー数やコンバージョン率
  • トラッキンアナリティクの総訪問者数やオーガニック検索数
  • ウェブサイトの訪問者数や滞在時間


などなど、様々な数値が実はAPI経由でも取得できます。

他ツールを使ったキャンペーン結果との統合、よりカスタマイズされた分析や、社内日報などに使うイメージでしょうか。

 

CMS API

まだまだbeta扱いのコマンドが多いですが、

  • HubDBを操作
  • デザインツール内のファイルのアップロードやダウンロード
  • ランディング/ブログページの追加、更新、削除

など、顧客に属する情報というよりは、ポータルのコンテンツ系の情報に対してアクセスが可能です。
筆者はHubDBくらいしか触ったことがないのですが、ここら辺を極めればコンテンツを自動的に配信していく、なんてことも可能になるのではないでしょうか。

Integromatのコミュニティは様々なSaaSを触る人が集まっているのですが、ニュースやSNSコンテンツをまとめて自分のブログやSNSグループに投稿するのを自動化しようと試みる方が増えているような気がします。

 

CRM API

皆さんが一番よく触るであろう、コンタクトや取引、会社といったオブジェクトに関する操作になります。

  • オブジェクトの読み取り、更新や削除

についてはワークフローと多くが共通していると思います。他にも

  • プロパティ/グループ/パイプライン設定の読み取り、更新や削除
  • メールやメモやタスクに対する操作
  • ポータルのユーザー情報
  • 取引に商品項目追加

などがあり、幅広く操作が可能です。

 

イベントAPI

Hubspotでメール送信するとイベントというオブジェクトが生まれます。メールイベントにはキャンペーンとして送信したメールの開封実勢やバウンスしたかどうか、メール送信が他のどんなイベントによって送信されたか、などの情報が加えられます。
メールイベントのAPIはこういった情報を収集できるエンドポイントになります。

その他、Hubspot上のウェブサイトではMarketing Hub Enterpriseで可能なカスタム行動イベントを設定したり、バナーをだす機能があるのですが、それらの統計情報やメタデータの情報がこのAPIで取得できます。
またRESTful API(URLエンドポイントと値をやり取りし合う操作方法)の他、ウェブサイトに埋め込むJavascriptのSDK(コードでの操作がパッケージ化されたもの)についてもこちらのAPIに分類されています。

 

マーケティングAPI

こちらも現行のAPIバージョンv3~4ではベータが多く、バージョン1~2が中心になってくると思いますが、メール配信設定の操作フォームの操作(執筆時点でベータであるAPIv3では、v1~2のフォーム送信やフィールド情報のCRUD(Create,Remove, Update, Delete)よりも細かな設定ができるようです)やコンタクトリストへの操作eコマース関連のオブジェクトに対する操作がこのカテゴリーのAPIで可能になります。

 

APIの利用方法

APIキー

APIを利用する基本的な方法として、みなさんがサービスにログインする際と同じく、パスワードが必要になります。APIではパスワードでなくAPIキーと呼びます。それぞれのポータルに対してユニークなものが発行されていますので、メールアドレスのようなユーザーIDは必要ありません
こちらは、権限を持った方であればポータル上で設定>連携>APIキーと進んでいくとあります。
ただし、このAPIキーは自社のポータルに対してAPIでできるあらゆることができるものになっています。厳重に管理しましょう。

 

カスタムアプリ

Developerアカウントを作成し、アプリを作って、Hubspotのアプリマーケットプレイスに公開せずとも自社ポータルにのみインストールして運用する、という方法があります。インストール時に”OAuth2.0のフロー”のハンドリングをしなければいけない、など若干ハードルが高いものになりますが、このアプリに対して与えるAPIキー(どちらかというとパスワードのように固定のAPIキーに対して、アプリに与えられるものはトークンと呼ばれ、一時的なパスコードのうようなものでポータルにアクセスします)の権限は限定的にすることができ、セキュリティがやや高いものになります。

 

プライベートアプリ

昨年の終わり頃に利用できるようになった機能です。権限を絞りつつ、APIキーのように簡単に取得でき、目的の開発ごとに発行・削除ができるものです。カスタムアプリと違い、”OAuth2.0のフロー”のハンドリングは必要ありません。注意点としては、カスタムアプリではWebhookを設定できますが、プライベートアプリではできません。また、今のところ作成可能なプライベートアプリは最大20件までです。
Webhookとは、プログラムがプログラムに対する通知をするのに利用されます。例えばコンタクトが新規作成・更新された際にとあるコードを稼働させて処理をするのに使えます。

閲覧するは、スーパー管理者権限が必要になります。また、管理者によってAPIキーがローテーションされたり無効化されたりすると使えなくなります。これはプライベートアプリにおいても同様です。

 

開発において気を付けること

※以下の横線内の内容は開発者寄りの話になるので、さほどでもない方は読み飛ばしていただいた方がよいかと思います。

 

 


APIそのものの制限として、

  • 瞬間(バースト):10秒あたり100(コマンド)
  • 1日あたり:250,000(コマンド)

といったものもあります。
ほとんどのケースにおいてこのキャパシティで必要十分かと思います。
特に注意を払うとしたら、APIで各オブジェクトに対し検索を行う場合、

認証トークン1つにつき1秒あたり4つのリクエストまで

といった制限があります。
外部リソースからHubspotAPIで情報を反映させようとする際などに、
検索×ループ
検索を行うプログラムが2つ以上平行して走っている
といったような開発設計にした際、
そういった設計をなるべく避ける方法を考える and/or これに引っ掛かる可能性があることを前提とした設計にするよう気を付けましょう。

また、さらにマニアックな話になりますが、例えばイベントや商品項目など、全件取得や検索などがAPIでしかできないようなオブジェクトにアクセスする際にどうしてもAPIアクセス数を増やしがちかと思います。
各カテゴリーのAPIには一回のアクセスで10件まで一遍にCRUDできるBatchコマンドが用意されていますので、なるべくそれらを使うようにしましょう。

あえてもう一つ付け加えると、外部連携の際に大きな落とし穴があるのですが、それはHubspotのCRMオブジェクトで起こるマージです。
例えばStripeやFreee
といった外部ツールの顧客情報とHubspotを連携しようとする場合、HubspotとStripeやFreeeの顧客情報は1対1でないといけないのですが、Hubspotでマージをすると、この関係が崩れて
外部リソース2:Hubspot1
になってしまいます。
せめてもこれが更新日時に反映されたり、Webhookなどで検知できればいいのですが、執筆時点でも残念ながらそういったリソースは公開されていません。


 

まとめ

皆さんがHubspot上でやられているほとんどの業務が、実は自動化(少なくとも半自動化)が可能であったりします。
それらの自動化は、単純な事務経費削減やスケールした際の対応力をもたらすだけでなく、人手入力によるエラーが0になることによってデータの信頼性を高めたり、顧客に圧倒的なスピードでサービスを提供できるという価値の創造を担います。

 

Hubspotをはじめ様々な自社のビジネスプロセスを自動化したい、興味・関心はあってもどう導入したらよいかお困りである、といったような場合はぜひNADJAまでお問い合わせください。

弊社ではAPI連携にMake(旧:Integromat)を導入することによって圧倒的なスピードと柔軟性で開発ニーズにお応えします。


早速問い合わせてみる

Similar posts

メールマガジンに登録して最新の情報をゲットしよう。