Syrcow DocsMarkdown d'abord, maintenance rapide.
Exploitation

Référence API

Vue d'ensemble des routes HTTP exposées par l'application métier.

Référence API

Cette page sert de carte rapide des routes les plus importantes. Elle n'est pas encore une référence exhaustive endpoint par endpoint; elle explique surtout à quoi servent les routes et dans quel ordre les utiliser.

Endpoints principaux

RouteUsage
/api/productsproduits
/api/transactionstransactions
/api/organizationsorganisations
/api/usersutilisateurs
/api/customersclients
/api/suppliersfournisseurs
/api/product-branchesliaison produit/branche
/api/invoicesfacturation
/api/caissecaisse
/api/expensesdépenses
/api/dashboardagrégats dashboard
/api/refresh-subscriptionrevalidation abonnement
/api/pingsanté basique
/api/detectdétection IA

À quoi servent ces routes

  • /api/products sert à gérer les articles qui entrent dans le stock.
  • /api/transactions enregistre les mouvements qui changent réellement le stock.
  • /api/organizations pilote la structure multi-tenant.
  • /api/users et /api/customers gèrent les acteurs métier.
  • /api/suppliers permet de relier les produits à l'origine d'approvisionnement.
  • /api/product-branches relie un produit à un périmètre d'exploitation.
  • /api/caisse sert au suivi des flux de caisse et des écarts.
  • /api/expenses suit les dépenses opérationnelles.
  • /api/dashboard agrège des informations de suivi.
  • /api/refresh-subscription sert aux mises à jour liées à l'abonnement.
  • /api/ping permet de vérifier rapidement que le service répond.
  • /api/detect lance la détection IA sur une image.

Ce qu'il faut vérifier côté client

  • authentification valide
  • tenant actif
  • rôle autorisé
  • formats de payload conformes au schéma
  • contexte d'organisation correctement sélectionné
  • champs obligatoires fournis dans le bon format

Cas d'usage documentés

  • synchronisation des transactions hors ligne
  • création de produits validés par référentiel
  • lecture des organisations liées à l'utilisateur
  • envoi d'images à la brique IA
  • lecture de santé rapide via ping

Comment utiliser une route sans se tromper

  1. vérifier si la route concerne la lecture ou l'écriture;
  2. vérifier si elle dépend d'un tenant;
  3. vérifier si le rôle a le droit d'y accéder;
  4. envoyer un payload conforme au schéma attendu;
  5. relire la réponse serveur au lieu de supposer que l'opération a réussi.

Pour aller plus loin

La documentation API détaillée peut être ajoutée endpoint par endpoint si vous voulez une vraie référence technique.