Ressources recommandées
- Le Guide de démarrage rapide pour OAuth vous offrira davantage d’informations avec un exemple d’application.
- Ce tutoriel HubSpot Academy propose une présentation rapide quant à l’utilisation de OAuth avec HubSpot, y compris une répartition du flux HubSpot-OAuth et des explications sur l’actualisation d’un jeton d’accès.
Configurer l’authentification OAuth
Pour configurer l’authentification OAuth pour votre application :- Tout d’abord, créez une application dans un compte de développeur HubSpot. Après avoir créé l’application, vous trouverez l’ID du client et le secret client pour votre application sur la page d’authentification de vos paramètres d’application.

- Utilisez l’ID du client et le secret client ainsi que les paramètres de requête et les domaines décrits ci-dessous pour créer votre URL d’autorisation.
-
Envoyez les utilisateurs qui installent votre application vers l’URL d’autorisation, où ils verront un écran qui leur permettra de sélectionner un compte et d’autoriser l’accès à votre intégration. Vous pouvez définir l’URL d’autorisation comme étant destinée à un compte HubSpot spécifique en ajoutant l’ID du compte entre
/oauth/et/authorize, comme indiqué ci-dessous. Après avoir autorisé l’accès, ils seront redirigés vers votre application via unredirect_url, qui sera associé à un paramètre de requête de code. Vous utiliserez ce code et le secret client pour obtenir un access_token et un refresh_token depuis HubSpot.- Exemples d’URL d’autorisation
- Tout compte :
https://app.hubspot.com/oauth/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/ - Compte spécifique (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/
- Tout compte :
- Exemple d’URL de redirection :
https://example.com/?code=xxxx - Exemple d’erreur :
https://www.example.com/?error=error_code&error_description=Human%20readable%20description%20of%20the%20error
- Exemples d’URL d’autorisation
-
Utilisez le
access_tokenpour authentifier tous les appels d’API effectués pour ce compte HubSpot. -
Une fois que
access_tokenexpire, utilisezrefresh_tokenpour générer un nouveauaccess_token.
Paramètres de requête
Les paramètres de requêtes suivants sont obligatoires lors de la création d’une URL d’autorisation pour votre compte :
Les paramètres suivants sont facultatifs :
Configurer des domaines
OAuth exige que vous définissiez des domaines, ou des autorisations, pour votre application. Chaque domaine fournit un accès à un ensemble de points de terminaison d’API HubSpot et permet aux utilisateurs d’accorder à votre application l’accès à des outils spécifiques dans leur compte HubSpot.
optional_scope pour inclure des domaines de travail. Ainsi, les clients utilisant uniquement des comptes HubSpot gratuits peuvent toujours autoriser votre application, même s’ils ne peuvent pas accéder à tous ses domaines. Votre application doit vérifier et traiter tous les domaines pour lesquels elle ne reçoit pas d’autorisation.
La liste complète des domaines d’application est disponible ici.