API アクセストークンはどうやって発行するのでしょうか

[takuma1]

pythonにて、

hubspotのアクセストークンを発行、使用するにはどこから行えば良いのでしょうか。

[WendyGoh · Accepted solution]

Hey @takuma1, 

追加の質問に対応できて嬉しいです。

リダイレクトURLに関してですが、まず明確にしておきたいのは、ここで設定したURLはあなたのチームに委ねられているということです。 

あなたのチームは以下のいずれかを行う必要があります。

1. 外部ページを作成する 

ｏｒｒ 

2. ハブスポットのページ

*サーバーレス機能の利用

ここで、ページはHubSpot OAuth 2.0サーバーが送信するGETリクエストを処理できるようにする必要があります。 

例えば、リダイレクトURLがxxx.com/oauth-callbackの場合、ページはHubSpotがリダイレクトURLに送信する?code=xxパラメータを受信する関数を実装する必要があります。 

この関数は次のようになります。

app.get('/oauth-callback', async (req, res) => {
  if (req.query.code) {
    // Handle the received code
  }
});

インストールURL（リダイレクトURLとは異なります）は、こちらの開発者アプリからコピーすることができます。

このURLは、このページに記載されているアプリの資格情報、リダイレクトURL、およびスコープの設定に基づいて生成されます。

---

はい、すべてのAPIがドキュメント化されています - 此処 はHubSpotがサポートしています。 

[littlehelp · Accepted solution]

@takuma1 さん

こちらのサンプルコードを参考にされてみてはいかがでしょう。HubSpotアクセストークン発行の一通りの流れが分かります。

https://github.com/HubSpot/oauth-quickstart-nodejs

[WendyGoh · Accepted solution]

Hey @takuma1, 

追加の質問に対応できて嬉しいです。

リダイレクトURLに関してですが、まず明確にしておきたいのは、ここで設定したURLはあなたのチームに委ねられているということです。 

あなたのチームは以下のいずれかを行う必要があります。

1. 外部ページを作成する 

ｏｒｒ 

2. ハブスポットのページ

*サーバーレス機能の利用

ここで、ページはHubSpot OAuth 2.0サーバーが送信するGETリクエストを処理できるようにする必要があります。 

例えば、リダイレクトURLがxxx.com/oauth-callbackの場合、ページはHubSpotがリダイレクトURLに送信する?code=xxパラメータを受信する関数を実装する必要があります。 

この関数は次のようになります。

app.get('/oauth-callback', async (req, res) => {
  if (req.query.code) {
    // Handle the received code
  }
});

インストールURL（リダイレクトURLとは異なります）は、こちらの開発者アプリからコピーすることができます。

このURLは、このページに記載されているアプリの資格情報、リダイレクトURL、およびスコープの設定に基づいて生成されます。

---

はい、すべてのAPIがドキュメント化されています - 此処 はHubSpotがサポートしています。 

[takuma1]

ご対応ありがとうございます。

まだ、わからない点があるので追加で質問です。

>2. 開発者アプリを作成するには、開発者アカウントを作成する必要があるので、このドキュメント - https://developers.hubspot.com/docs/api/creating-an-app が最初のステップとなります。 

ご紹介いただいたドキュメントの

4. Redirect URL

以下の説明がわかりません。リダイレクトURLがわからないというのは、リダイレクトURLという言葉の意味がわからないのではありません。アプリ内の認証にある。インストールURLとリダイレクトURLの作成方法？がわかりません。ここのリダイレクトURLに入れるべき適切なURLはなんでしょうか？

>

4. リダイレクト URL は、要求されたスコープに対してアプリを承認した後にユーザーがリダイレクトする場所です。チーム側でこのページを作成し、このページで OAuth 2.0 サーバーのレスポンスを処理する必要があります。このドキュメントの詳細については、https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart を参照してください。

ご紹介いただいたドキュメント、

Step 1: Direct to HubSpot's OAuth 2.0 Server

以下の説明がわかりません。ページを作成するとはどういうことでしょうか？

