アプリ開発の概要

アプリを使用することで、HubSpotアカウントへのAPI呼び出しを認証したり、Webhookを使ってイベントを通知したり、カスタムカードなどでHubSpot UIを拡張したりできます。HubSpotは、連携のニーズに応じて数種類のアプリと拡張機能を提供しています。このページでは、HubSpotで開発できるアプリと拡張機能の種類、その開発を開始する方法、開発したアプリや拡張機能をHubSpotで管理する方法について詳しくご紹介します。

アプリの種類

どんな種類の連携機能を構築しようとしているかに応じて、適切な種類のアプリを選択する必要があります。以下では、開発できるアプリの種類とそれらがサポートする機能について詳しく説明します。

拡張機能の開発については、以下の参照表で、どのような種類のアプリでどのような拡張機能を開発できるかの概要をご確認いただけます。

非公開アプリ

非公開アプリは、1つのHubSpotアカウント用に作成することができ、1回限りのスクリプトや単一目的の拡張機能に最適です。例えば、次のような目的でHubSpotアカウント用の非公開アプリを開発できます。

  • APIを介して新しいカスタムオブジェクトを作成する。
  • CSVファイルからCRMレコードをインポートする。
  • カスタム自動化アクションとチャットボットでAPI要求を認証する。
  • Webhookサブスクリプションを作成および編集します。

一般的に、非公開アプリの実装は公開アプリよりも単純です。非公開アプリはアクセストークンで認証され、HubSpot App Marketplaceには掲載不可です。どのようなときに非公開アプリを開発するかの詳細については、ブログ記事(英語)をご覧ください。

この種類のアプリがニーズに合っている場合は、HubSpotアカウントで非公開アプリを作成することができます。

プロジェクト内の非公開アプリ(ベータ版)

プロジェクトで非公開アプリを開発すると、CRMレコード用のUI拡張機能を作成できます。この手法で非公開アプリを開発する場合の違いは、プロジェクト外の非公開アプリでは作成できないUI拡張機能の作成だけがプロジェクトでサポートされることです。

この種類のアプリがニーズに合っている場合は、プロジェクトのクイックスタートガイド(英語)を確認し、CLIを使用してプライベートアプリとプロジェクトを作成してください。

公開アプリ

公開アプリは複数のアカウントにインストール可能です。非公開アプリで開発できるような拡張機能に加えて、公開アプリでは次のような高度な機能がサポートされます。

  • Webhooks APIを使用してアカウント全体のイベントを通知する。  
  • タイムラインイベントAPIを使用して、CRMレコードでカスタム タイムライン イベントを作成する。 
  • HubSpotでカスタムアプリ設定ページを作成する。 

公開アプリはOAuthで認証され、HubSpot App Marketplaceに掲載可能になります。どのような場合に公開アプリを開発するかの詳細については、ブログ記事(英語)をご覧ください。

この種類のアプリがニーズに合っている場合は、アプリ開発者アカウントで公開アプリを作成することができます。

サポートされる拡張機能(アプリの種類別)

アプリの種類 サポートされる拡張機能
非公開アプリ
公開アプリ
プロジェクトで開発された非公開アプリ(ベータ版)
*公開アプリで開発できるCRMカードは、プロジェクトでUI拡張機能として作成できるカスタムカード(ベータ版)とは異なります。UI拡張機能には、一層高度な機能とカスタマイズ可能なコンポーネントがあります。

アプリ開発のためのアカウントの種類

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

  • アプリ開発者アカウントは、アプリを開発し、アプリマーケットプレイスに掲載するために使用します。
  • テストアカウントは、実際のHubSpotアカウントのデータに影響を与えずに、開発したAPIやアプリをテストするために使用します。このアカウントは、標準のHubSpotアカウント内で作成できるサンドボックスアカウントとは別のものです。

HubSpotのアカウントタイプに関する詳細は、こちらのページをご確認ください。

認証

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

注:2022年11月30日をもってHubSpot APIキーは廃止され、サポートも終了しています。HubSpot APIキーの使用を続けると、アカウントやデータに対するセキュリティー上のリスクが生じます。なお、HubSpotによってこの廃止段階中にお客さまのキーが無効となった可能性があります。

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

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

開発者アカウントAPIキー

APIを介してアプリの設定を管理するには、開発者APIキーを使用できます。このAPIキーは、非推奨の標準APIキーとは別のものです。開発者APIキーを使用すると、Webhooks APIの登録を管理したり、タイムラインイベント機能用のイベントタイプを作成、更新したりできます。その他全てのAPI呼び出しは、非公開アプリのアクセストークンまたはOAuthを使用して行う必要があります。

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

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

show_dev_api_key

Delete a developer account

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

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

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

アカウント

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

Account2

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

Confirm2

 


参考になりましたか?
こちらのフォームではドキュメントに関するご意見をご提供ください。HubSpotがご提供しているヘルプはこちらでご確認ください。