Private apps

Les applications privées vous permettent d'utiliser les API de HubSpot afin d'accéder à des données spécifiques depuis votre compte HubSpot. Vous pouvez autoriser ce que chaque application privée peut demander ou modifier dans votre compte, ce qui générera un jeton d'accès unique pour votre application. 

Vous devez être un super administrateur pour accéder aux applications privées dans votre compte HubSpot.

Remarque : Les applications privées ne prennent pas en charge les événements de chronologie personnalisés. Les webhooks sont pris en charge dans les applications privées, mais les abonnements ne peuvent pas être modifiés par programmation via une API, mais plutôt dans les paramètres de votre application privée.

Si vous prévoyez de créer une application à l'aide d'événements de chronologie personnalisés, vous devrez créer une application publique à la place. Découvrez-en davantage sur les différences entre applications privées et publiques.

Créer une application privée

  • Dans votre compte HubSpot, cliquez sur l'icône Paramètres dans la barre de navigation principale.
  • Dans le menu latéral de gauche, accédez à Intégrations > Applications privées.
  • Cliquez sur Créer une application privée.
  • Dans l'onglet Informations de base, configurez les détails de votre application :
    • Saisissez le nom de votre application.
    • Passez le curseur de la souris sur le logo de variable et cliquez sur l'icône de téléchargement pour télécharger une image carrée qui servira de logo pour votre application.
    • Saisissez une description pour votre application.
  • Cliquez sur l'onglet Domaines.
  • Sélectionnez la case à cocher Lecture ou Écriture pour chaque domaine auquel vous souhaitez que votre application privée puisse accéder. Vous pouvez également rechercher un périmètre spécifique en utilisant la barre de recherche Trouver un domaine. Vous pouvez consulter une liste complète des domaines disponibles dans cet article de référence.
  • Lorsque vous avez terminé de configurer votre application, cliquez sur Créer une application dans l'angle supérieur droit.

updated-read-write-scope-config-private-apps

  • Dans la boîte de dialogue, vérifiez les informations sur le jeton d'accès de votre application, puis cliquez sur Continuer de créer.

Une fois votre application créée, vous pouvez commencer à passer des appels d'API à l'aide du jeton d'accès de l'application. Si vous devez modifier les informations de votre application ou en modifier les domaines, cliquez sur Modifier les détails.

edit-details-of-private-app

 

Passer des appels d'API avec le jeton d'accès de votre application

Remarque : Les applications privées perdront l'accès aux périmètres lorsque votre compte HubSpot sera déclassé et perdront l'accès aux fonctionnalités. Par exemple, si votre compte n'a pas accès à HubDB, votre application privée n'aura pas accès au périmètre HubDB.

Les jetons d'accès aux applications privées seront mis à jour pour refléter les périmètres disponibles dans votre compte HubSpot et ce que vous avez configuré pour l'application privée, mais la chaîne de jetons elle-même ne changera pas. 

Pour passer des appels d'API, accédez à la page de détails de votre application.

  • Sur la carte Jeton d'accès, cliquez sur Afficher le jeton pour afficher votre jeton d'accès. Cliquez sur Copier pour copier le jeton dans le presse-papiers.

show-private-app-access-token-1

  • Vous pouvez ensuite coller le jeton d'accès pour le fournir à vos développeurs ou l'utiliser dans le cadre du développement de votre application. Lorsque vous effectuez un appel vers l'un des points de terminaison de l'API HubSpot, définissez la valeur du champ Autorisation sur Bearer [VOTRE_JETON] Par exemple, si vous effectuez un appel vers l'API Contacts via Node.js et axios, la demande ressemblera à ceci :
axios.get('https://api.hubapi.com/crm/v3/objects/contacts', { headers: { 'Authorization': `Bearer ${YOUR_TOKEN}`, 'Content-Type': 'application/json' } }, (err, data) => { // Handle the API response } );
  • Les jetons d'accès des applications privées sont implémentés sur OAuth. Ainsi, vous pouvez également effectuer des appels authentifiés avec votre jeton d'accès à l'aide de l'une des bibliothèques clientes de HubSpot. Par exemple, si vous utilisez la bibliothèque cliente Node.js, vous pouvez instancier un client OAuth en transmettant le jeton d'accès de votre application :
const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN });

Afficher des informations sur le jeton d'accès de l'application privée

Pour afficher des informations sur le jeton d'accès d'une application privée, comme le HubID et les domaines associés, faites une demande POST à /oauth/v2/private-apps/get/access-token-info. Dans le corps de la demande, incluez votre jeton d'accès :

// POST request response body { "tokenKey": {{accessToken}} }

La réponse comprendra des informations sur l'utilisateur qui a créé le jeton, le HubID du compte, l'ID de l'application privée et les domaines associés au jeton.

// Example response body { userId:123456, hubId:1020304, appId:2011410, scopes:[ "oauth", "crm.schemas.companies.write"] }

Actualiser votre jeton d'accès

