Clés API
Les Clés API sont des jetons Bearer qui accordent un accès programmatique à l'API REST de LeadHub. Utilisez-les pour créer des intégrations personnalisées, synchroniser des données avec d'autres systèmes ou automatiser des tâches via du code.
Créer une Clé API
- Allez dans Intégrations → Clés API.
- Cliquez sur Nouvelle Clé API.
- Renseignez :
| Champ | Description |
|---|---|
| Nom | Nom descriptif (ex. : "Mon Intégration App", "Zapier") |
| Permissions | Quelles actions cette clé peut effectuer (lecture seule, lecture-écriture) |
| Expire le | Date d'expiration optionnelle ; laissez vide pour ne pas expirer |
- Cliquez sur Enregistrer.
- Copiez le jeton immédiatement — il n'est affiché qu'une seule fois. Si vous le perdez, vous devez le régénérer.
Utiliser une Clé API
Incluez la clé en tant que jeton Bearer dans chaque requête API :
GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
Points de Terminaison API
| Méthode | Point de Terminaison | Description |
|---|---|---|
GET | /api/leads | Lister tous les leads (paginé) |
GET | /api/leads/{id} | Obtenir un seul lead |
POST | /api/leads | Créer un nouveau lead |
PUT | /api/leads/{id} | Mettre à jour un lead |
DELETE | /api/leads/{id} | Supprimer un lead |
GET | /api/pipelines | Lister les pipelines |
GET | /api/tags | Lister les étiquettes |
POST | /api/leads/{id}/tags | Ajouter des étiquettes à un lead |
La référence API complète est disponible dans la documentation Swagger de LeadHub à /api/documentation sur votre installation.
Révoquer une Clé
Pour révoquer une clé API :
- Allez dans Intégrations → Clés API.
- Cliquez sur l'icône de suppression sur la ligne de la clé et confirmez.
La clé est immédiatement invalidée. Toutes les requêtes l'utilisant recevront une réponse 401 Non Autorisé.
Bonnes Pratiques de Sécurité
- Ne jamais engager de clés API dans un système de contrôle de version (GitHub, Bitbucket, etc.)
- Utilisez des clés en lecture seule quand vous avez seulement besoin de lire des données
- Définissez des dates d'expiration sur les clés utilisées pour des intégrations temporaires
- Révoquez immédiatement les clés qui ont pu être exposées
- Utilisez une clé par intégration afin de pouvoir révoquer des clés spécifiques indépendamment