非公開アプリ

​

非公開アプリを作成する

• HubSpotアカウントにて、メイン ナビゲーション バーの設定アイコンをクリックします。
• 左のサイドバーメニューで［連携］＞［非公開アプリ］の順に進みます。
• ［非公開アプリを作成］をクリックします。
• ［基本情報］タブでアプリの詳細を設定します。
  • アプリの名前を入力します。
  • 名前プレースホルダーロゴにカーソルを合わせ、表示されたアップロードアイコンをクリックして、アプリのロゴとして使用する正方形の画像をアップロードします。
  • アプリの説明を入力します。
• ［スコープ］タブをクリックします。
• ページ上部の［新しいスコープを追加］をクリックします。
• 右側のパネルで、非公開アプリがアクセスできるように設定する各スコープのチェックボックスをオンにします。
  • ［スコープを検索］検索バーを使用して、特定のスコープを探すこともできます。使用可能なスコープを網羅したリストは、こちらのリファレンス記事でご確認いただけます。
  • スコープの追加が完了したら、［更新］をクリックします。アプリに追加のスコープが必要であると後で判断した場合は、アプリの作成後にスコープを構成することもできます。

• アプリに対して選択したスコープを確認します。アプリに必要ないと判断したスコープは、スコープ名の横の［削除］をクリックして削除できます。［選択されたスコープの概要］をクリックすると、アプリのスコープの詳細と各スコープに付与されている関連アクセス権も表示できます。

• アカウント内のCRMオブジェクトに対する変更によってトリガーされるイベントを受信するには、非公開アプリのWebhook配信登録を設定します。
  • ページ上部の［Webhook］タブをクリックします。
  • ［ターゲットURL］に、イベントがトリガーされたときにHubSpotでPOSTリクエストを送信する宛先のURLを入力します。
  • ［配信登録を作成］をクリックします。
  • 右側のパネルで、配信登録するオブジェクトタイプを選択し、HubSpotによる設定したエンドポイントへのリクエスト送信をトリガーするこれらのオブジェクトに関連付けられているイベント（作成、マージ、削除など）を選択します。
  • 選択したオブジェクトタイプに追加の未承認のスコープが必要な場合は、それらのスコープをアプリに追加するように求められます。
  • イベントタイプとして［プロパティーの変更］を選択した場合は、変更を配信登録する関連オブジェクトプロパティーを選択できます。
  • ［配信登録］をクリックします。

• Webhook配信登録をすぐに有効にしたくない場合、または誤って作成した配信登録を削除する場合は、Webhookの上にカーソルを置いて、そのステータスを管理するか、配信解除して削除するか、配信登録の詳細を確認することができます。非公開アプリでのWebhook配信登録の使用方法については、こちらの記事をご参照ください。

• アプリの設定が完了したら、右上の［アプリを作成］をクリックします。
• ダイアログボックスで、アプリのアクセストークンの情報を確認してから、［作成を続行］をクリックします。

​

アプリのアクセストークンでAPI呼び出しを行う

• HubSpotアカウントにて、メイン ナビゲーション バーの設定アイコンをクリックします。
• 左のサイドバーメニューで［連携］＞［非公開アプリ］の順に進みます。
• アプリの名前をクリックします。
• ［認証］タブで［トークンを表示］をクリックして、アクセストークンを表示します**。**［コピー］をクリックして、トークンをクリップボードにコピーします。

• アクセストークンを貼り付けて、開発者に提供したり、ご自身でアプリを開発する際に使用したりできます。HubSpot APIエンドポイントに対して呼び出しを行う際には、「Authorization」フィールドに**「Bearer [YOUR_TOKEN]」**という値を設定します。例えば、Node.jsとaxiosを使用してコンタクトAPIの呼び出しを行う場合、リクエストは以下のようになります。

axios.get(
  'https://api.hubapi.com/crm/v3/objects/contacts',
  {
    headers: {
      Authorization: `Bearer ${YOUR_TOKEN}`,
      'Content-Type': 'application/json',
    },
  },
  (err, data) => {
    // Handle the API response
  }
);

