Jeton daccès hubspot

Comment obtenir la clé API HubSpot ? Comment obtenir le jeton d’accès Hubspot ? Comment actualiser le jeton d’accès ?

Bonjour, vous vous demandez comment vous pouvez configurer l’API HubSpot ? L’obtention d’un jeton d’accès, d’un jeton d’actualisation, d’un identifiant client et d’une clé secrète client à partir de HubSpot est-il complexe ? Comment utiliser le jeton d’accès HubSpot pour les appels d’API ? Comment actualiser le jeton d’accès à l’aide du jeton d’actualisation ?

Toutes les questions et doutes trouveront leur réponse dans cet article. Ne vous inquiétez pas, cet article vous aidera à comprendre le processus et sera là avec vous pendant que vous générez toutes les informations d’identification dont vous avez besoin pour utiliser l’API HubSpot.

Plongeons dans le vif du sujet .

Qu’est-ce que l’API Hubspot ?

L’API HubSpot est conçue pour vous permettre de créer rapidement et facilement une application fonctionnelle ou une intégration. HubSpot doit couvrir presque tous les besoins possibles des clients et des développeurs.

Toutes les API HubSpot sont organisées autour de – si vous avez déjà une certaine expérience avec une API REST (également connue sous le nom d’API RESTful). C’est super! De nombreux concepts utilisés et discutés dans cet article vous seront familiers.

Tous les appels d’API à HubSpot doivent être effectués vers le domaine de base https://api.hubapi.com à l’aide de certaines méthodes courantes (, , , ). JSON sera renvoyé dans toutes les réponses, y compris les erreurs.

Puisque nous avons une idée approximative de ce qu’est l’API HubSpot. Il est maintenant temps de comprendre quelles sont les exigences avant d’utiliser l’API HubSpot ? Comment pouvons-nous obtenir l’API Hubspot ? L’API HubSpot peut être utilisée par deux modes d’authentification/autorisation :

Clés API Authentification
Oauth Authentification

La

génération de clés API est l’un des processus les plus simples, il suffit de suivre les étapes ci-dessous.

1. Aéroport Obtenir la clé API du compte HubSpot

Connectez-vous à votre . Cliquez sur « Paramètres ».

Faites défiler vers le bas et cliquez sur « Intégration » > « Clé API ».

