HubSpot APIでCRUD操作を安全に実行できるようにするには、OAuthのアクセストークンとリフレッシュトークンを取得します。
client_id
、redirect_uri
、scopes
を含む)を使用して、アプリを自分のHubSpotアカウントにインストールできます。また、必要に応じてoptional_scopes
およびstate
を含めることもできます。
ユーザーがアプリを認証してアカウントにインストールした後、リダイレクトURLにcode
値が付加されます。これを使用してアクセストークンとリフレッシュトークンを生成できます。アクセストークンはアプリが発行するリクエストを認証するのに使用され、リフレッシュトークンは現在のアクセストークンが期限切れになったときに新しいものを取得するために使用されます。
詳しくは、アプリでOAuthを開始する方法をご確認ください。
POST
リクエストを/oauth/v1/token
に送信します。リクエスト本文では、client_id
やclient_secret
などのさまざまな認証パラメーターと、リダイレクトURLを通して返されるcode
を指定します。
ユーザーがアプリを認証した後、リダイレクトURLにcode
値が付加されます。このコードを使用して、初期アクセストークンとリフレッシュトークンを生成します。アクセストークンの存続期間は短時間です。アクセストークンの生成時にexpires_in
パラメーターを調べると、存続期間(秒数)を確認できます。
例えば、リクエストは次のようになります。
パラメーター | 型 | 説明 |
---|---|---|
grant_type | 文字列 | リクエストで初期アクセストークンとリフレッシュトークンを生成するには、authorization_code でなければなりません。 |
code | 文字列 | ユーザーがアプリをインストールした後にリダイレクトURLで返されるcode 。 |
redirect_uri | 文字列 | アプリで設定されたリダイレクトURL。 |
client_id | 文字列 | アプリのクライアントID。 |
client_secret | 文字列 | アプリのクライアントシークレット。 |
expires_in
フィールドは、アクセストークンの有効期間(秒)を指定します。
POST
リクエストを/oauth/v1/token
に送信することで、新しいアクセストークンを生成できます。リクエスト本文でgrant_type
、client_id
、client_secret
、refresh_token
を指定します。
パラメーター | 型 | 説明 |
---|---|---|
grant_type | 文字列 | リクエストでリフレッシュトークンから新しいアクセストークンを生成するには、refresh_token でなければなりません。 |
refresh_token | 文字列 | リフレッシュトークンの値。 |
client_id | 文字列 | アプリのクライアントID。 |
client_secret | 文字列 | アプリのクライアントシークレット。 |
GET
リクエストを/oauth/v1/access-tokens/{token}
に送信します。
ユーザーのアクセストークンとそのHubSpotアカウントに関する情報を含むレスポンスが届きます。
DELETE
リクエストを/oauth/v1/refresh-tokens/{token}
に送信してリフレッシュトークンを削除できます。この処理で削除されるのはリフレッシュトークンのみです。リフレッシュトークンを使って生成されたアクセストークンは、削除されません。また、これによってHubSpotアカウントからアプリケーションがアンインストールされたり、アプリとアカウントの間のデータ同期が妨げられたりすることはありません。