Clés API & webhooks

Vous voulez connecter GestSen à votre outil comptable, à un tableur Google Sheets ou à un ERP maison ? GestSen expose une API publique accessible par clé API, ainsi que des webhooks qui préviennent vos systèmes quand un événement se produit. Ce chapitre s’adresse aux intégrateurs et aux commerçants avertis qui veulent automatiser au-delà de l’app.

Vidéo à venir

Créer une clé API et configurer les webhooks. La capture vidéo sera intégrée ici dès qu'elle sera disponible sur Cloudflare Stream.

Créer une clé API

La clé API est votre mot de passe technique : elle authentifie les appels vers les endpoints publics de votre entreprise.

1. Ouvrez Paramètres → Clés API (réservé au Gérant).
2. Touchez Créer une clé.
3. Donnez un nom explicite (ex. « Sync comptable », « Dashboard maison »).
4. Sélectionnez les permissions à accorder à cette clé.
5. Validez : la clé s’affiche une seule fois — copiez-la immédiatement dans un gestionnaire de mots de passe.

Choisir les permissions granulaires

Chaque clé est limitée à un jeu de permissions granulaires, selon le principe du moindre privilège :

• read:invoices — lire les factures.
• read:clients — lire les clients.
• read:sales — lire les ventes.
• read:reports — lire les rapports financiers.

Une clé pour votre comptable n’a besoin que de read:invoices et read:reports. Une clé pour un outil marketing pourrait se contenter de read:clients. N’accordez jamais plus que le strict nécessaire.

Appeler les endpoints publics

Les endpoints externes s’authentifient via l’en-tête HTTP X-Api-Key. Base d’URL : préfixe /external.

Endpoint	Données retournées
GET /external/company	Infos entreprise (nom, NINEA, adresse).
GET /external/invoices	Liste des factures (avec read:invoices).
GET /external/clients	Liste des clients (avec read:clients).
GET /external/sales	Liste des ventes (avec read:sales).
GET /external/reports/summary	Résumé financier du mois (avec read:reports).

Exemple d’appel :

GET /external/sales
X-Api-Key: gsk_votre_cle_ici
Accept: application/json

Configurer les webhooks sortants

Les webhooks sortants poussent les événements de GestSen vers vos propres endpoints HTTP. C’est l’inverse de l’API : GestSen vous appelle quand quelque chose se passe.

1. Ouvrez Paramètres → Webhooks.
2. Touchez Ajouter un endpoint.
3. Saisissez l’URL de votre service (ex. https://votre-erp.com/hooks/gestsen).
4. Choisissez les événements à écouter.
5. Enregistrez et utilisez Tester l’endpoint pour envoyer un événement de contrôle.

Les événements métier disponibles incluent notamment sale.created (nouvelle vente) et invoice.paid (facture payée). À chaque déclenchement, GestSen envoie un payload JSON en POST vers votre URL.

Webhooks entrants : paiements Mobile Money

GestSen reçoit aussi des webhooks depuis les fournisseurs de paiement :

• POST /webhooks/wave — notifications Wave.
• POST /webhooks/orange-money — notifications PayTech / Orange Money.

Ces endpoints identifient votre entreprise via le paiement rattaché et mettent à jour le statut (réussi, en attente, échec). Vous n’avez rien à configurer côté GestSen : c’est le fournisseur qui appelle.

Révoquer une clé ou un webhook

• Clé API : dans Paramètres → Clés API, touchez la clé puis Révoquer. Tous les appels ultérieurs avec cette clé renverront une erreur 401.
• Webhook : dans Paramètres → Webhooks, désactivez ou supprimez l’endpoint. Les événements cessent immédiatement d’être envoyés.

Checklist

Avant de clore ce parcours, vérifiez que vous savez :

• Créer une clé API et la copier en lieu sûr
• Choisir les permissions adaptées à un usage donné
• Appeler un endpoint /external avec l’en-tête X-Api-Key
• Configurer et tester un webhook sortant

Prochaine étape

Vous maîtrisez désormais l’ensemble des fonctionnalités avancées de GestSen : rapports, impression, hors-ligne, équipe, multi-boutiques, intégrations et API. Vous avez tous les outils pour piloter votre PME sénégalaise avec une rigeur professionnelle. Bonne gestion !