更新日時 2023年 3月 21日
HubSpot APIキーを使用すると、開発者はHubSpotのAPIを使用してカスタムアプリケーションを作成できます。各キーは、個別のユーザーではなくHubSpotアカウントに固有であり、同時に使用できるキーは1つのみです。
注：2022年11月30日以降、HubSpot APIキーは廃止され、サポートされなくなります。代わりに、非公開アプリのアクセストークンまたはOAuthを使用して認証する必要があります。この変更の詳細と、非公開アプリを使用するようにAPIキーを移行する方法をご確認ください。
ご使用のアカウントで、APIキーの無効化に関するバナーが表示される場合は、次のようにします。
- 影響を受ける全ての連携が移行済みであることを確認してから、APIキーを無効化します。
- 過去7日間にアカウントのAPIキーが使用されたかどうかを確認するには、APIキーの呼び出しログ履歴を表示します。呼び出しログには、8日以上前にキーを使用して行われた要求は表示されません。
- アカウント設定の［接続されたアプリ］ページにリストされているアプリは、OAuthで認証されるため、移行する必要はありません。
- 開発者APIキーは、標準のHubSpot APIキーとは別のものであり、非推奨になることはありません。開発者APIキーは、Webhook APIサブスクリプションやタイムラインイベントAPIイベントタイプなど、HubSpotアプリに関連する設定を管理するために使用されます。
APIキーにアクセスする
アカウントのAPIキーにアクセスするには、スーパー管理者権限が必要です。
- HubSpotアカウントにて、ナビゲーションバーに表示される［設定アイコン ］をクリックします。
- 左のサイドバーメニューで、［連携］>［APIキー］の順に進みます。
- アカウントのキーが生成されていない場合は、［APIキーを生成］をクリックします。
- APIキーを生成済みの場合は、［表示］をクリックします。
- キーが表示されたら、［コピー］をクリックしてキーをコピーします。そのキーを貼り付けて、開発者に提供したり、自分の連携機能で使用したりできます。
APIキーのローテーション
APIキーを渡された開発者は、HubSpotのAPIを介してアカウントを変更するフルアクセス権を持つことになり、接続されたEメールアカウントから記録済みEメールを読み取ったり、他のサード パーティー データを読み取ったりできます。
セキュリティーを強化するには、6か月ごとにHubSpot APIキーをローテーションさせることを検討してください。HubSpot APIキーのローテーションを行うと、既存のAPIキーが無効になり新しいものが生成されます。HubSpot上にAPIキーの経過期間が表示され、APIキーのローテーションは必要な時期になると推奨されます。
APIキーが180日間にわたってローテーションされていない場合は、スーパー管理者と、APIキーを最後に作成またはローテーションしたユーザーに、やはり180日に一度Eメール通知が送信されます。
これによりダウンタイムが生じて余分な作業が必要になるかもしれませんが、悪意のあるアプリケーションが既存のAPIキーを使ってHubSpot情報にアクセスすることを防止でき、セキュリティーレイヤーが追加されます。
HubSpot APIキーをローテーションするには、次のようにします。
- HubSpotアカウントで、メイン ナビゲーション バーにある設定アイコンをクリックします。
- 左のサイドバーメニューで、［連携］>［APIキー］の順に進みます。
- ［アクション］ドロップダウンメニューをクリックし、［キーを変更（ローテーション）］を選択します。
- ［今すぐこのキーを変更（ローテーション）して期限切れにする］をクリックします。reCAPTCHAのチェックボックスをオンにします。既存のキーは無効になり、新しいAPIキーが作成されます。
- ［コピー］をクリックし、アプリケーションで使用されている無効化済みのAPIキーをこの新しいAPIキーに置き換えます。
無効化したHubSpot APIキーでは、API呼び出しが失敗するようになり、アプリケーションが情報にアクセスできなくなります。
APIキーをローテーションしても、Salesforce連携との接続に影響はありません。ただし、カスタム統合がインストールされている場合は、ローテーション後にAPIキーを更新する必要があります。
注：APIキーをローテーションしても、アプリマーケットプレイスを通してインストールされた接続済みアプリは影響を受けません。
APIキーを無効にする
APIキーを無効にしても、新しいキーは作成されません。無効化されたHubSpot APIキーを使用するAPI呼び出しが失敗するようになり、このキーを使用するアプリケーションは情報にアクセスできなくなります。
APIキーを無効にするには、次のようにします。- HubSpotアカウントにて、ナビゲーションバーに表示される［設定アイコン ］をクリックします。
- 左のサイドバーメニューで、［連携］>［APIキー］の順に進みます。
- ［アクション］ドロップダウンメニューをクリックします。
- ［キーを無効化］をクリックして、［今すぐこのキーを無効化する］をクリックします。reCAPTCHAのチェックボックスをオンにします。
API監査ログを表示する
［ログを監査］セクションで、アカウントのAPIキーを閲覧、作成、または無効化した日付のログを表示できます。
- HubSpotアカウントにて、ナビゲーションバーに表示される［設定アイコン ］をクリックします。
- 左のサイドバーメニューで、［連携］>［APIキー］の順に進みます。
- ［監査ログ］タブをクリックします。
APIキーの呼び出しログを表示する
いずれかの連携をデバッグしたり、HubSpotのAPI使用ガイドラインに従っていることを確認したりする際には、過去7日間のAPIキー呼び出しのログを表示できます。
- HubSpotアカウントにて、ナビゲーションバーに表示される［設定アイコン ］をクリックします。
- 左のサイドバーメニューで、［連携］>［APIキー］の順に進みます。
- ［コールログ］タブで、過去7日間の全てのアクティビティーを表示します。