Si votre jeton d'accès est perdu ou corrompu, vous pouvez l'actualiser. Un nouveau jeton d'accès sera créé et le jeton d'accès initial expirera.

  • Dans votre compte HubSpot, cliquez sur la page Paramètres dans la barre de navigation principale.
  • Accédez à Intégrations > Applications privées.
  • Cliquez sur le nom de votre application privée.
  • À côté de votre jeton d'accès, cliquez sur Actualiser :
    • Si votre jeton est corrompu et que vous souhaitez révoquer immédiatement l'accès, cliquez sur Actualiser et expirer maintenant.
    • S'il n'y a pas de menace imminente quant à votre jeton, il est toujours recommandé d'assurer la rotation de votre jeton tous les six mois. Si vous souhaitez lancer une rotation régulière de votre jeton, cliquez sur Actualiser et expirer ultérieurement, ce qui déclenchera une expiration du jeton dans 7 jours.
      • Si votre application est prête à effectuer une transition plus tôt, vous pouvez cliquer sur Faire expirer maintenant.
      • Si vous avez besoin de plus de temps, vous pouvez cliquer sur Annuler la rotation, ce qui annulera l'expiration du jeton initial et révoquera le nouveau jeton d'accès.

rotate-private-app-access-token

HubSpot enverra également des notifications par e-mail aux super administrateurs avec des rappels sur l'état de rotation des jetons d'accès ainsi que d'autres alertes connexes. Les super administrateurs de votre compte HubSpot recevront des notifications pour les événements et rappels suivants :

  • Un super administrateur a initié une rotation (soit immédiatement, soit planifiée pour 7 jours à partir de maintenant).
  • Un super administrateur a annulé une rotation en attente.
  • Un super administrateur a choisi d'expirer immédiatement un jeton d'accès en cliquant sur Expirer maintenant au lieu d'attendre 7 jours pour que le jeton expire.
  • Le jeton d'accès de l'application va expirer dans 24 heures.
  • Le jeton d'accès de l'application a fait l'objet d'une rotation et a expiré au bout de 7 jours.
  • Si vous n'avez pas fait pivoter votre jeton d'accès depuis plus de 180 jours, les super administrateurs recevront également un e-mail de rappel pour faire pivoter le jeton d'accès de votre application.

Afficher les journaux d'appels d'API

Pour consulter les appels d'API que votre application a effectués au cours des 30 derniers jours :

  • Sur la page de détails de votre application, cliquez sur l'onglet Journaux.
  • Analysez et filtrez vos appels d'API pour votre application privée :
    • Cliquez sur les menus déroulants Méthode et Réponse pour filtrer vos appels d'API passés par méthode de demande ou par code de réponse.
    • Cliquez sur les menus déroulants Date de début ou Date de fin pour filtrer vos journaux d'appels selon une période spécifique.
    • Vous pouvez également rechercher des appels spécifiques par URL dans le champ Rechercher par l'URL de demande.

private-app-logs-tab-updated

  • Pour exporter les journaux d'appels de l'API, cliquez sur Exporter des journaux (CSV). Spécifiez ensuite une plage de dates (jusqu'à 30 jours auparavant) et cliquez sur Exporter.
  • Dans la boîte contextuelle, sélectionnez la plage de dates des appels d'API que vous souhaitez exporter et cliquez sur Exporter. Vous recevrez un e-mail contenant un lien de téléchargement lorsque le fichier sera prêt. 

Limites d'utilisation concernant les applications privées

Vous pouvez créer jusqu'à 20 applications privées dans votre compte HubSpot. Chaque application privée est soumise aux directives sur l'utilisation des API HubSpot. Le nombre d'appels que votre application privée peut effectuer dépend de l'abonnement de votre compte et de l'achat du module complémentaire API :

  Niveau du produit Toutes les 10 secondes Par jour
Applications privées

(Tout abonnement Hub)

Gratuit et Starter

100/application privée 250 000/compte
 

(Tout abonnement Hub)

Pro et Entreprise

150/application privée 500 000/compte
Applications privées avec le module complémentaire API

(Tout abonnement Hub)

Gratuit, Starter, Pro et Entreprise

200/application privée 1 000 000/compte

Si vous disposez d'abonnements Starter et Pro, les limites pour le niveau le plus élevé (Pro) s'appliquent à votre compte.

Vous pouvez effectuer une demande GET à /account-info/v3/api-usage/daily/private-apps pour consulter l'utilisation quotidienne de l'API pour toutes les applications privées de votre compte HubSpot. Découvrez-en davantage sur l'utilisation de l'API d'informations de compte.

Supprimer une application privée

Si vous supprimez une application privée, son jeton d'accès sera définitivement révoqué et vous ne pourrez plus l'utiliser pour effectuer des appels d'API.

Pour supprimer une application :

  • Dans votre compte HubSpot, cliquez sur l'icône Paramètres dans la barre de navigation principale.
  • Cliquez sur le nom de votre application privée.
  • En haut de la page, cliquez sur l'onglet Authentification.
  • Au bas de la page, cliquez sur Supprimer [Nom de votre application].
  • Dans la boîte de dialogue, saisissez le nom de votre application pour confirmer sa suppression, puis cliquez sur Supprimer.

Cet article vous a-t-il été utile ?
Ce formulaire est destiné à recueillir les avis sur la documentation pour les développeurs. Si vous souhaitez faire part de votre avis sur les produits HubSpot, veuillez le partager sur le forum des idéesde la communauté.