Clés API

Vue d’ensemble

Les clés API permettent à des systèmes externes d’envoyer des prospects (leads) directement dans votre CRM FlowDesk via l’endpoint REST POST /api/v1/leads. Chaque clé est associée à votre espace et doit être transmise dans l’en-tête Authorization: Bearer <clé>.

Prérequis

Compte FlowDesk avec abonnement actif.
MFA activée recommandée (voir Sécurité).
Système source capable d’envoyer des requêtes HTTP POST (formulaire web, outil d’automatisation, script).

Accès

Élément	Détail
Routes	`/settings/api-keys` ou `/api-keys`
Barre latérale CRM	Paramètres → Clés API
Endpoint	`POST https://flowdeskcrm.ca/api/v1/leads`
Documentation	Paramètres → Clés API

Étapes pas à pas

Créer une clé API

Ouvrez /settings/api-keys (ou /api-keys).
Cliquez sur Créer une clé API.
Donnez un nom descriptif (ex. « Site web principal », « Landing page hypothèque »).
Cliquez sur Générer.
Copiez immédiatement la clé affichée — elle ne sera plus visible ensuite.
Stockez la clé de façon sécurisée (gestionnaire de secrets, variables d’environnement).

Envoyer un lead via l’API

Configurez votre système source pour envoyer une requête POST à /api/v1/leads.
Ajoutez l’en-tête : Authorization: Bearer VOTRE_CLE_API.

Envoyez un corps JSON avec les champs du prospect, par exemple :

{
  "firstName": "Marie",
  "lastName": "Tremblay",
  "email": "marie@example.com",
  "phone": "+15145551234",
  "source": "site-web"
}

Vérifiez la réponse 201 Created et retrouvez le client dans Clients.

Révoquer une clé API

Ouvrez la liste des clés sur /settings/api-keys.
Identifiez la clé à révoquer.
Cliquez sur Révoquer ou l’icône de suppression.
Confirmez — toute requête utilisant cette clé sera rejetée (401 Unauthorized).

Référence des fonctionnalités

Liste des clés — Nom, date de création, dernière utilisation.
Création de clé — Génération cryptographique sécurisée.
Affichage unique — La clé complète n’est montrée qu’à la création.
Révocation — Invalidation immédiate.
Endpoint leads — POST /api/v1/leads avec Bearer token.
Codes de réponse — 201 succès, 400 validation, 401 clé invalide, 429 limite de débit.