非公開アプリ
非公開アプリ(Private App)では、HubSpotのAPIを使用して、HubSpotアカウント上の特定のデータにアクセスできます。非公開アプリで何をリクエストまたは変更できるかは、アカウント側で非公開アプリごとに管理できます。権限が付与されると、そのアプリ専用のアクセストークンが生成されます。
HubSpotアカウント内で非公開アプリにアクセスするには、スーパー管理者権限が必要です。
注:非公開アプリでは、拡張機能、カスタム タイムライン イベント、Webhookはサポートされません。こうした機能を使用するアプリの作成を検討している場合は、公開アプリを作成する必要があります。
非公開アプリと公開アプリの違い
非公開アプリと公開アプリはどちらも、HubspotのAPIを使用して構築する連携です。主な違いは、HubSpotアカウントの認証方式と、単一のアカウントに関連付けられるかどうかという点です。
- 単一のアカウントにのみインストールできます。
- APIキーではなく、HubSpot上で設定するアクセストークンを認証に使用します。
- 複数のアカウントにインストールできます。
- アプリマーケットプレイスに掲載できます。
- 開発者が設定するOAuthを認証に使用します。
- Webhookなどの高度な連携機能を利用できます。
詳しくは非公開アプリと公開アプリの違い(英語)をご覧ください。
- HubSpotアカウントにて、メインのナビゲーションバーに表示される設定アイコンをクリックします。
- 左のサイドバーメニューで、[連携]>[非公開アプリ]の順に進みます。
- [非公開アプリを作成]をクリックします。
- [基本情報]タブで、アプリの詳細を設定します。
- アプリの名前を入力します。
- プレースホルダーロゴの上にカーソルを合わせると表示されるアップロードアイコンをクリックして、アプリのロゴとして使用する正方形の画像をアップロードします。
- アプリの説明を入力します。
- [スコープ]タブをクリックします。
- 非公開アプリがアクセスできるように設定するスコープごとに、[読み取り]または[書き込み]チェックボックスをオンにします。[スコープを検索]検索バーを使用して、特定のスコープを検索することもできます。
- アプリの設定が完了したら、右上の[アプリを作成]をクリックします。
- ダイアログボックスで、アプリのアクセストークンの情報を確認してから、[作成を続行]をクリックします。
アプリの作成が完了したら、アプリのアクセストークンを使用して、API呼び出しを開始できます。アプリの情報を編集したりアプリのスコープを変更したりする必要がある場合は、[詳細を編集]をクリックします。
API呼び出しを開始するには、アプリの詳細ページを開きます。
- [アクセストークン]カード内の[トークンを表示]をクリックして、アクセストークンを表示します。[コピー]をクリックして、トークンをクリップボードにコピーします。
- 非公開アプリのアクセストークンはOAuthを基盤として実装されているため、HubSpotのクライアントライブラリーを使用して、アクセストークンによる認証済みの呼び出しを行うこともできます。例えば、Node.jsクライアントライブラリー(英語)を使用する場合は、アプリのアクセストークンを渡すことにより、OAuthクライアントをインスタンス化できます。
アクセストークンが分からなくなった場合や侵害された場合は、トークンをローテーション(変更)できます。新しいアクセストークンが作成され、元のアクセストークンは失効します。
- HubSpotアカウントにて、メインのナビゲーションバーに表示される設定アイコンをクリックします。
- [連携]>[非公開アプリ]の順に進みます。
- 非公開アプリの名前をクリックします。
- アクセストークンの横にある[変更(ローテーション)]をクリックします。
- トークンが侵害され、直ちにアクセスを取り消す場合は、[今すぐこのトークンを変更(ローテーション)して期限切れにする]をクリックします。
- 特に侵害が生じていなくても、トークンは6か月ごとに変更することが推奨されます。トークンを定期的に変更する準備ができている場合は、[後でこのトークンを変更(ローテーション)して期限切れにする]をクリックします。これにより、7日後にトークンが失効します。
- アプリを早く移行する準備ができている場合は、[今すぐ期限切れにする]をクリックします。
- もっと時間が必要だと判断した場合は、[変更(ローテーション)をキャンセル]をクリックし、元のトークンの失効を取り消して、新しいアクセストークンを無効にすることができます。
アプリによる過去30日間のAPI呼び出しを確認するには、以下の手順に従います。
- アプリの詳細ページで、[ログ]タブをクリックします。
- 非公開アプリのAPI呼び出しの確認および絞り込みを行うには、以下の手順に従います。
- [メソッド]または[レスポンス]ドロップダウンメニューをクリックして、リクエストメソッドまたはレスポンスコードでAPI呼び出しの履歴を絞り込みます。
- [開始日]または[終了日]ドロップダウンメニューをクリックして、特定の期間でAPI呼び出しログを絞り込みます。
- [リクエストURLで検索]検索ボックスで、URLを指定して特定の呼び出しを検索することもできます。
HubSpotアカウント1件につき、最大20件の非公開アプリを作成できます。各非公開アプリには、HubSpotのAPI利用ガイドラインが適用されます。非公開アプリから実行できる呼び出しの回数は、アカウントのご契約内容とAPI追加オプションのご購入状況に基づきます。
製品のエディション | 10秒当たり | 1日当たり | |
---|---|---|---|
非公開アプリ |
(全ての製品の) 無料ツール、Starter |
非公開アプリ1件につき100回 | アカウント1件につき250,000回 |
(全ての製品の) Professional、Enterprise |
非公開アプリ1件につき150回 | アカウント1件につき500,000回 | |
非公開アプリ(API追加オプション購入時) |
(全ての製品の) 無料ツール、Starter、Professional、Enterprise |
非公開アプリ1件につき200回 | アカウント1件につき1,000,000回 |
非公開アプリのアクセストークンに関する情報(Hub IDや、トークンに関連付けられているスコープなど)を表示するには、/oauth/v2/private-apps/get/access-token-info
にPOST
リクエストを送信します。リクエスト本文にアクセストークンを含めます。
レスポンスには、トークンを作成したユーザー、アカウントのHub ID、非公開アプリのID、トークンに関連付けられているスコープに関する情報が格納されています。