>5. CRM API と通常の API とはどういう意味ですか？どの通常の API を参照していますか？参照しているAPIへのリンクを共有してもらえますか？

知識不足ですみません。

下記のドキュメントの左側に大量のAPIの種類があると思いますが、ここにあるのがhubspotの提供しているAPIの全てですか？

https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart

[WendyGoh]

Hey @takuma1,

全く心配ありません 🙂 

クエリーを一つずつ見ていきましょう。

1. 認証ベアラ（トークン）は、アクセストークンとしても知られています。最初のコメントで述べたように、開発者アプリをHubSpotポータルにインストールすると、アクセストークン(authorization bearer (token)としても知られています)とリフレッシュトークンの両方を受け取ることになります。 

2. 開発者アプリを作成するには、開発者アカウントを作成する必要があるので、このドキュメント - https://developers.hubspot.com/docs/api/creating-an-app が最初のステップとなります。 

3. あなたの言う通りです。各スコープはHubSpot APIのセットへのアクセスを提供します。例えば、`contacts`スコープは、アプリに以下のAPIへのアクセスを許可します。連絡先、会社、お得な情報、関連するプロパティAPI、エンゲージメントAPI、所有者APIへのアクセスを許可します。 

4. リダイレクト URL は、要求されたスコープに対してアプリを承認した後にユーザーがリダイレクトする場所です。チーム側でこのページを作成し、このページで OAuth 2.0 サーバーのレスポンスを処理する必要があります。このドキュメントの詳細については、https://legacydocs.hubspot.com/docs/methods/oauth2/oauth2-quickstart を参照してください。

5. CRM API と通常の API とはどういう意味ですか？どの通常の API を参照していますか？参照しているAPIへのリンクを共有してもらえますか？

[takuma1]

ご回答ありがとうございます。

現在、わからずに困っている箇所を列挙させていただきます。

・下記のドキュメントについて

https://developers.hubspot.com/docs/api/oauth/tokens

ご案内いただいだ、ドキュメントですが、

// Authorization: Bearer {token}

の tokenはどこで取得すればよいのでしょうか？

・下記のドキュメントについて

https://developers.hubspot.com/docs/api/creating-an-app

こちらの、ドキュメントが、ご案内いただいた大筋の流れを記載されているものと思います。

こちらの

3. Scopes

からの説明がよくわかりません。

Scopesはこのアプリ（auth認証？）でアクセスできる情報の権限を制限する設定でしょうか？

また、

4. Redirect URL

からの説明が全く持って不明です。

これはさらに、

https://developers.hubspot.com/docs/api/working-with-oauth

のドキュメントの話につながってくるかと思います。

こちらの

2. Use the client ID and client secret, along with the query parameters and scopes outlined below, to build your authorization URL. 

の説明がよくわかりません。

リダイレクトさせるべきURLはどのように作成するのでしょうか？

どのURLへリダイレクトさせれば良いのでしょうか？

・APIの違いについて

また、ドキュメントを拝見しているとCRMAPIと普通のAPIがあるようですが、

この２種類のAPIの違いは何なのでしょうか？

知識不足で、拙い質問ですが、ご回答いただけると幸いです。

[natsumimori]

@shizaki さん、以前API関連の投稿でナレッジを共有してくださっていたかと思うのですが、もしこちらのトピックについてもアドバイスや補足があればお願いします😇

[WendyGoh]

こんにちは @takuma1 さん

ユーザーがアプリを承認すると、アクセストークンとリフレッシュトークンの両方が取得できます。 アプリとは、HubSpot開発者アプリのことを指します - 詳しくはこちらをご覧ください。

簡単に言うと、まずHubSpot開発者アプリを作成する必要があります > アプリをHubSpotポータルにインストールする（認証が発生した時です） > アクセストークンとリフレッシュトークンの両方を受け取ることになります。

アクセストークンの有効期限は6時間後なので、最初のアクセストークンの有効期限が切れたときにリフレッシュトークンエンドポイントを使って新しいアクセストークンを取得することができます。このドキュメントの詳細はこちら。

この件でさらに何か質問があれば教えてください!