Applications publiques

Dans HubSpot, une application publique est un type d'intégration qui peut être installé sur les comptes de clients ou listé sur le marketplace des applications. Elle nécessite une authentification via OAuth. Une fois qu'un utilisateur installe votre application sur son compte HubSpot, vous pourrez effectuer des appels d'API vers ce compte en utilisant un jeton d'accès OAuth. Votre application apparaîtra également dans les paramètres Applications connectées du compte.

Les applications connectées peuvent également tirer parti de l'abonnement aux modifications via les webhooks et de la création d'événements chronologiques personnalisés. 

Ci-dessous, découvrez comment :

Créer une application publique

Lorsque vous créez une application dans HubSpot, vous associez principalement une application que vous avez conçue à un compte de développeur d'applications. Pour commencer à créer votre application HubSpot :

  • Dans votre compte de développeur d'applications, accédez à Apps dans la barre de navigation. 
  • Cliquez sur Créerdans l'angle supérieur droit.
  • Ensuite, vous devrez renseigner certaines informations et paramètres de base pour votre application. Lorsque les utilisateurs authentifient votre application avec leurs comptes HubSpot, ils verront le nom, la description, le logo et toute coordonnée de support que vous fournissez sur cette page.

Remarque : Le nom de l'application sera utilisé partout où votre application s'affichera dans HubSpot. C'est le cas notamment lors de l'installation de l'application ainsi que dans le pied de page Géré par pour les cartes CRM et les événements de chronologie.

  • Cliquez sur l'onglet Authentification pour afficher votre ID et votre secret client ainsi que les périmètres attribués à l'application. Vous aurez besoin de ces informations pour lancer une connexion OAuth entre votre application et HubSpot.
  • Dans l'onglet Authentification, cliquez sur le menu déroulant Périmètres en bas de la page pour ajouter de nouveaux périmètres à votre application. Ces périmètres d'accès obligatoires doivent être inclus dans le paramètre scope= de votre URL d'autorisation. Sinon, les utilisateurs recevront une erreur lorsqu'ils essayeront d'autoriser votre application. Consultez la documentation sur OAuth pour plus d'informations sur la création de votre URL d'autorisation et l'utilisation des périmètres d'accès.

app_scopes

  • Tenez compte du champ URL de redirection. C'est vers cette URL que les utilisateurs seront renvoyés après l'octroi de l'accès de votre application à leurs comptes HubSpot. Si vous n'incluez pas d'URL de redirection, les utilisateurs recevront une erreur de connexion. Les URL de redirection doivent utiliser HTTPS, sauf si elles se trouvent sur localhost.

Une fois votre application créée, vous pourrez suivre le processus d'installation.

Remarque : Il est recommandé d'ajouter un domaine vérifié à l'application pour ajouter un autre niveau de confiance aux utilisateurs qui installent votre application. Sinon, l'application affichera une bannière indiquant que l'application n'est pas vérifiée.

Installer une application

Remarque : Avant d'installer votre application, tenez compte des éléments suivants.

  • Une application ne s'affiche pas sur la page Applications connectées d'un compte tant que l'accès initial et les jetons d'actualisation ne sont pas créés.
  • Seuls les utilisateurs disposant d'un accès aux périmètres d'accès requis de l'application peuvent installer une application.
  • Les applications ne peuvent pas être installées sur des comptes de développeur. Pour tester votre application, vous devez créer un compte de test dans votre compte de développeur d'applications et l'installer dessus.

L'installation d'une application peut être divisée en deux étapes : l'autorisation et la génération d'un jeton.

Autoriser votre application avec un compte client 

  • Pour autoriser votre application avec un compte HubSpot, vous devez créer une URL d'autorisation. Pour cela, vous devez obtenir l'ID de client pour votre application etlancer le processus OAuth.
  • Une fois que votre URL est prête, ouvrez-la dans votre navigateur pour afficher une liste de tous vos comptes HubSpot C'est également cela que les utilisateurs verront une fois que vous aurez commencé à les rediriger vers cette URL.
  • Sélectionnez le compte sur lequel vous souhaitez installer votre application.

