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

HubSpotのアプリは、顧客アカウント上にインストールできる、またはアプリマーケットプレイスに掲載される連携機能です。OAuthによる認証が必須になっています。ユーザーがアプリをHubSpotアカウントにインストールしたら、そのアカウントに対してOAuthアクセストークンを使用したAPI呼び出しを行えるようになります。さらにアカウントの[接続されたアプリ]ページにもアプリが表示され([設定]>[連携]>[接続されたアプリ])、ユーザーによる管理やアンインストールが可能になります。

連携による一部の機能はアプリでのみ利用可能で、1対1の連携では使用できません。例えば、Webhookを使用して変更を受信したり、カスタムのタイムラインイベントおよびCRMカードを作成したりできるのは、インストールされるアプリだけです。必須ではありませんが、Ecommerce Bridge(eコマースブリッジ)においてもアプリが強く推奨されます。

アプリの作成

HubSpotでアプリを作成する場合は作成したアプリを開発者アカウントに関連付けます。セットアップとサインインが完了したら、開発者アカウントのホームページを開き、最初のアプリを作成したり、テストアカウントを作成したりできます。[アプリを作成]をクリックします。

 

1-dev_landing_dash-1

[アプリ]ダッシュボードから[アプリを作成]ボタンを使用して始めることもできます。

2-app_dash_first_app

1. 基本情報

次に、アプリの基本情報と設定を記入します。ユーザーがそれぞれのHubSpotアカウントで貴社のアプリを認証した際には、このページに記入した名前、説明、ロゴ、サポート連絡先情報がユーザーに示されます。 

3-new_app_setup

2. 認証設定

次のタブに、クライアントIDとクライアントシークレットを含む認証設定が表示されます。ここでアプリのスコープを設定することもできます。この情報は、アプリとHubSpotの間でOAuth接続を開始するために必要になります。

4-app_auth_settings

3. スコープ

新しいスコープをアプリに追加するには、ページの下部にあるドロップダウンをクリックします。必要なスコープは認証URLのscope=パラメーターに含める必要があります。含めていない場合、アプリ認証時にユーザーに対してエラーが表示されます。認証URLの作成とスコープの使用の詳細は、OAuthのドキュメントを参照してください。

app_scopes

4. リダイレクトURL

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


アプリのインストール

アプリのインストール前

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

アプリのインストール方法

アプリのインストール作業は、認証とトークン生成の2つのステップに分けることができます。 

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

HubSpotアカウント上でアプリを認証するには、認証URLを作成する必要があります。そのためには、アプリのクライアントIDを取得し、OAuthプロセスを開始します。

URLの準備ができたら、ブラウザーでそれを開きます。該当するすべてのHubSpotアカウントのリストが表示されます(このURLをユーザーに案内した場合にも同様の画面が表示されます)。アプリをインストールするアカウントを選択します。

select_account-1

アカウントの選択後、認証URLに指定した&scopes=パラメーターと&optional_scope=パラメーターに基づくスコープのリストが表示されます。注:optional_scopeを含めていても、選択したアカウントにアクセス権が付与されていない場合(CRMのみのアカウントに対するコンテンツスコープなど)は、リストに表示されません。接続を認証するには、[アクセス権を付与]ボタンをクリックします。

7-approve_scopes-1

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

2. 認証中に提供された認証コードを使用して、初回のOAuthトークンを生成する

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

 

アプリのインストール後

アプリを認証し、初回のトークンを生成したら、インストールは完了です。[接続されたアプリ]ページ([設定]>[連携]>[接続されたアプリ])に表示され、WebhookCRMカードフェッチリクエストを受け始めることになります。

8-connected_apps-1


関連ドキュメント

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

テストアカウント

アプリの掲載