アプリの作成とインストール
HubSpotでは、顧客アカウントにインストールできる連携機能や、アプリマーケットプレイスに掲載された連携機能を「アプリ」と呼びます。アプリを使用するには、OAuthによる認証が必要です。ユーザーがアプリをHubSpotアカウントにインストールしたら、そのアカウントに対してOAuthアクセストークンを使用したAPI呼び出しを行えるようになります。アプリは、アカウントの[接続されたアプリ]設定にも表示されます。
接続されたアプリでは、Webhookを使用して変更を受信したり、カスタムのタイムラインイベントを作成したりすることもできます。
アプリを作成する
基本的に、HubSpotでアプリを作成すると、作成したアプリが開発者アカウントに関連付けられます。HubSpotアプリの作成を開始するには、次の手順に従ってください。
- アプリ開発者アカウントで、メインのナビゲーションバーにある[アプリ]に移動します。
- 右上の[アプリを作成]をクリックします。
- 次に、アプリの基本情報と設定を入力します。個々のユーザーがHubSpotアカウントでアプリを認証する際には、このページに記入された名前、説明、ロゴ、サポート連絡先情報がユーザーに表示されます。
※ここで指定したアプリ名は、HubSpotでアプリが表示される際に常に使用されます。アプリをインストールする際だけでなく、CRMカードとタイムラインイベントの「Powered by」フッターにも、このアプリ名が表示されます。
- [認証]タブをクリックして、クライアントIDとクライアントシークレット、およびアプリに割り当てられているスコープを表示します。この情報は、アプリとHubSpotの間でOAuth接続を開始(英語)する際に必要になります。
- [認証]タブで、ページの下部にある[スコープ]ドロップダウンメニューをクリックし、新しいスコープをアプリに追加します。必要なスコープは認証URLの
scope=
パラメーターに含める必要があります。含めていない場合、アプリ認証時にユーザーに対してエラーが表示されます。認証URLの作成とスコープの使用の詳細は、OAuthのドキュメントを参照してください。
- [リダイレクトURL]フィールドに注意してください。これは、HubSpotアカウントへのアクセス権をアプリに付与したユーザーに表示されるページです。リダイレクトURLがない場合、ユーザーに接続エラーが表示されます。localhost上のURLでない限り、リダイレクトURLではHTTPSを使用する必要があります。
アプリが作成されたら、インストール手順を開始できます。
アプリをインストールする
アプリのインストール手順は、権限付与とトークン生成の2つのステップに分けることができます。
※アプリをインストールする前に、次の点に留意してください。
- インストールしたアプリは、最初のアクセストークンとリフレッシュトークンが作成されるまでは、アカウントの[接続されたアプリ]ページに表示されません。
- アプリをインストールできるのは、アプリが必要とするスコープにアクセスできるユーザーに限られます。
- 開発者アカウントにはアプリをインストールできません。アプリをテストするには、アプリ開発者アカウントでテストアカウント(英語)を作成し、そのアカウントにアプリをインストールする必要があります。
顧客アカウントでアプリを認証する
- HubSpotアカウント上でアプリを認証するには、認証URLを作成する必要があります。そのためには、アプリのクライアントIDを取得し、OAuthプロセスを開始します。
- URLの準備ができたら、ブラウザーでそれを開きます。該当する全てのHubSpotアカウントのリストが表示されますこのURLにユーザーをリダイレクトする場合も、同様の画面が表示されます。
- アプリをインストールするアカウントを選択します。
- アカウントを選択すると、認証URLに設定した
&scopes=
パラメーターと&optional_scope=
パラメーターに基づくスコープのリストが表示されます。
注:optional_scope
を含めていても、選択したアカウントにアクセス権が付与されていない場合(CRMのみのアカウントに対するコンテンツスコープなど)は、リストに表示されません。
- [アクセス権を付与]をクリックして接続を承認します。
- アクセス権を付与すると、元の認証URLの
&redirect_uri=
パラメーターに基づくページが表示され、?code=
パラメーターがそのURLの末尾に付加されます。このコードを次のステップで使用して、アクセストークンを生成します。
初期OAuthトークンを生成する
リフレッシュトークンと初期アクセストークンを生成するには、認証URLの?code=
パラメーターのコード、redirect_url
、クライアントID、およびクライアントシークレットが必要です。詳細な手順については、こちらをご覧ください。
次のステップ
アプリを認証し、初回のトークンを生成したら、インストールは完了です。アプリが[接続されたアプリ]ページに表示され、WebhookおよびCRMカードのフェッチリクエストを受信するようになります。
関連コンテンツ
テストアカウント(英語)