Et voilà, vous devez maintenant voir la clé HubSpot sur votre écran. Notez cette clé Hubs[to API dans le fichier JSON ou le bloc-notes pour l’instant. N’oubliez pas que l’API HubSpot est valable 6 mois.

Remarque : Si vous ne pouvez pas voir l’étiquette/les boutons mentionnés ci-dessus. Il est possible que vous ayez besoin d’avoir à votre compte.

deux. Tester la clé API Hubspot – Appel d’API de contact Hubspot à l’aide de la clé API

Créez un fichier python nommé « sample.py » .

# !/usr/bin/python3 #Command pour exécuter le code : python3 ./sample.py les demandes d’importation importent json import urllib #Define une variable avec la clé API Hubspot. hsapikey = « remplacez-la par la clé API de votre compte HubSpot » #set le nombre, le nombre de contacts que vous souhaitez extraire. count = 1 #API url pour effectuer l’appel api_url = « https://api.hubapi.com/contacts/v1/lists/all/contacts/all?hapikey="+str(hsapikey)+"&count="+str(count) #header le garder vide pour l’instant headers = {} #make a request res = requests.get(url= api_url, headers = headers) response_dict = json.loads(res.text) print(« \n response_dict : »,response_dict)

Après avoir exécuté le code ci-dessus, si l’appel d’API réussit. Vous devriez voir un résultat au format JSON imprimé sur la console. Cela vous donnera quelques détails sur un contact.

Ce qui devrait ressembler à quelque chose comme sous les données JSON.

response_dict : {'contacts' : [{'addedAt' : 154*******, 'vid' : 1, 'canonical-vid' : 1, 'merged-vids' : [], 'portal-id' : 54***00, 'is-contact' : True, 'profile-token' : 'AO_T-mOry2mmtYmBOhCtvj3bRimYtKXWkE4ORaPRaAWHVVwKlVDVy******...', 'profile-url' : 'https ://app.hubspot.com/contacts/54***00/contact/1', 'properties' : {'firstname' : {'value' : 'cool'}, 'lastmodifieddate' : {'value' : '15*******812'}, 'company' : {'value' : 'HubSpot'}, 'lastname' : {'value' : 'robot (exemple de contact)'}}, 'form-submissions' : [], ' identity-profiles' : [{'vid' : 1, 'saved-at-timestamp' : 1549725367650, 'deleted-changed-timestamp' : 0, 'identities' : [{'type' : 'EMAIL', 'value' : '[email protected]', 'timestamp' : 1549725367540, 'is-primary' : True}, {'type' : 'LEAD_GUID', 'value' : '91ec18a2**********', 'timestamp' : 1549725367646}]}], 'merge-audits' : []}], 'has-more' : True, 'vid-offset' : 1}

Authentification OAuth

1. Créer un développeur Compte et application Hubspot

Accédez à et créez un nouveau compte développeur. Si vous en avez déjà un, vous pouvez également l’utiliser. Une fois que vous êtes configuré et connecté, vous commencerez sur la page d’accueil du compte développeur, où vous aurez la possibilité de créer votre première application ou . Cliquez sur « Créer une application » .

REMARQUE : Vous pouvez créer jusqu’à 100 applications par compte développeur.

Ensuite, vous allez remplir quelques informations et paramètres de base pour votre application. Lorsque les utilisateurs authentifient votre application avec leur compte HubSpot, ils voient le nom, la description, le logo et les coordonnées de l’assistance que vous fournissez sur cette page.

Dans l’onglet suivant, vous trouverez vos paramètres d’authentification, y compris l’ID client et la clé secrète client . C’est également ici que vous allez configurer les étendues de votre application. Vous en aurez besoin les informations permettant d’initier une connexion OAuth entre votre application et HubSpot.

deux. Obtenir le code d’authentification

Pour initier l’accès OAuth, vous devez rediriger les utilisateurs HubSpot vers votre URL d’autorisation. Utilisez les paramètres de requête détaillés ci-dessous pour identifier votre application et décrire ses étendues requises aux utilisateurs qui arrivent sur la page d’autorisation.

Les utilisateurs doivent être connectés à HubSpot pour accorder l’accès à leur application. Tout utilisateur qui n’est pas connecté à HubSpot sera redirigé vers un écran de connexion avant d’être redirigé vers la page d’autorisation.

L’écran d’autorisation affiche les détails de votre application et les autorisations demandées (en fonction des étendues que vous incluez dans l’URL). Les utilisateurs auront la possibilité de sélectionner l’ID de la centrale pour le compte auquel ils souhaitent accorder l’accès.

Une fois que l’utilisateur a accordé l’accès, il sera redirigé vers le redirect_uri. Un paramètre de requête de code sera ajouté à l’URL, que vous utiliserez pour obtenir un jeton d’accès de HubSpot.

POST URL : https://app.hubspot.com/oauth/authorize
Data :client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https ://www.example.com/

L’URL doit ressembler à celle ci-dessous. Exécutez ce code dans votre navigateur (pour info : j’ai utilisé Chrome) et suivez les étapes pour accorder l’accès.

https://app.hubspot.com/oauth/authorize?client_id=<remplacez-le par votre ID client d’application>&redirect_uri=http ://localhost :8090/&scope=contacts

Vous devriez être redirigé vers la page de connexion de HubSpot.

Une fois le processus terminé, vous devez voir « code= » dans l’URL. Vous trouverez ci-dessous les exemple pour donner une idée de ce à quoi cela va ressembler -> code=beeb6fee-639c-4b82-8d8e-cbd0ff7b628b

3. Générer le jeton d’accès et le jeton d’actualisation HubSpot

Utilisez le code que vous obtenez une fois qu’un utilisateur a autorisé votre application à obtenir 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. N’oubliez pas que les jetons d’accès expirent au bout de six heures, vous pouvez donc utiliser le jeton d’actualisation pour obtenir un nouveau jeton d’accès à l’expiration du premier jeton d’accès.

URL POST :https ://api.hubapi.com/oauth/v1/token
En-têtes :Type-de-contenu : application/x-www-form-urlencoded ; jeu de caractères=utf-8
Données :grant_type=authorization_code&client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&client_secret=yyy-yyyy-y-yy&redirect_uri=https ://www.example.com/&code=zzzzzz-zzzz-zzzz-zzzz

L’URL doit ressembler à ceci. Exécutez ce code avec les méthodes post dans postman.

https://api.hubapi.com/oauth/v1/token?grant_type=authorization_code&client_id=<remplacer par l’ID du client>&client_secret=<Remplacer par le secret du client>&redirect_uri=http ://localhost :8090/&code=<remplacer par le code>

En cas de succès, vous recevrez une réponse JSON avec les tokens : { « access_token » : « xxxx », « refresh_token » : « yyy-y », « expires_in » : 21600 } S’il y a des problèmes avec la requête, Vous recevrez une réponse 400 avec un message d’erreur. { « status » : « EXAMPLE_ERROR_CODE », « message » : « Un message d’erreur lisible par l’homme », « correlationId » : « da1e1d2f-fa6b-472a-be7b-7ab9b9605d59 », « requestId » : « ecc0b50659814f7ca37f5d49cdf9cbd3 » }

4. Comment rafraîchir le jeton d’accès ?

Utilisez un jeton d’actualisation précédemment obtenu pour générer un nouveau jeton d’accès. Si vous avez besoin d’un accès hors ligne aux données HubSpot, stockez le jeton d’actualisation que vous obtenez lors du lancement de votre intégration OAuth et utilisez-le pour générer un nouveau jeton d’accès une fois que le premier a expiré.

URL POST : https://api.hubapi.com/oauth/v1/token
En-têtes : Content-Type : application/x-www-form-urlencoded ; charset=utf-8
Données :grant_type=refresh_token&client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxxxxx&client_secret=yyy-yyyy-y-y&refresh_token=zzzzzz-zzzz-zzzz

L’URL doit ressembler à ceci. Exécutez ce code avec les méthodes post dans postman.

https://api.hubapi.com/oauth/v1/token?grant_type=refresh_token&client_id=<Remplacer par client_id>&client_secret=<Remplacer par le secret client>&refresh_token=<Remplacer par le jeton de rafraîchissement>&redirect_uri=http ://localhost :8090/

En cas de succès, vous recevrez une réponse JSON avec un nouveau access_token : { « access_token » : « xxxx », « refresh_token » : « zzzzzz-zzzz-zzzz-zzzz-zz », « expires_in » : 21600 } S’il y a des problèmes avec la demande, vous recevrez une réponse 400 avec un message d’erreur. { « status » : « EXAMPLE_ERROR_CODE », « message » : « Un message d’erreur lisible par l’homme », « correlationId » : « da1e1d2f-fa6b-472a-be7b-7ab9b9605d59 », « requestId » : « ecc0b50659814f7ca37f5d49cdf9cbd3 » }

Hourra ! vous avez généré toutes les références nécessaire pour réussir un appel d’API Hubspot.

5. Planche à billets Testez le jeton d’accès en effectuant l’appel d’API de contact HubSpot

Passons maintenant à notre premier appel d’API à l’aide du jeton d’accès Hubspot via le processus d’authentification OAuth. En plongeant dans le vif du sujet, nous allons comprendre le code python pour l’appel d’API Hubspot à l’aide du jeton d’accès Hubspot. J’ai nommé ci-dessous le fichier python sample_oauth.py , vous pouvez le nommer comme vous le souhaitez.

# !/usr/bin/python3 #Command pour exécuter le code : python3 ./sample.py les demandes d’importation importent json import urllib #Define une variable avec la clé API Hubspot. access_token = « remplacez ceci par un jeton d’accès » #set le compte, le nombre de contacts que vous souhaitez extraire. count = 10 #API url pour faire l’appel api_url = « https://api.hubapi.com/contacts/v1/lists/14/contacts/recent?count="+str(count) #header le garder vide pour l’instant headers = {"Authorization » : « Porteur » +access_token} #make une requête res = requests.get(url = api_url, headers = headers) response_dict = json.loads(res.text) print(« \n response_dict : »,response_dict)

Après l’exécution réussie du code ci-dessus, vous voyez une sortie JSON pour 10 contacts. Où chaque donnée de contact ressemblera à l’image ci-dessous.

response_dict : {'contacts' : [{'addedAt' : 154*******, 'vid' : 1, 'canonical-vid' : 1, 'merged-vids' : [], 'portal-id' : 54***00, 'is-contact' : True, 'profile-token' : 'AO_T-mOry2mmtYmBOhCtvj3bRimYtKXWkE4ORaPRaAWHVVwKlVDVy******...', 'profile-url' : 'https ://app.hubspot.com/contacts/54***00/contact/1', 'properties' : {'firstname' : {'value' : 'cool'}, 'lastmodifieddate' : {'value' : '15*******812'}, 'company' : {'value' : 'HubSpot'}, 'lastname' : {'value' : 'robot (exemple de contact)'}}, 'form-submissions' : [], 'identity-profiles' : [{'vid' : 1, 'saved-at-timestamp' : 1549725367650, 'deleted-changed-timestamp' : 0, 'identities' : [{'type' : 'EMAIL', 'value' : '[email protected]', 'timestamp' : 1549725367540, 'is-primary' : True}, {'type' : 'LEAD_GUID', 'value' : '91ec18a2**********', 'timestamp' : 1549725367646}]}], 'merge-audits' : []}], 'has-more' : True, 'vid-offset' : 1}

vous avez correctement configuré et obtenu les identifiants nécessaires pour effectuer un appel d’API HubSpot. Vous pouvez vous référer au code python pour obtenir le guide des données de contact HubSpot afin d’apprendre à utiliser les informations d’identification ci-dessus. Le guide ABove vous aidera également à développer un code Python complet pour extraire des données de HubSpot à l’aide de l’API HubSpot, avec une structuration de code appropriée.

Consultez mon autre guide d’intégration d’API

Partager cet article : sur Twitter, sur Facebook, sur Google+sur LinkedIn