select_account-1

  • Après avoir choisi un compte, vous disposerez d'une liste de périmètres d'accès en fonction des paramètres &scope= et &optional_scope= définis pour l'URL d'autorisation.

Remarque : Si vous ajoutez un optional_scope et que le compte sélectionné n'y a pas accès (comme la portée de contenu pour un compte CRM uniquement), il ne sera pas répertorié.

  • Cliquez sur Accorder l'accès pour autoriser la connexion.

approve_scopes-1

  • Après avoir autorisé l'accès, vous serez redirigé en fonction du paramètre &redirect_uri= dans l'URL d'autorisation d'origine et un paramètre ?code= sera ajouté à l'URL. Utilisez ce code à l'étape suivante pour générer un jeton d'accès.

Générer les jetons OAuth initiaux 

Pour générer les jetons d'actualisation et d'accès initiaux, vous aurez besoin du code du paramètre ?code= de l'URL d'autorisation, de redirect_url ainsi que de l'ID et du secret de client. Des instructions détaillées sont disponibles ici

Une fois que vous avez autorisé votre application et généré les jetons initiaux, l'installation est terminée. L'application sera répertoriée sur votre page Applications connectées et vous commencerez à obtenir des demandes d'indexation (fetch) de webhook et de cartes CRM.

connected_apps-1

 

Gérer les applications publiques dans HubSpot

Find an app's ID

Vous pouvez trouver l'ID d'une application publique dans votre compte de développeur d'application en utilisant l'une des méthodes ci-dessous :

  • Dans votre compte de développeur, accédez à Applications dans la barre de navigation principale, puis affichez l'ID d'application répertorié sous le nom de votre application.
find-app-id
  • Dans votre compte de développeur, accédez à Applications dans la barre de navigation principale, puis cliquez sur le nom de l'application. Sur la page Informations de base, cliquez sur l'onglet Authentification, puis consultez l'ID de l'application.

find-app-id-auth-settings

Suivre le comportement de l'application

HubSpot enregistre toutes les demandes effectuées vers ou à partir d'une application connectée, y compris les demandes entrantes utilisant un jeton d'accès OAuth ou les demandes sortantes pour des webhooks ou des cartes de CRM. 

Pour afficher ce journal des demandes :

  • Dans votre compte de développeur, accédez à Apps dans la barre de navigation.
  • Cliquez sur le nom de l'application.
  • Dans le menu latéral de gauche, accédez à Suivi
  • Utilisez les onglets pour afficher les différents types de demandes effectuées vers ou à partir de l'application. Lors de l'affichage de ces journaux, vous pouvez cliquer sur une demande pour afficher plus d'informations à son sujet, y compris :
    • pour les requêtes réussies, la méthode de requête, le chemin et la durée ;
    • pour les requêtes infructueuses, des informations d'erreur supplémentaires telles que l'en-tête et le corps de la réponse.

request_details

Découvrez ci-dessous chaque onglet de la page Suivi.

  • Appels d'API : l'onglet Appels d'API répertorie toutes les requêtes concernant votre application via un jeton d'accès OAuth. Il peut être filtré par méthode HTTP, par code de réponse, par période ou par URL de demande.
  • Webhooks : l'onglet Webhooks affiche les requêtes HubSpot pour les souscriptions aux webhooks de votre application. Filtrez par réponse (y compris les délais d'attente dépassés et les échecs de connexion), par statut (succès, nouvelle tentative ou échec), par type de souscription, par période, par tentative, par lot, par événement ou par ID de compte.

Remarque : L'ID de tentative sera une combinaison de subscriptionId, eventId et attemptNumber  de la requête en question.

  • Extensions de CRM : l'onglet Extensions de CRM affiche les requêtes pour les cartes de CRM de votre application. Filtrez par type d'fiche d'informations d'extension, par type d'objet de CRM (contact, entreprise, ticket ou transaction), par type d'erreur ou d'avertissement, par période, par ID de requête ou par ID d'objet de CRM (par exemple, ID de contact spécifique).
  • Paramètres de l'application : l'onglet Paramètres de l'application vous permet de configurer la page de paramètres fournie avec votre application. 

