Comment générer la clé API de KdoFid pour votre logiciel de caisse

Connecter KdoFid à votre logiciel de caisse vous permet de créditer des points de fidélité automatiquement à chaque transaction, sans aucune saisie manuelle. La première étape est de générer une clé API — ce guide vous explique ce qu'est une clé API, pourquoi elle est indispensable, et comment en créer une dans votre tableau de bord KdoFid en quelques clics.

Temps estimé : 5 à 10 minutes

Sommaire

• Prérequis
• Qu'est-ce qu'une clé API ? Explication simple
• Étape 1 : Accéder à la section Développeurs
• Étape 2 : Créer une nouvelle clé API
• Étape 3 : Configurer les permissions de la clé
• Étape 4 : Copier et sécuriser votre clé
• Problèmes fréquents et solutions
• Conclusion

Prérequis

Avant de générer votre clé API, vérifiez les points suivants :

• Un compte KdoFid actif avec une offre Pro ou Enterprise (la connexion API n'est pas disponible en offre Starter)
• Un accès administrateur au tableau de bord (le rôle "Caissier" ne peut pas générer de clés API)
• Le nom et le type de logiciel de caisse que vous souhaitez connecter (Lightspeed, SumUp, Clover, logiciel propriétaire, etc.)
• Un endroit sécurisé pour stocker votre clé (gestionnaire de mots de passe ou fichier sécurisé)

Pourquoi l'offre Pro minimum ? La connexion API permet à des logiciels tiers d'interagir avec votre programme de fidélité de manière automatisée. Cette fonctionnalité avancée, qui implique des transactions automatiques et des accès à vos données clients, est réservée aux abonnés Pro et Enterprise pour garantir un niveau de sécurité optimal.

Qu'est-ce qu'une clé API ? Explication simple

Avant de commencer la manipulation, prenons 2 minutes pour comprendre ce qu'est une clé API — sans jargon technique.

L'analogie du badge d'accès :

Imaginez que KdoFid est un bâtiment sécurisé contenant toutes les données de votre programme de fidélité. Votre logiciel de caisse veut entrer dans ce bâtiment pour déposer des informations (les points d'un achat) ou en récupérer (vérifier le solde d'un client). Pour entrer, il a besoin d'un badge d'accès. Ce badge, c'est la clé API.

La clé API est une longue chaîne de caractères unique (exemple : kf_live_sk_a2b3c4d5e6f7g8h9...) qui :

• Identifie votre logiciel de caisse auprès de KdoFid
• Autorise certaines actions (créditer des points, consulter des soldes)
• Protège vos données en empêchant tout accès non autorisé

Ce que votre clé API permet de faire :

• Créditer automatiquement des points à chaque ticket de caisse
• Vérifier le solde de points d'un client au moment du paiement
• Déclencher l'utilisation d'une récompense (déduction de points)
• Récupérer l'historique des transactions d'un client

Ce que vous ne devez jamais faire avec votre clé API :

• La partager par email, SMS ou message public
• La stocker dans un fichier non sécurisé
• Utiliser la même clé pour plusieurs logiciels différents (créez une clé par logiciel)

Étape 1 : Accéder à la section Développeurs

Navigation dans le tableau de bord KdoFid :

1. Connectez-vous à votre espace sur app.kdofid.fr
2. Dans le menu latéral gauche, descendez jusqu'au bas de la navigation
3. Cliquez sur "Paramètres" (icône engrenage)
4. Dans le menu des paramètres, sélectionnez "API et intégrations"

Vous arrivez sur la page de gestion des clés API. Cette page affiche :

• La liste de vos clés API existantes (avec leur nom, leur date de création, et leur dernier usage)
• Les statistiques d'utilisation de l'API (nombre d'appels ce mois, taux de succès)
• La documentation rapide des endpoints disponibles

Si c'est votre première clé, la liste est vide et vous verrez un message invitant à créer votre première clé.

Étape 2 : Créer une nouvelle clé API

Cliquez sur le bouton "Créer une clé API" (bouton bleu en haut à droite de la page).

Une fenêtre modale s'ouvre avec un formulaire de création. Remplissez les champs suivants :

Nom de la clé :

Donnez un nom descriptif à votre clé pour vous souvenir à quoi elle correspond. Exemples :

• Lightspeed - Boutique Paris
• SumUp - Caisse principale
• Logiciel caisse - Magasin Lyon

Bonne pratique : Incluez toujours le nom du logiciel et le nom de l'emplacement dans le nom de la clé. Si vous gérez plusieurs commerces ou plusieurs caisses, cette clarté vous évitera des confusions.

Type d'environnement :

KdoFid propose deux types d'environnements :

• Test (sandbox) — pour tester l'intégration sans impacter vos vrais clients ni vos vraies données
• Production (live) — pour utiliser en conditions réelles

Commencez toujours par créer une clé de test pour valider l'intégration avec votre développeur ou votre prestataire caisse. Créez une clé de production uniquement lorsque les tests sont concluants.

Description (optionnel) :

Ajoutez une note explicative si nécessaire. Exemple : "Clé API pour la caisse principale du magasin de Lyon, configurée le 01/03/2026 par Jean Martin."

Une fois ces champs remplis, cliquez sur "Générer la clé".

Étape 3 : Configurer les permissions de la clé

Après la création, KdoFid vous demande de définir les permissions associées à cette clé. Les permissions déterminent exactement ce que le logiciel connecté peut faire. C'est le principe du "moindre privilège" — n'accordez que ce qui est strictement nécessaire.

Liste des permissions disponibles :

| Permission | Description | Recommandation |

|------------|-------------|----------------|

| transactions:write | Créditer et débiter des points | Obligatoire pour une caisse |

| customers:read | Lire les profils et soldes clients | Obligatoire pour vérifier les points |

| customers:write | Créer et modifier des clients | Optionnel (si votre caisse crée des clients) |

| rewards:read | Consulter les récompenses disponibles | Recommandé |

| rewards:write | Déclencher l'utilisation d'une récompense | Recommandé |

| campaigns:read | Lire les campagnes en cours | Optionnel |

| analytics:read | Accéder aux statistiques | Non recommandé pour une caisse |

Pour une connexion logiciel de caisse standard, cochez au minimum :

• transactions:write
• customers:read
• rewards:read
• rewards:write

Restriction par adresse IP (optionnel mais recommandé) :

Pour une sécurité maximale, vous pouvez limiter l'usage de votre clé API à une ou plusieurs adresses IP spécifiques. Si votre logiciel de caisse fonctionne sur un réseau fixe (ce qui est souvent le cas), demandez l'adresse IP publique de votre réseau à votre prestataire et saisissez-la dans le champ "Restreindre aux IPs".

Cliquez sur "Enregistrer les permissions" pour finaliser.

Étape 4 : Copier et sécuriser votre clé

Une fois la clé générée et ses permissions configurées, KdoFid affiche votre clé API une seule et unique fois. C'est le moment crucial — ne fermez pas cette fenêtre avant d'avoir copié votre clé.

La clé se présente sous cette forme :

```

kf_live_sk_a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0

```

ou pour une clé de test :

```

kf_test_sk_a2b3c4d5e6f7g8h9i0j1k2l3m4n5o6p7q8r9s0

```

Pour copier votre clé :

1. Cliquez sur l'icône de copie à droite de la clé (ou sélectionnez-la manuellement)
2. Collez-la immédiatement dans votre gestionnaire de mots de passe ou dans un document sécurisé

Si vous fermez la fenêtre sans copier la clé : Il sera impossible de la récupérer. KdoFid ne stocke jamais la clé en clair pour des raisons de sécurité. Vous devrez supprimer cette clé et en créer une nouvelle.

Comment transmettre la clé à votre prestataire caisse :

• Utilisez un gestionnaire de mots de passe avec partage sécurisé (1Password, Bitwarden)
• Envoyez la clé via un service de partage sécurisé à usage unique (comme onetimesecret.com)
• Ne l'envoyez jamais par email, SMS ou messagerie instantanée non chiffrée

Cliquez sur "Fermer" une fois votre clé copiée. Elle apparaît désormais dans votre liste de clés API avec son nom, son type et sa date de création. Son secret ne s'affichera plus jamais, mais vous pouvez révoquer ou régénérer la clé à tout moment.

Problèmes fréquents et solutions

Q: J'ai fermé la fenêtre sans copier ma clé. Que faire ?

R: Malheureusement, il est impossible de récupérer une clé API après la fermeture de la fenêtre de création. KdoFid ne la stocke jamais en clair. Depuis Paramètres > API et intégrations, cliquez sur les trois points à droite de la clé concernée, puis sur "Révoquer". Créez ensuite une nouvelle clé en recommençant le processus décrit dans ce guide. Si votre intégration était déjà en production, mettez à jour la clé dans votre logiciel de caisse dans les plus brefs délais pour éviter une interruption de service.

Q: Ma clé API retourne une erreur 401 (non autorisé) lors des appels depuis mon logiciel de caisse.

R: Ce problème survient dans quatre cas principaux : (1) la clé a été révoquée depuis le tableau de bord, (2) la clé est une clé de test utilisée en environnement de production (ou vice-versa), (3) l'adresse IP du logiciel de caisse ne correspond pas à la restriction IP configurée, (4) la permission requise pour l'action n'a pas été accordée à la clé. Vérifiez chacun de ces points dans Paramètres > API et intégrations > [Nom de votre clé] > Détails.

Q: Combien de clés API puis-je créer ?

R: En offre Pro, vous pouvez créer jusqu'à 10 clés API actives simultanément. En offre Enterprise, la limite est de 50 clés. Il est recommandé de créer une clé distincte par logiciel ou par point de vente pour pouvoir révoquer une clé compromise sans perturber les autres intégrations.

Conclusion

Vous avez généré votre première clé API KdoFid. Cette clé est le pont qui relie votre logiciel de caisse à votre programme de fidélité, permettant une automatisation complète de la gestion des points sans aucune intervention manuelle de votre part ou de votre personnel.

La prochaine étape est de transmettre cette clé à votre prestataire caisse ou de la saisir directement dans les paramètres d'intégration de votre logiciel. Consultez les guides spécifiques de KdoFid pour la connexion à Lightspeed, SumUp, ou à d'autres logiciels de caisse pour la suite de la procédure.

Pensez à auditer régulièrement vos clés API actives depuis Paramètres > API et intégrations : révoquez les clés inutilisées et vérifiez les statistiques d'appels pour détecter toute activité anormale.

Prêt à lancer votre programme de fidélité ?

Créez votre compte KdoFid gratuitement →

Article mis à jour le 2026-03-01. Catégorie : Guides pratiques. Temps de lecture : 9 min.