公開アプリ

HubSpotの公開アプリは、顧客アカウント上にインストールしたり、アプリマーケットプレイスに掲載したりできる連携機能です。OAuthによる認証を必要とします。ユーザーがアプリをHubSpotアカウントにインストールしたら、そのアカウントに対してOAuthアクセストークンを使用したAPI呼び出しを行えるようになります。アプリは、アカウントの設定画面にある[接続されたアプリ]にも表示されます。

また、接続されたアプリでは、Webhookを使用して変更を受信したり、カスタムのタイムラインイベントを作成したりすることもできます。 

このページでは、次の方法についてご紹介します。

公開アプリを作成する

HubSpotでアプリを作成する場合は作成したアプリを開発者アカウントに関連付けます。HubSpotアプリの作成を開始するには、次の手順で進めます。

  • アプリ開発者アカウントで、上部のナビゲーションバーにある[アプリ]に移動します。 
  • 右上の[アプリを作成]をクリックします。
  • 次に、アプリの基本情報と設定を入力します。このページに記入した名前、説明、ロゴ、問い合わせ先情報が、HubSpotアカウントで貴社のアプリを認証したユーザーに示されます。

注:アプリ名は、アプリがHubSpotユーザーに示される全ての場合に使用されます。CRMカードタイムラインイベントの「Powered by」フッターだけでなく、ユーザーがアプリをインストールする場面も含まれます。

  • [認証]タブをクリックして、クライアントIDとクライアントシークレット、およびアプリに割り当てられているスコープを表示します。この情報は、アプリとHubSpotの間でOAuth接続を開始する際に必要になります。
  • 新しいスコープをアプリに追加するには、[認証]タブで、ページの下部にある[スコープ]ドロップダウンメニューをクリックします。必要なスコープは認証URLのscope=パラメーターに含める必要があります。含めていない場合、アプリ認証時にユーザーに対してエラーが表示されます。認証URLの作成とスコープの使用の詳細は、OAuthのドキュメントを参照してください。

app_scopes

  • [リダイレクトURL]フィールドに注意してください。これは、HubSpotアカウントへのアクセス権をアプリに付与したユーザーに表示されるページです。リダイレクトURLがない場合、ユーザーに接続エラーが表示されます。localhost上を除き、リダイレクトURLにはHTTPSを使用する必要があります。

アプリが作成されたら、インストール手順を開始できます。

注:アプリに認証済みドメインを追加することで、アプリをインストールするユーザー向けに更なる信頼レベルを追加することをお勧めします。追加しない場合、アプリがまだ認証されていないことを示すバナーがアプリに表示されます。

アプリをインストールする

注:アプリをインストールする前に、次の点に留意してください。

  • インストールしたアプリは、最初のアクセストークンとリフレッシュトークンが作成されるまでは、アカウントの[接続されたアプリ]ページに表示されません。
  • アプリをインストールできるのは、アプリが必要とするスコープにアクセスできるユーザーに限られます。
  • 開発者アカウントにはアプリをインストールできません。アプリをテストするには、アプリ開発者アカウントでテストアカウントを作成し、そのアカウントにアプリをインストールする必要があります。

アプリのインストール手順は、権限付与とトークン生成の2つのステップに分けることができます。

顧客アカウントでアプリを認証する 

  • HubSpotアカウント上でアプリを認証するには、認証URLを作成する必要があります。そのためには、アプリのクライアントIDを取得し、OAuthプロセスを開始します。
  • URLの準備ができたら、ブラウザーでそれを開くと、該当する全てのHubSpotアカウントのリストが表示されるのを確認できます。このURLをユーザーに案内した場合にも同様の画面が表示されます。
  • アプリをインストールするアカウントを選択します。

select_account-1

  • アカウントを選択すると、認証URLに設定した&scope=パラメーターと&optional_scope=パラメーターに基づくスコープのリストが表示されます。

注:optional_scopeを含めていても、選択したアカウントにアクセス権が付与されていない場合(CRMのみのアカウントに対するコンテンツスコープなど)は、リストに表示されません。

  • 接続を認証するには、[アクセス権を付与]をクリックします。

approve_scopes-1

  • アクセス権を付与すると、元の認証URLの&redirect_uri=パラメーターに基づくページが表示され、?code=パラメーターがそのURLの末尾に付加されます。このコードを次のステップで使用して、アクセストークンを生成します。

初回のOAuthトークンを生成する 

リフレッシュトークンと初回アクセストークンを生成するには、認証URLの?code=パラメーターのコード、redirect_url、クライアントID、およびクライアントシークレットが必要です。詳しい手順は、こちらのページをご覧ください。 

アプリを認証し、初回のトークンを生成したら、インストールは完了です。アプリが[接続されたアプリ]ページに表示され、WebhookおよびCRMカードのフェッチリクエストを受信するようになります。

connected_apps-1

 

HubSpotで公開アプリを管理する

Find an app's ID

以下のいずれかの方法を使用して、アプリ開発者アカウントで公開アプリのIDを見つけることができます。

  • 開発者アカウントで、メイン ナビゲーション バーの[アプリ]に移動して、アプリの名前の下に記載されている「アプリID」を確認します。
