KluvanAide

Connecter vos propres logiciels avec des clés API

L'API publique permet à vos propres logiciels, ou à ceux de votre développeur, de lire et d'écrire vos enregistrements Kluvan : produits, clients, stock, rapports, documents de Comptabilité, personnel RH, CRM, abonnements et les apps dont vous disposez. Vous contrôlez chaque clé : ce qu'elle peut faire, pour combien de temps et pour quelle succursale.

Avant de commencer

  • Seul le propriétaire peut créer et révoquer des clés.
  • Une clé n'ouvre jamais une app que votre organisation n'a pas, et toutes les règles de votre formule, de vos apps et de vos succursales continuent de s'appliquer.

Étapes

  1. Ouvrez Paramètres → Accès développeur.
  2. Sous Nouvelle clé, saisissez un Nom que vous reconnaîtrez, par exemple "Scanner de l'entrepôt".
  3. Définissez Valable (jours, 1–365). La valeur par défaut est 90.
  4. Sous Succursale, gardez Toutes les succursales ou choisissez une succursale.
  5. Sous Peut voir, cochez chaque droit dont la clé a besoin. Chacun indique Lecture ou Écriture, par exemple Produits · Lecture.
  6. Cochez la phrase indiquant que vous autorisez l'accès sélectionné.
  7. Appuyez sur Créer la clé.
  8. Copiez la clé maintenant. Elle n'est affichée qu'une seule fois.
  9. Donnez la clé à votre logiciel. Il l'envoie dans l'en-tête Authorization: Bearer.

Appeler l'API

  • L'adresse est https://api.kluvan.com/v1/public-api. Le Guide du développeur (/developers) montre des exemples et chaque opération avec le droit qu'elle demande. OpenAPI 3.1 télécharge le contrat complet, avec les champs des requêtes.
  • Chaque écriture demande un Idempotency-Key : un nouvel UUID par modification. Si la réponse est perdue, renvoyez la même requête avec la même clé, jusqu'à 7 jours plus tard ; elle n'est pas appliquée deux fois. La même clé avec une requête modifiée est refusée.
  • Une modification d'un enregistrement existant envoie aussi la version actuelle de l'enregistrement (v), si bien qu'une copie plus ancienne n'écrase jamais une plus récente.
  • Les montants sont exprimés dans la plus petite unité de la devise (150.00 vaut 15000).
  • Les listes d'enregistrements des apps renvoient jusqu'à 50 enregistrements et une valeur next ; passez-la comme after pour obtenir la page suivante.
  • Jusqu'à 120 requêtes par minute et par clé. Au-delà, la réponse est 429 avec Retry-After. Chaque erreur porte un code (voir le guide des erreurs).

Bon à savoir

  • Les droits d'écriture modifient de vrais enregistrements et peuvent lancer les actions d'une app, avec leurs effets sur le stock et la comptabilité. Ne donnez à une clé que les droits dont elle a besoin.
  • Les clés de succursale ne lisent que les enregistrements de leur succursale. Les opérations sur le catalogue, les clients, le CRM, les RH et les abonnements demandent une clé pour toutes les succursales.
  • Kluvan ne conserve qu'une empreinte (hash) de chaque clé. Vous avez perdu une clé ? Révoquez-la et créez-en une nouvelle.
  • Révoquer arrête une clé immédiatement. Une clé s'arrête aussi à son dernier jour. Vous pouvez détenir jusqu'à 20 clés.
  • Activité de l'API liste chaque appel : heure, opération, clé et statut. Le contenu des requêtes et les clés ne sont jamais enregistrés.
  • L'API ne propose ni facturation, ni connexion, ni encaissement de paiements, ni webhooks : il n'y a pas de notifications sortantes, donc votre logiciel lit les listes dont il a besoin.
  • Une session de navigateur connectée ne peut pas appeler cette API, et les clés des apps d'assistant sont distinctes : voir connecter une app d'assistant.

Cette page vous a-t-elle été utile ?

Besoin d'aide supplémentaire ?

Écrivez-nous sur WhatsApp. Dites-nous ce que vous faisiez et, pour une erreur, le code qui suit le # dans le lien.