Exploitation

Accès techniques

Routes utiles pour les intégrations et les automatisations.

Accès techniques

Cette page sert de carte rapide des routes les plus importantes. Elle n'est pas une référence exhaustive route par route; elle explique surtout à quoi servent les routes et dans quel ordre les utiliser. Si vous n'avez pas besoin d'automatiser ou de connecter Syrcow à un autre outil, vous pouvez lire cette page plus tard.

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 du compte client.
  • /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.

Exemple d'appel

# Lister les produits de l'organisation active
curl -H "Authorization: Bearer <token>" \
     https://client.syrcow.cloud/api/products

La réponse renvoie un tableau JSON avec les champs id, name, category, unit, status et created_at.

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

  • authentification valide (token présent et non expiré)
  • organisation active (header X-Organization-Id ou contexte dans la session)
  • rôle autorisé (certaines routes sont réservées aux gestionnaires)
  • données envoyées conformes au format attendu (utiliser Content-Type: application/json)
  • 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 de l'organisation active;
  3. vérifier si le rôle a le droit d'y accéder;
  4. envoyer les données dans le format attendu;
  5. relire la réponse serveur au lieu de supposer que l'opération a réussi.

À lire ensuite