Pipedrive : découverte de l’API et de son fonctionnement

L’API de Pipedrive permet d’interagir directement avec les données du CRM afin de les consulter,
les créer, les modifier ou les supprimer depuis des outils externes. Elle constitue donc un élément
central dès lors que l’on souhaite connecter Pipedrive à d’autres solutions, automatiser certains
traitements ou développer des intégrations spécifiques.

Dans cette présentation, l’objectif est de découvrir le fonctionnement général de l’API de Pipedrive,
sa documentation, son système d’authentification, la logique de ses endpoints, les limites de consommation
ainsi que certaines particularités à connaître, notamment avec l’API v2.

Une documentation API publique et accessible

La documentation API de Pipedrive est publique. Il est donc possible de la consulter même sans disposer
immédiatement d’un compte Pipedrive.

Cette documentation regroupe les principaux objets disponibles dans le CRM ainsi que les endpoints associés.
On y retrouve notamment les affaires, appelées « deals » dans Pipedrive, les personnes, les organisations,
les étapes du pipeline, les utilisateurs ou encore de nombreuses autres ressources.

Pour chaque ressource, la documentation précise les différentes opérations qu’il est possible d’effectuer,
les paramètres attendus et la structure des réponses retournées.

L’intérêt est de pouvoir comprendre précisément comment interroger Pipedrive avant même de commencer
un développement ou une automatisation.

L’authentification avec une clé API utilisateur

Pour utiliser l’API de Pipedrive, il est possible de s’authentifier à l’aide d’un token API associé
à un utilisateur.

Chaque utilisateur dispose de sa propre clé API. Cette clé peut ensuite être utilisée dans des développements
spécifiques, dans des outils d’automatisation ou encore dans des logiciels permettant de tester des requêtes API.

Un point important est que les possibilités offertes par la clé API dépendent directement des autorisations
de l’utilisateur auquel elle appartient.

Par exemple, si un utilisateur ne possède pas le droit de créer des affaires dans Pipedrive,
l’utilisation de sa clé API ne permettra pas non plus de créer des affaires par API.

Un administrateur possède généralement davantage de possibilités, tandis qu’un utilisateur disposant
de permissions restreintes sera limité aux mêmes opérations lorsqu’il passera par l’API.

Gérer l’accès aux clés API

L’accès à la clé API d’un utilisateur peut être contrôlé depuis les paramètres d’administration de Pipedrive.

Dans les ensembles d’autorisations, il est notamment possible d’activer ou de désactiver l’accès
d’un utilisateur à sa propre clé API.

Cette autorisation doit être accordée avec prudence. Une clé API donne potentiellement accès à une grande
quantité de données et peut permettre d’effectuer des opérations massives.

Une mauvaise utilisation peut par exemple entraîner :

• l’export de données importantes ;
• la modification en masse d’informations ;
• la suppression de données ;
• la création ou la mise à jour de nombreux objets.

Il est donc recommandé de ne donner accès aux clés API qu’aux utilisateurs qui en ont réellement besoin
et qui comprennent les conséquences des opérations qu’ils peuvent effectuer.

Les principaux usages de l’API Pipedrive

L’API peut être utilisée dans plusieurs contextes.

Elle est notamment très utile pour mettre en place des automatisations no-code avec des outils comme
Make, Zapier ou n8n.

Elle peut également être testée à l’aide d’outils comme Postman afin de valider les requêtes,
observer les réponses retournées par Pipedrive ou préparer un développement avant son intégration
dans une application.

Enfin, elle permet de créer des développements entièrement personnalisés.

Il est ainsi possible de connecter Pipedrive avec :

• un ERP ;
• un outil métier interne ;
• une solution de gestion ;
• un outil d’intelligence artificielle ;
• une plateforme e-commerce ;
• une application développée sur mesure.

Dans ce cas, l’API devient l’intermédiaire permettant de récupérer ou d’envoyer des informations
entre Pipedrive et l’autre système.

