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
| Route | Usage |
|---|---|
/api/products | produits |
/api/transactions | transactions |
/api/organizations | organisations |
/api/users | utilisateurs |
/api/customers | clients |
/api/suppliers | fournisseurs |
/api/product-branches | liaison produit/branche |
/api/invoices | facturation |
/api/caisse | caisse |
/api/expenses | dépenses |
/api/dashboard | agrégats dashboard |
/api/refresh-subscription | revalidation abonnement |
/api/ping | santé basique |
/api/detect | détection IA |
À quoi servent ces routes
/api/productssert à gérer les articles qui entrent dans le stock./api/transactionsenregistre les mouvements qui changent réellement le stock./api/organizationspilote la structure du compte client./api/userset/api/customersgèrent les acteurs métier./api/supplierspermet de relier les produits à l'origine d'approvisionnement./api/product-branchesrelie un produit à un périmètre d'exploitation./api/caissesert au suivi des flux de caisse et des écarts./api/expensessuit les dépenses opérationnelles./api/dashboardagrège des informations de suivi./api/refresh-subscriptionsert aux mises à jour liées à l'abonnement./api/pingpermet de vérifier rapidement que le service répond./api/detectlance 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-Idou 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
- vérifier si la route concerne la lecture ou l'écriture;
- vérifier si elle dépend de l'organisation active;
- vérifier si le rôle a le droit d'y accéder;
- envoyer les données dans le format attendu;
- relire la réponse serveur au lieu de supposer que l'opération a réussi.
À lire ensuite
- Sécurité et rôles — permissions sur les routes
- Architecture — comprendre le découpage des apps
- Hébergement et déploiement — options d'infrastructure