Développeurs

Une API sobre. Des webhooks signés. Aucune surprise.

Branchez votre caisse, votre ERP ou votre application. La clé désigne la boutique, ses portées disent ce qu’elle a le droit de faire.

Créer une boutique de test Lire la documentation

curl https://VOTRE-DOMAINE-KOMERXE/api/v1/orders \
  -H "Authorization: Bearer kmx_votre_cle" \
  -H "Accept: application/json"

API REST v1

Produits, commandes, clients, inventaire

Une clé par usage: Les clés commencent par kmx_, s’affichent une seule fois et sont stockées hachées. Révoquez-en une sans toucher aux autres.
Des portées séparées: Lecture et écriture ne vont jamais ensemble par défaut. Le tableur du comptable lit, votre caisse écrit.
Aucune boutique dans l’URL: La clé appartient à une boutique et ne peut atteindre que ses données.
Produits: Lister, lire, créer et modifier vos produits et leur stock.
Commandes: Lister, lire et marquer une commande comme expédiée, avec transporteur et numéro de suivi.
Inventaire: Lire le stock par emplacement, enregistrer un comptage, déplacer des unités.

Portées disponibles

products:read
products:write
orders:read
orders:write
customers:read
inventory:read
inventory:write

Webhooks

Prévenu quand ça arrive, preuve à l’appui

Chaque envoi est signé avec HMAC-SHA256 dans l’en-tête X-Komerxe-Signature. En cas d’échec, Komerxe réessaie après 1, 5 puis 30 minutes.

order.created
order.paid
order.fulfilled
order.cancelled
return.requested
product.updated

import { createHmac, timingSafeEqual } from 'node:crypto';

// Signez le corps brut, tel que reçu, jamais un JSON re-sérialisé.
export function isFromKomerxe(rawBody, signature, secret) {
  const expected = createHmac('sha256', secret).update(rawBody).digest('hex');

  return (
    signature.length === expected.length &&
    timingSafeEqual(Buffer.from(signature), Buffer.from(expected))
  );
}

API de licences

Votre logiciel demande, Komerxe répond

Une API publique pour les éditeurs : votre application vérifie sa clé sans que vous hébergiez un serveur de licences.

POST /api/licenses/verify: La clé existe-t-elle, est-elle valide, combien d’activations lui reste-t-il ?
POST /api/licenses/activate: Attache la clé à un poste, dans la limite d’activations que vous avez fixée.
POST /api/licenses/check: Le battement de cœur de votre application : la clé est-elle toujours valide sur ce poste ?
POST /api/licenses/deactivate: Libère une activation quand votre client change de machine.

Komerxe pour les éditeurs de logiciels

Créez une boutique, générez une clé, faites votre premier appel.

Le plan gratuit donne accès à l’API et aux webhooks.

Créer ma boutique gratuitement Voir les tarifs