Comprendre les principales méthodes API

La documentation de Pipedrive repose sur les méthodes HTTP classiques utilisées dans les API REST.

GET : récupérer des informations

La méthode GET sert principalement à consulter des données.

Elle peut par exemple permettre de récupérer la liste des affaires ou les détails d’une affaire précise.

POST : créer des données

POST est utilisé pour créer de nouveaux éléments.

Dans le cas des deals, il peut notamment servir à ajouter une affaire, ajouter un participant,
ajouter un abonné ou créer d’autres informations liées à l’opportunité.

PATCH : mettre à jour des données

PATCH permet de modifier les informations d’un élément déjà existant.

Il est par exemple possible de mettre à jour les informations d’une affaire, d’une personne
ou d’une organisation.

PUT : effectuer certaines opérations spécifiques

PUT peut être utilisé pour certaines opérations spécifiques, par exemple lorsqu’il
est nécessaire de fusionner des éléments.

DELETE : supprimer des informations

DELETE permet de supprimer un élément ou certaines données associées.

Ces différentes méthodes permettent donc de piloter une grande partie des informations de Pipedrive
depuis un système externe.

L’API v2 de Pipedrive

Pipedrive a introduit une nouvelle version de son API, appelée API v2.

Selon les endpoints disponibles, il est parfois possible de choisir entre une requête en API v1
et une requête en API v2.

Lorsque la version v2 est disponible, il est généralement préférable de l’utiliser pour les nouveaux développements.

L’API v1 peut progressivement devenir dépréciée sur certains endpoints. Cela signifie qu’elle peut continuer
à fonctionner pendant une période, mais qu’elle ne bénéficie plus nécessairement du même niveau de maintenance
ou de support.

La migration vers l’API v2 doit cependant être préparée avec attention, car certaines structures de données
ou certains champs peuvent être différents.

Un développement existant basé sur l’API v1 ne doit donc pas nécessairement être migré sans vérification préalable.

Le système de crédits et les limites de l’API

L’utilisation de l’API Pipedrive n’est pas illimitée.

Pipedrive applique des limites de requêtes qui peuvent dépendre du forfait utilisé, du nombre d’utilisateurs
ainsi que du type de requêtes effectuées.

Il existe notamment des limites de fréquence sur une courte période et un volume global de crédits
ou jetons API disponibles quotidiennement.

Le nombre disponible varie selon le forfait Pipedrive.

À titre d’exemple présenté dans la démonstration, le nombre de crédits peut évoluer significativement
entre les différents abonnements et augmenter avec le nombre de postes utilisateurs.

Cela signifie qu’une entreprise disposant de nombreux utilisateurs possède généralement une enveloppe API
quotidienne plus importante qu’une entreprise comptant seulement quelques licences.

Pourquoi surveiller sa consommation API ?

La consommation API devient particulièrement importante lorsqu’une entreprise utilise plusieurs intégrations
en parallèle.

Par exemple, une synchronisation avec un ERP, plusieurs scénarios Make et différents développements internes
peuvent chacun consommer des crédits API.

Une entreprise avec peu d’utilisateurs mais beaucoup d’automatisations peut ainsi atteindre assez rapidement
son plafond quotidien.

Lorsque la limite quotidienne est atteinte, les intégrations utilisant l’API peuvent cesser de fonctionner
jusqu’à la réinitialisation du quota.

Pipedrive permet de consulter cette consommation depuis une interface dédiée afin de connaître le volume
de requêtes effectuées et le pourcentage de crédits utilisés.

Cette surveillance est particulièrement recommandée pour les intégrations critiques.

Ajouter des crédits API supplémentaires

Lorsque l’enveloppe incluse dans l’abonnement n’est pas suffisante, Pipedrive peut proposer des crédits supplémentaires.

