アプリ開発の概要

アプリとは、HubSpotのユーザーや別のHubSpotアカウントと共有する機能がパッケージ化されたものです。カスタムCRMカードタイムラインイベントWebhookなどの機能を使用してアプリを開発することもできます。HubSpotには、アプリンの開発や連携に役立つ数多くのツールが用意されています。この記事では、アプリ開発のコンポーネントの詳細について説明します。 

アカウント

アプリ開発者アカウントとテストアカウントは互いに関連しますが、その用途は異なります。

  • 開発者アカウントでは、アプリを開発して掲載できます。
  • テストアカウントでは、実際のHubSpotアカウントのデータに影響を及ぼすことなく、作成中のアプリのテストを実施できます。このアカウントは、標準のHubSpotアカウント内で作成できるサンドボックスアカウントとは別のものです。

HubSpotのアカウントタイプについて詳しくは、こちら(英語)をご覧ください。

認証

1つのHubSpotアカウントとのカスタム連携を開発する場合は、非公開アプリを作成し、そのアクセストークンを使用してAPI呼び出しを認証するか、APIキー(英語)を使用することができます。複数のHubSpotアカウントでインストールされるように設計されたアプリ、またはアプリマーケットプレイスに掲載されるアプリでは、OAuthを使用する必要があります。

2022年11月30日以降、HubSpot APIキーをHubSpot APIにアクセスするための認証方法として使用することはできなくなります。また、2022年7月15日以降は、HubSpot APIキーが未生成のアカウントで、APIキーを作成することができなくなります。

その代わりとして、非公開アプリのアクセストークンまたはOAuthを使用して、API呼び出しの認証を行う必要があります。この変更の詳細(英語)と、非公開アプリを使用するためにAPIキーを移行する方法(英語)をご確認ください。

Webhookに登録したい場合、あるいはアプリのOAuthを設定したい場合は、開発者アカウントを作成する必要があります。開発者アカウントでは、アプリマーケットプレイスにアプリを掲載することや、テストアカウントを作成(英語)することもできます。

開発者アカウントAPIキー

APIを介してアプリの設定を管理するには、開発者APIキーを使用できます。Webhook APIの登録を管理したり、タイムラインイベント機能の対象とするイベントを作成、更新したりできます。

開発者APIキーは、API呼び出しによってアプリの設定を更新する場合にのみ使用可能です。その他すべてのAPI呼び出しには、非公開アプリのアクセストークン、またはOAuthの使用が必要です。

次の手順で、アプリ開発者アカウントのAPIキーにアクセスできます。

  • アプリ開発者アカウントで、上部のナビゲーションバーにある[アプリ]に移動します。
  • 右上の[HubSpot APIキーを取得]をクリックします。
  • 表示されるダイアログボックスで[キーを表示]をクリックします。キーが表示されたら、キーの横にある[コピー]をクリックします。
  • 以前のAPIキーを無効にして、新しいキーを生成する場合は、[キーの再生成]をクリックします。

show_dev_api_key

App ID

アプリの開発中は、次の2か所でアプリIDを確認できます。 

  • 開発者アカウントの[アプリ]ダッシュボードに表示されるアプリ名の下
Screen Shot 2020-01-15 at 2
  • アプリの認証設定

app_auth_id_settings

 

Monitoring app behavior

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

このリクエストのログは、次の手順で表示できます。

  • アプリ開発者アカウントで、メインのナビゲーションバーにある[アプリ]に移動します。
  • アプリの名前をクリックします。
  • 左のサイドバーメニューで[モニタリング]に移動します。 

app_monitoring

  • タブを使用して、さまざまなタイプのアプリに対するリクエストやアプリからのリクエストを表示できます。これらのログが表示された状態で、個々のリクエストをクリックすると、そのリクエストに関する次の詳細情報が表示されます。
    • 成功したリクエストについては、リクエストのメソッド、パス、リクエストが行われた時間が表示されます。
    • 失敗したリクエストについては、応答ヘッダーや本文などの追加のエラー情報が表示されます。

request_details

[モニタリング]ページの各タブについて詳しくは、以下をご確認ください。

API呼び出し

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

api_calls_monitoring-1

Webhook

Webhookタブには、アプリのWebhookサブスクリプションに関するHubSpotのリクエストが表示されます。レスポンス(タイムアウトや接続失敗など)、ステータス(成功、再試行、失敗)、サブスクリプションタイプ、期間、試行、バッチ、イベント、またはアカウントIDで絞り込むことができます。

Please note: the attempt ID is a combination of the subscriptionId, eventId, and attemptNumber from a specific request.

webhook_monitoring

CRM拡張機能

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

Delete a developer account

インストール数があるアプリがない場合やマーケットプレイスに掲載されているアプリがアプリ開発者アカウントにない場合は、そのアプリ開発者アカウントを削除できます。インストール数があるアプリ、またはマーケットプレイスに掲載されているアプリがあるアカウントを削除する場合は、サポートまでご連絡ください。

一旦削除したアカウントには、アクセスできなくなります。複数のHubSpotアカウントを切り替えて使用している場合は、削除済みのアカウントが表示されなくなります。

HubSpot API開発者アカウントで、右上のアカウント名をクリックし、[アカウント]をクリックします。

アカウント

[アカウントを削除]をクリックします。インストール数があるアプリ、またはマーケットプレイスに掲載されているアプリがアカウントにある場合、このボタンは無効化されます。

Account2

ダイアログボックスで、アカウントIDを入力してから、[開発者アカウントを削除]をクリックします

Confirm2

 

関連ドキュメント

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

開発者アカウントを作成

テストアカウントを作成(英語)

HubSpotサンドボックスアカウント(ベータ版)を設定