Lancement de l’accès OAuth
Après avoir créé votre application, un utilisateur peut l’installer dans son compte HubSpot en utilisant l’URL d’installation située dans les paramètres de l’application, qui inclura les élémentsclient_id, redirect_uri et scopes comme paramètres de requête. Vous pouvez également inclure optional_scopes et state, si nécessaire.
Une fois qu’un utilisateur autorise votre application et l’installe sur son compte, l’URL de redirection sera complétée par une valeur code, que vous pourrez utiliser pour générer un jeton d’accès et un jeton d’actualisation. Le jeton d’accès sera utilisé pour authentifier les demandes effectuées par votre application, tandis que le jeton d’actualisation sera utilisé pour obtenir un nouveau jeton d’accès à l’expiration du jeton actuel.
Découvrez-en davantage sur le lancement de OAuth pour votre application.
Générer l’accès initial et actualiser les jetons
Pour obtenir des jetons d’accès et d’actualisation OAuth, effectuez une requêtePOST à /oauth/v1/token en format form-urlencoded. Dans le corps de la requête, vous spécifierez divers paramètres d’authentification, tels que client_id et client_secret, ainsi que la propriété code renvoyée par l’URL de redirection.
Une fois qu’un utilisateur autorise votre application, l’URL de redirection sera complétée par une valeur code. En utilisant ce code, vous allez générer le jeton d’accès initial et le jeton d’actualisation. Les jetons d’accès ont une durée de vie courte et vous pouvez vérifier le paramètre expires_in lors de la génération d’un jeton d’accès pour déterminer sa durée de vie (en secondes).
Par exemple, votre requête peut ressembler aux éléments suivants :
| Paramètre | Type | Description |
|---|---|---|
grant_type | Chaîne | Doit correspondre à authorization_code pour la requête afin de générer l’accès initial et des jetons d’actualisation. |
code | Chaîne | Le code renvoyé dans l’URL de redirection après l’installation de l’application par l’utilisateur. |
redirect_uri | Chaîne | L’URL de redirection définie par l’application. |
client_id | Chaîne | L’ID client de l’application. |
client_secret | Chaîne | Le secret du client de l’application. |
expires_in spécifie la durée du jeton d’accès (en secondes).
Actualiser les jetons d’accès
En utilisant un jeton d’actualisation, vous pouvez générer un nouveau jeton d’accès en effectuant une requêtePOST à /oauth/v1/token en format form-urlencoded. Dans le corps de la demande, vous devrez spécifier indiquer les éléments grant_type, client_id, client_secret et refresh_token.
| Paramètre | Type | Description |
|---|---|---|
grant_type | Chaîne | Doit correspondre à refresh_token pour la requête afin de générer de nouveaux jetons d’accès à partir du jeton d’actualisation. |
refresh_token | Chaîne | La valeur du jeton d’actualisation. |
client_id | Chaîne | L’ID client de l’application. |
client_secret | Chaîne | Le secret du client de l’application. |
Récupérer les métadonnées du jeton d’accès
Pour obtenir des informations sur un jeton d’accès OAuth, y compris l’utilisateur pour lequel le jeton a été créé et son HubID correspondant, effectuez une requêteGET à /oauth/v1/access-tokens/{token}.
Vous recevrez une réponse contenant des informations sur le jeton d’accès de l’utilisateur et son compte HubSpot.
Supprimer un jeton d’actualisation
Si un utilisateur désinstalle votre application, vous pouvez supprimer le jeton d’actualisation en effectuant une requêteDELETE à /oauth/v1/refresh-tokens/{token}. Cela ne supprimera que le jeton d’actualisation. Les jetons d’accès générés avec le jeton d’actualisation ne seront pas supprimés. En outre, cela n’entraînera pas la désinstallation de l’application des comptes HubSpot et n’empêchera pas la synchronisation des données entre l’application et le compte.