CIAMA
Français
Documentation API · Vue d’ensemble
Votre ERP connaît vos produits. Vos canaux génèrent des commandes. Vos équipes exploitent les chiffres. L’API REST CIAMA relie ces données à vos applications, dans les deux sens.
Le parcours de vos données
Alimenter · PUT / JSON
Produits, marques, catégories et tags
Clients, offres, commandes et livraisons
Quantités de l’entrepôt par défaut
CIAMAREST APILe cockpit multicanal
Catalogue · opérations · indicateursExploiter · GET / JSON
Commandes multicanales, lignes et expéditions
Données financières et agrégats exposés
Lecture des stocks propres et externes connectés
Extension API prévue01 / Les ressources
Partez des données que vous souhaitez échanger. Ces routes donnent un aperçu du périmètre ; la référence de votre instance précise les formats, filtres et droits nécessaires.
Alimentation & lecture
Faites entrer produits, marques, catégories et tags depuis votre référentiel. Les identifiants externes conservent le lien avec les fiches de votre ERP ou de votre PIM.
/api/pim/products/by-external-id/{externalId}/api/pim/products/by-external-id/{externalId}Le stock est une ressource distincte : une mise à jour produit ne remplace pas vos quantités.
Alimentation & lecture
Transmettez clients, commerciaux, conditions tarifaires, offres, commandes et livraisons. L’activité de votre ERP rejoint les opérations et les calculs du cockpit.
/api/b2b/customers/by-external-id/{externalId}/api/b2b/orders/by-external-id/{externalId}Les calculs suivent le traitement des imports ; leur acceptation ne signifie pas une mise à jour immédiate des indicateurs.
Alimentation & lecture · périmètre en extension
Reliez le stock de votre SI à CIAMA. Le socle expose la lecture des entrepôts et les échanges de stock sur l’entrepôt par défaut. La cible étend ce fonctionnement à vos différents entrepôts et aux stocks 3PL connectés.
/api/warehouse/warehouses/api/inventory/default-warehouse/stocks/by-product-external-id/{externalId}Création d’entrepôts, écriture par entrepôt et lecture unifiée des stocks 3PL : extensions prévues, à cadrer pour votre déploiement.
Lecture
Récupérez les commandes multicanales, leurs lignes et les expéditions pour interfacer votre ERP ou vos outils internes avec les opérations centralisées dans CIAMA.
/api/oms/orders/api/oms/order-lines/api/oms/fulfillmentsLa lecture par votre application est distincte d’un connecteur d’envoi automatique vers un ERP.
Lecture
Réutilisez les données financières des lignes de commande et les agrégats exposés sur les marques et catégories : montants, marges et répartition de l’activité par canal.
/api/pim/brand/{id}/api/pim/category/{id}Les indicateurs disponibles dépendent de la ressource et de la version. La référence API décrit les champs effectivement exposés.
Suivi des imports
Suivez le traitement après l’envoi. Un reçu permet à votre système de vérifier l’état de l’import et de distinguer une demande reçue d’une donnée appliquée.
/api/pim/products/receipts/{receiptId}/api/b2b/orders/receipts/{receiptId}Les imports concernés disposent aussi de mécanismes de réconciliation par snapshot.
02 / Entrepôts & stocks 3PL
Votre entrepôt, un logisticien, un service de fulfillment marketplace : chaque source apporte une partie de votre disponibilité. L’objectif est de conserver cette origine, pas de la masquer dans un total.
Les quantités issues de votre ERP ou WMS.
Les stocks remontés par les connexions logistiques activées.
Une lecture exploitable par vos applications, avec l’origine du stock.
La cible : créer les entrepôts depuis votre SI, transmettre les quantités par entrepôt et lire les stocks externes collectés par CIAMA. Amazon FBA illustre ce besoin ; Cdiscount Fulfillment et d’autres 3PL peuvent entrer dans le périmètre selon les intégrations retenues. Chaque connexion et chaque accès API sont confirmés lors du cadrage.
Découvrir le pilotage multi-entrepôts ↗03 / Le cycle d’un import
Le client d’intégration et ses droits déterminent le compte et le périmètre d’écriture. Les identifiants externes relient chaque ressource à sa source.
Envoyez les données métier avec les métadonnées de synchronisation adaptées. L’idempotence permet de gérer les renvois sans multiplier les imports identiques.
Une réponse 202 indique que l’import est accepté pour traitement. Les contrôles et l’application des données peuvent se poursuivre de manière asynchrone.
Consultez le reçu. Les révisions de source et les snapshots, sur les ressources concernées, complètent le suivi des mises à jour et des rapprochements.
04 / Accès & dimensionnement
L’API utilise des jetons JWT. Les clients machine disposent de droits dédiés pour les imports catalogue, stock ou B2B. Les API de lecture suivent leurs propres autorisations : les accès sont préparés selon les flux retenus.
Fréquence, taille des imports, historique et pics d’activité : nous définissons les capacités et limites d’appel avec vous, selon votre serveur et vos besoins. Aucun débit universel ne remplace le dimensionnement de votre instance.
Instance cloud dédiée opérée par Dawap ou installation dans votre SI : CIAMA reste un produit sous licence. L’intégration tient compte de vos contraintes réseau, de vos systèmes sources et des modules activés.
05 / La référence technique
Méthodes, paramètres, schémas et réponses : la documentation Swagger de votre instance est la référence pour développer votre connexion. Cette page vous aide à choisir les flux ; elle ne duplique pas leurs contrats techniques.
/api/doc/api/doc.jsonL’adresse d’accès dépend de votre instance. Demandez la référence correspondant à votre version de CIAMA.
Obtenir l’accès à la documentation ↗Présentez-nous votre SI, les données à échanger et les volumes attendus. Nous définissons avec vous les accès, les ressources et les adaptations nécessaires.
Parler de mon intégration ↗