Ajouter un domaine vérifié

Lorsque les utilisateurs de HubSpot installent une application, ils consentent à donner accès aux données de leur compte au développeur de l'application. L'identité et la réputation du développeur jouent un rôle important dans la décision d'un utilisateur de poursuivre l'installation. Pour garantir le consentement total de l'utilisateur lors de l'installation d'une application, HubSpot affichera un message sur l'écran d'installation de l'application pour indiquer le niveau de vérification de l'application et le listing sur le marketplace des applications :

  • Lorsqu'une application n'a pas de domaine vérifié, HubSpot affichera une bannière sur l'écran d'installation indiquant que l'application n'a pas été vérifiée.
    not-verified
  • Lorsque l'application a un domaine vérifié mais n'est pas répertoriée sur le marketplace des applications, HubSpot affichera le domaine vérifié ainsi qu'une bannière sur l'écran d'installation indiquant que l'application n'a pas été évaluée ou approuvée par HubSpot. verified-not-listed
  • Lorsqu'une application est répertoriée sur le marketplace et a passé le processus d'évaluation des applications de HubSpot, HubSpot n'affichera aucune des bannières ci-dessus. Vous n'êtes pas tenu de vérifier le domaine si votre application est répertoriée sur le marketplace des applications.
    verified-and-listed

Ajouter un domaine vérifié

Pour ajouter un domaine vérifié à l'application, vous devrez d'abord ajouter le domaine aux paramètres de l'application, puis ajouter un enregistrement TXT aux paramètres DNS du domaine :

  • Dans votre compte de développeur d'applications, accédez à Apps.
  • Cliquez sur le nom de l'application.
  • Dans le menu latéral de gauche, accédez à Contact et support.
  • Dans le champ Domaine de l'entreprise, saisissez votre domaine, puis cliquez sur Enregistrer. Un message apparaîtra sous le domaine de l'entreprise indiquant que le domaine n'a pas encore été vérifié.
  • Cliquez sur Vérifier maintenant pour commencer le processus de vérification.

domain-verification-for-app


  • Dans le panneau de droite, confirmez que le domaine a été saisi correctement, puis cliquez sur Suivant.
  • Copiez la valeur d'enregistrement TXT requise en cliquant sur Copier dans la colonne Valeur.
    verify-app-domain-copy-value
  • Dans votre fournisseur DNS, créez un enregistrement TXT avec la valeur copiée. Vous trouverez ci-dessous des instructions sur certains fournisseurs DNS courants :
  • Après avoir mis à jour vos paramètres DNS, revenez à HubSpot, puis cliquez sur Suivant dans le panneau de droite. La mise à jour des enregistrements DNS peut prendre jusqu'à 48 heures. Par conséquent, les modifications peuvent ne pas être immédiatement reconnues par HubSpot. Vous pouvez revenir à cet écran à tout moment en sélectionnant à nouveau Vérifier maintenant à partir de la page de paramètres Informations sur l'entreprise.
  • Une fois la vérification effectuée, un indicateur de réussite apparaîtra dans le champ Domaine de l'entreprise.

Domain verified__export

Notes supplémentaires

  • Pour assurer la propriété continue du domaine, HubSpot continuera de vérifier régulièrement la présence de l'enregistrement TXT. L'avertissement d'installation reviendra si l'enregistrement TXT est supprimé ou modifié.
  • Actuellement, vous ne pouvez avoir qu'un seul domaine vérifié par compte de développeur. Toutes les applications d'un compte partagent le domaine vérifié. Le domaine sur la page d'installation sera lié à votre domaine racine.
  • Si vous supprimez votre domaine vérifié, toutes les applications de votre compte de développeur recevront à nouveau l'avertissement d'installation. Vous pouvez vérifier un autre domaine, mais le processus prendra quelques heures.