トークンの管理
OAuth 2.0のアクセストークンとリフレッシュトークンを取得する:
アクセストークンとリフレッシュトークンを取得するには、ユーザーによるアプリ認証後に取得できるコードを使用します。アクセストークンは、アプリが発行するリクエストの認証に使用します。アクセストークンの利用は短時間です。利用可能な秒数は、アクセストークンを生成したときにexpires_in
パラメーターで確認できます。最初のアクセストークンの有効期限が切れるときにリフレッシュ トークン エンドポイントを使用して、最新のアクセストークンを取得できます。
新しいアクセストークンの生成には、以前に取得済みのリフレッシュトークンを使用します。HubSpotデータへのオフラインアクセスが必要な場合は、OAuth連携の初期化時に取得したリフレッシュトークンを保存しておき、最初のアクセストークンの有効期限が切れた時点で新しいアクセストークンを生成する際に使用します。
注:HubSpotのアクセストークンのサイズは、エンコードされる情報量の変化に応じて変動します。トークンのサイズには余裕を持って、最大300文字分確保することをお勧めします。
OAuth 2.0のアクセストークンまたはリフレッシュトークンに関する情報を取得する:
アクセストークンまたはリフレッシュトークンのメタデータを取得します。トークンが作成されたHubSpotユーザーのEメールアドレスと、トークンが関連付けられているHub IDを取得する際に使用します。
OAuth 2.0リフレッシュトークンを削除する:
リフレッシュトークンを削除します。特定のユーザーがアプリをアンインストールする場合のリフレッシュトークンの削除に使用します。
注:この処理で削除されるのはリフレッシュトークンのみです。リフレッシュトークンを利用して生成されたアクセストークンは影響を受けません。さらに、HubSpotアカウント上からアプリがアンインストールされるわけではありません。また、アカウントと接続アプリの間のデータ同期も停止されません。
OAuth 2.0アクセストークンの使用:
// Authorization:Bearer {token}
curl --request GET \
--url 'https://api.hubapi.com/crm/v3/objects/contacts?limit=10&archived=false' \
--header 'authorization:Bearer CJSP5qf1KhICAQEYs-gDIIGOBii1hQIyGQAf3xBKmlwHjX7OIpuIFEavB2-qYAGQsF4'
{contacts: .....}
この例では、次の部分がアクセストークンに該当します。
CJSP5qf1KhICAQEYs-gDIIGOBii1hQIyGQAf3xBKmlwHjX7OIpuIFEavB2-qYAGQsF4
注:OAuth 2.0アクセストークンを使用する場合は、リクエストURLにhapikey=
を含めないでください。このクエリーパラメーターの代わりとして、認証ヘッダーを使用します。