Ils permettent d’augmenter la capacité quotidienne disponible sans nécessairement augmenter immédiatement
le nombre d’utilisateurs de l’entreprise.

Cette option peut devenir intéressante pour une organisation disposant de peu de licences mais ayant
une forte activité d’intégration.

Avant d’acheter des crédits supplémentaires, il est néanmoins pertinent d’analyser les scénarios existants
afin de vérifier qu’ils n’effectuent pas des requêtes inutiles.

Une intégration correctement optimisée peut parfois réduire considérablement la consommation API.

Les identifiants dans Pipedrive

De nombreux endpoints nécessitent l’identifiant unique de l’objet que l’on souhaite interroger.

Par exemple, pour récupérer une affaire précise, il est nécessaire d’indiquer son identifiant.

Ces identifiants peuvent généralement être retrouvés facilement directement dans l’URL Pipedrive.

Lorsqu’une affaire est ouverte, son identifiant apparaît dans l’adresse de la page.
Le même principe s’applique notamment aux organisations.

Cet identifiant peut ensuite être utilisé dans une requête API pour demander les informations
correspondant précisément à l’objet concerné.

Les champs personnalisés et leurs clés API

Les champs personnalisés de Pipedrive disposent eux aussi d’une identification spécifique.

Lorsqu’un champ personnalisé est créé, Pipedrive lui associe une clé API. Cette clé doit être utilisée
lorsque l’on souhaite lire ou modifier le champ à travers l’API.

Elle peut être récupérée depuis la gestion des champs de données de Pipedrive.

Il est donc important de ne pas se baser uniquement sur le nom visible du champ dans l’interface.
C’est bien sa clé API qui doit être utilisée dans les requêtes.

Particularité des listes déroulantes et champs à choix

Les champs de type liste déroulante, choix unique ou choix multiple demandent une attention particulière.

Dans certains cas avec la nouvelle API, envoyer directement la valeur textuelle d’une option ne suffit pas.

Imaginons un champ personnalisé appelé « Offre secondaire » possédant deux valeurs :

Pour modifier ce champ par API, il ne suffit pas nécessairement d’envoyer la valeur « Oui ».

Il faut utiliser la clé API du champ personnalisé puis lui transmettre l’identifiant correspondant
à l’option souhaitée, par exemple 854.

Ces identifiants peuvent notamment être récupérés en exportant les champs de données de Pipedrive.

Cette particularité est importante à connaître lors de la création de synchronisations
ou de scripts de mise à jour.

Bien préparer une intégration avec Pipedrive

Une intégration réussie avec Pipedrive nécessite donc de prendre en compte plusieurs éléments dès le départ.

Il faut identifier les ressources à utiliser, choisir les bons endpoints, utiliser une authentification adaptée,
vérifier les permissions du compte utilisé, surveiller les limites de consommation et comprendre la structure
des champs personnalisés.

La migration vers l’API v2 doit également être privilégiée pour les nouveaux développements lorsque
les endpoints nécessaires sont disponibles.

Enfin, il est essentiel de tester les requêtes avant de les déployer à grande échelle,
notamment avec Postman ou dans un environnement de test.

En bref…

L’API de Pipedrive offre de nombreuses possibilités pour connecter le CRM à l’écosystème d’une entreprise.

Elle permet aussi bien de réaliser de petites automatisations avec Make, Zapier ou n8n que de construire
des intégrations complexes avec un ERP, une application interne ou une solution d’intelligence artificielle.

Sa prise en main reste relativement accessible grâce à une documentation publique et structurée.
Néanmoins, certains aspects méritent une attention particulière : permissions utilisateurs, quotas de requêtes,
migration vers l’API v2, clés des champs personnalisés et identifiants des options.

Chez BLC, nous pouvons accompagner les entreprises aussi bien sur des automatisations no-code que sur
des développements spécifiques entre Pipedrive, leurs outils métiers, leur ERP ou leurs autres applications.