開発者ツールとアカウント

HubSpotには、アプリまたは連携を実現するための数多くのツールが用意されています。まず開発者アカウントを作成します*。この開発者アカウントから、アプリの作成、アプリマーケットプレイスへのアプリ掲載テストアカウントの作成を行うことができます。

*特定の1つのアカウント向けにAPIキーを使用してカスタム連携を開発する場合は、開発者アカウントが不要なケースもあります。しかし、テストアカウントを作成できるのは開発者アカウント内に限られます。HubSpot上の実データに影響を与えることなく連携をテストするためには、テストアカウントを作成するとよいかもしれません。


HubSpotでアプリを活用する目的は?

配信とセキュリティー:

アプリは、HubSpotユーザー(または特定のHubSpotアカウント)に提供する機能がパッケージ化されたものと見なすことができます。OAuthでのアプリ認証により、このパッケージは連携を接続しているユーザーにとって安全な状態に保たれます。

API要件:

HubSpot上でアプリを提供するためには、CRMカードタイムラインイベント、およびWebhook機能を使用する必要があります。必須ではありませんが、Ecommerce Bridge(eコマースブリッジ)を強くお勧めします。


開発者アカウントとテストアカウントの関係は?

開発者アカウントとテストアカウントは関連がありますが、用途は異なります。開発者アカウントではアプリを開発して掲載ができます。テストアカウント*では、実際のHubSpotアカウントのデータに影響を及ぼすことなく、作成中のアプリのテストを実行できます。テストアカウントは90日で失効しますが、手動で更新でき、OAuth呼び出しの時点で自動更新されます。テストアカウントは、開発者アカウントでのみ作成および管理できます。したがって、開発者アカウントが前提になります。 

*開発者アカウントにつき最大10件のテストアカウントを作成できます。


開発者アカウントAPIキー

開発者APIキーは、API経由でHubSpotアプリ設定を管理するために使用します。Webhook APIのサブスクリプション管理、タイムラインイベント機能のためのイベントタイプの作成または更新、Ecommerce Bridgeの設定の更新などに使用します。

前述のように開発者APIキーは、API呼び出しによりアプリの設定を更新するためにのみ使用できます。その他のAPI呼び出しはすべて、アカウントの固有のAPIキー(開発者APIキーとは異なります)を使用して、またはOAuth接続を通じて行う必要があります。

開発者APIキーを取得するには、開発者アカウントのアプリダッシュボード上部にある[HubSpot APIキーを取得]ボタンをクリックします。

1-get_dev_api_key-1

これにより、モーダルダイアログが開き、開発者APIキーとユーザーIDが表示されます(セキュリティー強化のため、[キーを表示]のクリックが必要です)。

開発者APIキーが漏えいした場合は無効にし、[キーの再生成]ボタンを使用して新たに生成することができます。

2-show_dev_api_key


アプリID

アプリIDは、次の2か所にあります。

開発者アカウントのアプリダッシュボード、アプリ名の下:

3-Apps-dashboard-app-idまたはアプリの認証設定:

4-app_auth_id_settings


アプリ動作のモニタリング

HubSpotでは、OAuthのアクセストークンを使用した受信リクエストやWebhookまたはCRMカードの発信リクエストを含め、接続されているアプリとの間でやり取りするリクエストがすべて記録されます。 

 

アプリ モニタリング ツール:

このリクエストログを表示するには、アプリの設定ページに移動し、左のサイドバーの[モニタリング]をクリックします。リクエストのタイプごとに独自のセクションがあり、ドロップダウンメニューのオプションを使用して絞り込むことができます。

5-app_monitoring

リクエストの詳細:

個々のリクエストをクリックして、その詳細情報を確認します。成功したリクエストについては基本情報のみが表示されますが、エラーの場合はさらに詳細が表示されます。 

6-request_details

API呼び出し:

API呼び出しログには、OAuthアクセストークンを使用してアプリに対して行われたすべてのリクエストが表示されます。HTTPメソッド、レスポンスコード、期間、またはリクエストURLで絞り込むことができます。

7-api_calls_monitoring-1

Webhook:

Webhookタブには、アプリのWebhookサブスクリプションに関するHubSpotのリクエストが表示されます。レスポンス(タイムアウトや接続失敗など)、ステータス(成功、再試行、失敗)、サブスクリプションタイプ、期間、試行、イベント、アカウントIDによって絞り込みます。注:試行IDは、特定のリクエストのsubscriptionIdeventId、およびattemptNumberを組み合わせたものです。

8-webhook_monitoring

CRM拡張機能:

アプリのCRMカードに関するHubSpotのリクエストは、[CRM拡張機能]タブにあります。拡張オブジェクトタイプ、CRMオブジェクトタイプ(コンタクト、会社、チケット、または取引)、エラーまたは警告のタイプ、期間、リクエストID、またはCRMオブジェクトID(特定のコンタクトID)で絞り込みます。

9-crm_extension_monitoring-1


関連ドキュメント

アプリの作成とインストール

開発者アカウントを作成

テストアカウントを作成