Vous souhaitez connecter vos logiciels métiers à votre environnement Hubspot ? Avez-vous déjà entendu parler des APIs ? Cette technologie repose sur l’interconnexion entre différentes applications, mais vous ignorez exactement ce que c’est, comment cela fonctionne ou comment pouvez-vous les utiliser pour débloquer des opportunités business ? Pas de panique ! Nous vous expliquons tout ce qu’il y a à savoir pour intégrer vos logiciels métiers facilement à Hubspot via des APIs.
Qu'est-ce qu'une API ?
1.1.Définition de l'API : Application Programming Interface
Une API (Application Programming Interface) est une interface permettant à différentes applications de communiquer entre elles. L’objectif étant de récupérer des informations d’une application tierce de manière automatique.
Lorsque vous utilisez un service tel qu'Uber par exemple, en rentrant votre adresse de destination, vous obtenez un itinéraire directement dans l’application Uber. Ce service de géolocalisation n’est pas la fonction première de l’entreprise, or cette fonctionnalité est disponible grâce à une API qui fait la connexion entre Uber et Google Map. Les développeurs de l’application Uber n’ont pas eu besoin de développer de A à Z ce service de géolocalisation puisque Google l’a déjà fait auparavant.
L’API permet donc d’avoir accès à un service, des données ou fonctionnalités fournies par un système tiers directement depuis votre solution.
Supposons que vous souhaitez connecter vos logiciels métiers à Hubspot et qu’ils n’apparaissent pas dans la marketplace des applications déjà existantes.. En établissant une connexion API, vous pourrez disposer des fonctionnalités de toutes les applications qui ont des APIs ouvertes (tout comme Hubspot) et qui ont prévu une connexion API.
1.2. Pourquoi devriez-vous avoir recours aux APIs ?
Les avantages sont clairs, les APIs simplifient la conception d’application puisque vous n’avez plus besoin de développer des fonctionnalités qui ont déjà été créées par d’autres. Vous gagnez ainsi du temps et de l’argent.
Par ailleurs, elles garantissent une certaine compétitivité en intégrant de nouvelles fonctionnalités rapidement à votre application. Enfin, elles permettent de centraliser vos données sur la même plateforme, simplifiant ainsi vos process internes.
1.3. API REST : Fonctionnement
La plupart des APIs sont dites “RESTful” . L’acronyme REST ( REpresentational State Transfer) renvoie au mode de communication entre les applications.
Dans le cas d’une API REST, ces communications se font par le biais du format HTTP (le même format qu’une page web) pour communiquer les informations de manière rapide et efficace.
Traditionnellement, lorsque l’utilisateur formule une requête sur le web, son navigateur reçoit les informations du serveur (Le serveur est un ordinateur plus puissant que votre ordinateur de bureau, il est conçu pour fournir des informations à d’autres ordinateurs par le biais d’un réseau).
Un service web standard permet donc de communiquer entre deux machines via un réseau. Or, une API joue le rôle d’intermédiaire entre deux applications différentes. Si
nous reprenons l’exemple d’Uber qui a une connexion API à Google Map. L’utilisateur formule une requête (il rentre une adresse de destination), l’API va chercher l’information dans la base de données de Google pour renvoyer à l’utilisateur l’itinéraire sur la carte.
Nous distinguons ainsi une séparation entre l’utilisateur et le serveur. La partie utilisateur récupère et affiche l’information alors que la partie serveur stocke et manipule les données.
Les APIs REST permettent d’instaurer une communication standardisée entre ces deux parties. Ainsi peu importe comment le serveur est construit ou comment l’interface utilisateur est codée, s'ils structurent leur communication en utilisant le protocole HTTP, la connexion se fera sans problème.
1.4.Comment accéder aux ressources ?
Localisation et endpoints :
Les données sont accessibles via un chemin que vous donnez à votre API. Comme lorsque vous parcourez vos dossiers pour accéder à un fichier sur votre ordinateur. Par exemple, pour accéder à une de vos photo vous effectuez le chemin suivant :
Ce PC > Images > nomdelimage.jpg.
Les API REST stockent également les données de façon similaire, un URI (Uniform Resource Identifier) est le chemin pour y arriver, l’URI est donc le moyen d’identifier votre ressource. Si l’on ajoute le nom de domaine (https://mondomaine.com) devant l’URI, on obtient alors l’URL (Uniform Resource location) de requête. L’URI permet d’identifier une ressource tandis que l’URL permet de la localiser.
Par ailleurs on appelle “endpoint” l’ensemble du chemin et donc l’endroit exact où se trouve la ressource.
L’API REST renverra alors les données en langage XML ou JSON. À savoir que le langage JSON est le plus optimal, car plus court, plus rapide à lire et plus léger.
Il existe 4 verbes HTTP principaux pour formuler vos requêtes : GET, PUT, DELETE et POST.
- GET : Récupérer des données à un serveur.
- PUT : Mettre à jour les informations existantes.
- POST : Envoyer des données d’un client au serveur (créer un élément).
- DELETE : Supprimer les informations existantes.
Vous pouvez combiner ces actions avec les endpoints pour récupérer, rechercher ou mettre à jour les informations disponibles sur différentes applications.
Une fois ces 4 verbes compris, vous serez en capacité de lire n’importe quelle documentation API.
Utilisez postman pour tester vos APIs. Cet outil vous permet de réaliser des appels APIs sans forcément être un développeur.
1.5. Il existe deux types d’API :
- Les APIs privées :
Accessible uniquement via un serveur privé (celui de votre entreprise par exemple). Ce système octroie plus de sécurité et donne accès à des services personnalisés comme un portail exclusivement prévu pour les employés par exemple.
- Les APIs publiques :
Comme celle de Hubspot, utilisables par tous sans restriction.
Comment connecter des applications tierces à Hubspot via API ?
2.1. Lire une documentation d’API
La documentation d’une API est un document indispensable pour la compréhension de votre API. Cette dernière définit le cadre d’utilisation de l’API.
Une documentation API doit comprendre plusieurs éléments :
- La manière de s’authentifier (dans le cas d’une API privée)
- Les limites de l’API.
- Explication des appels API et exemples de requêtes et de réponses (GET, PUT, DELETE et POST)
- Exemple de code en différents langages (Java, Php, Python etc)
- Une référence où sont regroupées toutes les APIs avec leurs fonctionnalités correspondantes.
Pour en savoir plus sur la documentation d’Hubspot cliquez ici. Par ailleurs les APIs représentent un enjeu business majeur.
Ainsi certaines sont payantes et nécessitent une clé d’API pour être utilisées. Pour obtenir celle de Hubspot, nous vous renvoyons à l’article suivant.
2.1. Comment utiliser les APIs d’HUBSPOT ?
2.1.1. Documentation de référence de l'API HubSpot
Les APIs HubSpot sont conçues pour permettre aux équipes, quelle que soit leur forme ou leur taille, de construire des intégrations robustes qui les aident à personnaliser et à tirer le meilleur parti de HubSpot.
Toutes les API HubSpot sont construites selon les conventions REST et conçues pour avoir une structure URL prévisible. Elles utilisent de nombreuses fonctionnalités HTTP standard, notamment les méthodes (POST, GET, PUT, DELETE) et les codes de réponse aux erreurs. Tous les appels à l'API HubSpot sont effectués sous https://api.hubapi.com et toutes les réponses renvoient du JSON standard.
2.1.2. Mise en place
La meilleure façon de commencer à construire des intégrations avec HubSpot est de créer un compte développeur. Il y a plusieurs raisons à cela : Un compte de développeur est l'endroit où vous créez des applications HubSpot, chacune authentifiée avec OAuth. Vous pouvez également utiliser votre compte de développeur pour créer des comptes de test, surveiller l'état et les performances des applications, ou publier des applications sur la marketplace des applications HubSpot.
2.1.3. Bibliothèques clientes
Les bibliothèques clientes sont conçues pour vous aider à interagir avec les API de HubSpot avec moins de friction. Elles vous évitent de devoir connaître l'URL exacte et la méthode HTTP à utiliser pour chaque appel d'API, ce qui vous laisse plus de temps pour vous concentrer sur la réalisation de votre application. Pour en savoir plus sur les bibliothèques clientes, cliquez ici.
2.1.4. Documentation de l'API
La documentation API de HubSpot est divisée en deux sections : les documents de référence et les guides d'intégration.
- Documents de référence
Tous les documents de référence de l'API comprennent une section de présentation et une section sur les endpoints. La présentation de l'API comprend un bref résumé de ses fonctionnalités, des cas d'utilisation et des considérations particulières pour la création d'une intégration. La section des endpoints répertorie chaque endpoint, ses paramètres et des exemples de requêtes dans plusieurs langues.
Une fois que vous avez configuré les paramètres d'authentification de votre application dans votre compte de développeur, vous pouvez utiliser Postman ou effectuer des appels de test directement à partir de la page de référence d'un point de terminaison.
- Guides d'intégration
Si vous souhaitez apprendre les principes fondamentaux de la plateforme HubSpot ou voir un exemple avant d'effectuer votre premier appel d'API, vous pouvez trouver des exemples d'applications et des didacticiels ainsi que des informations détaillées sur les comptes de développeur, l'utilisation d'OAuth, les limites de taux d'API, etc. en cliquant ici.
Voir aussi : En savoir plus sur les méthodes d'authentification ou OAuth.
2.2. Mise en ligne
Lorsque vous êtes prêt à partager votre application avec le monde entier et à devenir un partenaire d'application Hubspot, lisez les conditions de référencement et de certification. Ensuite, vous pourrez créer et gérer votre inscription sur l'App Marketplace directement depuis votre compte de développeur.
2.3. Assistance et ressources communautaires
Obtenez des réponses à vos questions, créez des liens et partagez vos idées en rejoignant les forums de la communauté des développeurs et la communauté Slack de HubSpot. Ces forums sont un endroit idéal pour faire entendre votre voix. Vous pouvez également vous tenir au courant des nouvelles fonctionnalités, des annonces et des changements importants.
Migrer une intégration de clé API vers une application privé ( à compter de novembre 22)
Si vous avez créé une intégration interne qui utilise une clé API HubSpot, cette dernière vous permet de lire et de modifier toutes vos données CRM HubSpot, ce qui peut constituer un risque de sécurité si votre clé API est compromise. En migrant vers une application privée, vous pouvez délimiter le périmètre spécifique de données nécessaire à votre intégration. Ainsi, un jeton d'accès est généré. Ce derniers limite les données que votre intégration peut demander ou modifier dans votre compte.
En outre, alors que les clés API nécessitent une mise à jour des jetons, les jetons d'accès aux applications privées ne le font pas. Vous n'aurez donc pas besoin d'inclure la mise à jour des jetons dans votre application.
Pour migrer une intégration de clé API existante vers une application privée, nous vous invitons à suivre les étapes suivantes.
ATTENTION : nous vous recommandons fortement d'utiliser d'abord un environnement de test, tel qu'un compte de test de développeur ou un compte sandbox, avant d'effectuer des changements en production.
Cet article passe en revue de manière non exhaustive les APIs. Il a pour vocation première de vous faire comprendre les avantages que vous offre cette technologie, ainsi qu’une procédure pour la déployer dans votre environnement HubSpot.
L’utilisation des APIs implique de nombreux avantages, mais si vous souhaitez en savoir plus sur le sujet, n’hésitez pas à nous contacter afin que nous puissions échanger avec vous sur vos projets.
.png)
Laissez nous un commentaire