参考資料
- OAuthクイックスタートガイドで紹介されているサンプルアプリは、OAuthの利用をできるだけ短時間で開始することを意図して設計されており、全ての手順を実際にご利用いただけます。
- HubSpotアカデミーのコースでは、HubSpotでOAuthを使い始める方法を短時間で習得できます。HubSpot-OAuthフローの詳細や、アクセストークンの更新方法を説明しています。
OAuth認証の設定
アプリのOAuth認証を設定するには、次の手順に従います。- まず、HubSpot開発者アカウントでアプリを作成します。アプリを作成すると、アプリ設定の[認証]ページで作成したアプリのクライアントIDとクライアントシークレットを確認できるようになります。_ _

- 下記のように、クライアントIDとクライアントシークレット、およびクエリーパラメーターとスコープを使用して、認証URLを作成します。
-
アプリをインストールするユーザーを認証URLに誘導し、ユーザーがアカウントを選択する画面を表示して、連携機能へのアクセスを許可できるようにします。以下に示すように、
/oauth/と/authorizeの間にアカウントIDを追加することで、特定のHubSpotアカウント用の認証URLを設定できます。アクセス権が付与されると、コードクエリーパラメーターが付加されたredirect_urlによってユーザーがアプリにリダイレクトされます。このコードとクライアントシークレットを使用して、HubSpotからaccess_tokenとrefresh_tokenを取得します。- 認証URLの例
- 任意のアカウント:
https://app.hubspot.com/oauth/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/ - 特定のアカウント(ID 123456):
https://app.hubspot.com/oauth/123456/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/
- 任意のアカウント:
- リダイレクトURLの例:
https://example.com/?code=xxxx - エラーの例:
https://www.example.com/?error=error_code&error_description=Human%20readable%20description%20of%20the%20error
- 認証URLの例
-
access_tokenを使用して、当該HubSpotアカウントに対して行われたAPI呼び出しを認証します。 -
access_tokenの有効期限が切れたら、refresh_tokenを使用して新しいaccess_tokenを生成します。
クエリーパラメーター
アプリの認証URLを作成する際には、以下のクエリーパラメーターが必須です。
以下のパラメーターは任意で指定できます。
スコープの設定
OAuthでは、アプリに対するスコープ(権限)を設定する必要があります。各スコープによって、一連のHubSpot APIエンドポイントへのアクセス権が与えられます。また、アプリによるHubSpotアカウント上の特定のツールへのアクセスを、ユーザーが許可できるようになります。
optional_scopeパラメーターを使用して、対応するあらゆるティアのスコープを含めることができます。これにより、HubSpotの無料アカウントを使用しているお客さまも、全てのスコープにはアクセスできなくても、アプリを認証できるようになります。認証されていない全てのスコープについては、アプリ側で確認および処理する必要があります。
スコープの完全なリストはこちらのページで確認できます。