• 非公開アプリのアクセストークンはOAuthを基盤として実装されているため、HubSpotのクライアントライブラリーを使用して、アクセストークンによる認証済みの呼び出しを行うこともできます。例えば、Node.jsクライアントライブラリーを使用する場合は、アプリのアクセストークンを渡すことにより、OAuthクライアントをインスタンス化できます。

const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN });

​

非公開アプリのアクセストークン情報を表示する

// POST request response body
{
  "tokenKey": {{accessToken}}
}

// Example response for GET request to /oauth/v2/private-apps/get/access-token-info
{
  "userId": 123456,
  "hubId": 1020304,
  "appId": 2011410,
  "scopes": ["oauth", "crm.schemas.companies.write"]
}

​

アクセストークンをローテーションする

• HubSpotアカウントにて、メイン ナビゲーション バーの［設定］ページをクリックします。
• ［連携］＞［非公開アプリ］の順に進みます。
• 非公開アプリの名前をクリックします。
• アクセストークンの横にある［変更（ローテーション）］をクリックします。
  • トークンが侵害され、直ちにアクセスを取り消す場合は、［今すぐこのトークンを変更（ローテーション）して期限切れにする］をクリックします。
  • 特に侵害が生じていなくても、トークンは6か月ごとに変更することが推奨されます。トークンを定期的に変更する準備ができている場合は、［後でこのトークンを変更（ローテーション）して期限切れにする］をクリックします。これにより、7日後にトークンが失効します。
    • アプリを早く移行する準備ができている場合は、［今すぐ期限切れにする］をクリックします。
    • もっと時間が必要だと判断した場合は、［変更（ローテーション）をキャンセル］をクリックし、元のトークンの失効を取り消して、新しいアクセストークンを無効にすることができます。

• スーパー管理者がローテーションを開始したとき（今すぐ実行する場合、または7日後に実行する場合）。
• スーパー管理者が保留中のローテーションをキャンセルしたとき。
• スーパー管理者が、トークンの有効期限が切れるまで7日待つのではなく、［今すぐ期限切れにする］をクリックして、アクセストークンをすぐに失効させることを選択したとき。
• アプリのアクセストークンが24時間後に期限切れになるとき。
• 7日間が経過し、アプリのアクセストークンがローテーションされて期限切れになったとき。
• アクセストークンを180日以上ローテーションしていないときにも、スーパー管理者にアプリのアクセストークンをローテーションするリマインダーメールが届きます。

​

API呼び出しログを表示する

• アプリの詳細ページで［ログ］タブをクリックします。
• 非公開アプリのAPI呼び出しの確認と絞り込みを行うには、以下の操作を行います。
  • ［メソッド］または［レスポンス］ドロップダウンメニューをクリックして、リクエストメソッドまたはレスポンスコードでAPI呼び出しの履歴を絞り込みます。
  • ［開始日］または［終了日］ドロップダウンメニューをクリックして、特定の期間でAPI呼び出しログを絞り込みます。
  • ［リクエストURLで検索］検索ボックスで、URLを指定して特定の呼び出しを検索することもできます。

• API呼び出しログをエクスポートするには、［ログをエクスポート（CSV）］をクリックします。次に、日付範囲（最長で過去30日まで）を指定し、［エクスポート］をクリックします。
• ポップアップボックスで、エクスポートするAPI呼び出しの日付範囲を選択し、［エクスポート］をクリックします。エクスポートが完了すると、ダウンロードリンクが記載されたEメールが届きます。

​

非公開アプリに関する制限

​

非公開アプリを削除する

• HubSpotアカウントにて、メイン ナビゲーション バーの設定アイコンをクリックします。
• 非公開アプリの名前をクリックします。
• ページ上部の［認証］タブをクリックします。
• ページの最下部に表示される［[アプリ名]を削除］をクリックします。
• ダイアログボックスにアプリの名前を入力して削除を確認し、［削除］をクリックします。