find-app-id
  • 開発者アカウントで、メイン ナビゲーション バーの[アプリ]に移動して、アプリ名をクリックします。[基本情報]ページで[認証]タブをクリックして、「アプリID」を確認します。

find-app-id-auth-settings

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

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

このリクエストのログを表示するには、次のように進みます。

  • 開発者アカウントで、メイン ナビゲーション バーにある[アプリ]に移動します。
  • アプリ名をクリックします。
  • 左のサイドバーメニューで[モニタリング]に移動します。 
  • タブを切り替えることで、さまざまなタイプのアプリに対するリクエストやアプリからのリクエストを表示できます。これらのログが表示された状態で、個々のリクエストをクリックすると、そのリクエストに関する次の詳細情報が表示されます。
    • 成功したリクエストについては、リクエストのメソッド、パス、リクエストが行われた時間が表示されます。
    • 失敗したリクエストについては、応答ヘッダーや本文などの追加のエラー情報が表示されます。

request_details

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

  • API呼び出し:[API呼び出し]タブには、OAuthアクセストークンを使ってアプリに対して行われた全てのリクエストが表示されます。HTTPメソッド、レスポンスコード、期間、またはリクエストURLで絞り込むことができます。
  • Webhook:[Webhook]タブには、アプリのWebhook通知に関するHubSpotリクエストが表示されます。レスポンス(タイムアウトや接続失敗など)、ステータス(成功、再試行、失敗)、通知タイプ、期間、試行、バッチ、イベント、またはアカウントIDで絞り込むことができます。

注:試行IDは、特定のリクエストのsubscriptionIdeventId、およびattemptNumberを組み合わせたものです。

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

認証済みドメインを追加する

HubSpotユーザーがアプリをインストールするとき、自分のアカウントデータへのアクセスをアプリ開発者に付与することに同意しなければなりません。そのため、インストールを続けるかどうかユーザーが決定する上で、開発者の身元と評判はどちらも重要な役割を果たします。アプリのインストール時にユーザーによって完全に同意してもらえるように、HubSpotはアプリの認証レベルおよびアプリマーケットプレイス上の掲載を示すメッセージをアプリのインストール画面に次のように表示します。

  • アプリに認証済みドメインがない場合、HubSpotはアプリがまだ認証されていないことを示すバナーをインストール画面に表示します。
    not-verified
  • アプリに認証済みドメインが存在するものの、アプリマーケットプレイスに掲載されていない場合、HubSpotは認証済みドメインを表示するとともに、アプリがHubSpotによってレビューおよび認証されていないというバナーをインストール画面に表示します。verified-not-listed
  • アプリがHubSpotのアプリ審査プロセスに合格してマーケットプレイスに掲載されると、HubSpotは上記のバナーのどちらも表示しません。アプリが既にアプリマーケットプレイスに掲載されている場合は、ドメインを確認する必要はありません。
    verified-and-listed

認証済みドメインを追加する

認証済みドメインをアプリに追加するには、まずアプリの設定にドメインを追加し、次にドメインのDNS設定にTXTレコードを追加する必要があります。

  • アプリ開発者アカウントで、メイン ナビゲーション バーの[アプリ]に移動します。
  • アプリ名をクリックします。
  • 左側のサイドバーで、[コンタクトとサポート]に移動します。
  • [会社ドメイン]フィールドにドメインを入力して、[保存]をクリックします。[会社ドメイン]の下に、ドメインがまだ未確認であることを示すメッセージが表示されます。
  • [今すぐ確認]をクリックすると、確認プロセスが開始します。

domain-verification-for-app


  • 右側のパネルで、ドメインが正しく入力されていることを確認し、[次へ]をクリックします。
  • [値]列で[コピー]をクリックすると、必要なTXTレコード値がコピーされます。
    verify-app-domain-copy-value
  • DNSプロバイダーで、コピーされた値を使用してTXTレコードを作成します。いくつかの一般的なDNSプロバイダーでの手順を以下に示します。
  • DNS設定を更新したら、HubSpotに戻り、右側のパネルで[次へ]をクリックします。DNSレコードの更新には最大48時間かかる場合があるため、HubSpotは変更をすぐに認識できないかもしれません。[会社情報]設定ページから[今すぐ認証]を再び選択すると、いつでもこの画面に戻ることができます。
  • 認証が完了すると、[会社ドメイン]フィールドの下に成功ステータスインジケーターが表示されます。

Domain verified__export

追加のメモ

  • ドメインの継続的な所有を確かめる目的で、HubSpotはTXTレコードが存在することを定期的に確認し続けます。TXTレコードが除去または変更された場合、インストールの警告が再び表示されるようになります。
  • 現在、1つの開発者アカウントにつき1つの認証済みドメインしか持つことができません。アカウント内の全てのアプリは、認証済みドメインを共有します。インストールページ上のドメインはルートドメインにリンクされます。
  • 認証済みドメインを削除すると、開発者アカウント内の全てのアプリでインストール警告が再び表示されます。別のドメインを確認することはできますが、この処理には数時間かかります。

 


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