Web service API

Notre API est basée sur l'architecture REST.
Vous pouvez y accéder via le chemin /api/ depuis l'URL du site module de vente.
Par exemple : https://{{URL}}/api/{{RESOURCE}} -> https://e.votredomaine.com/api/.

Méthodes HTTP disponibles

La plupart des ressources sont accessibles avec ~~une ou plusieurs des~~les 4 méthodes principales de requêtes HTTP : GET, POST, PUT, DELETE ; sauf les ressources suivantes :

~~Clé~~Ressource	GET	POST	PUT	DELETE
evenements	✅	❌	✅	❌
stocks	✅	❌	✅	❌

Chaque ressource dispose de deux schémas qui sont accessibles via un paramètre à spécifier dans l'URL :

?schema=blank : retourne une arborescence XML vierge de la ressource. ?schema=synopsis : retourne une arborescence XML vierge de la ressource avec le format attendu pour chaque valeur ainsi que des indicateurs spécifiques (typage, longueur maximale...)

Ressources disponibles

Ressource
Description

adresses

Les adresses des clients
articles
Les articles
categories
Les catégories d'articles
clients
Les clients
enseignes
Les enseignes
evenements
Les évènements liés aux utilisateurs
lots_mercuriales
Lots des offres de prix et marchés
marques
Marques des articles
mercuriales
Offre de prix ou marché representants
Commerciaux
stocks
Stocks articles

Schéma "blank" d'une ressource

En affichant le schéma "vierge" d'une ressource, l'API vous retournera uniquement la structure et le nom des données. En prenant la ressource "client" comme exemple :

<?xml version="1.0" encoding="utf-8"?>
<ecare>
    <client>
        <code_enseigne/>
        <code_representant/>
        <date_modification>
            <![CDATA[]]>
        </date_modification>
        <designation>
            <![CDATA[]]>
        </designation>
        <minimum_de_commande/>
        <modalites_de_reglement>
            <![CDATA[]]>
        </modalites_de_reglement>
        <reference>
            <![CDATA[]]>
        </reference>
        <soumis_a_ecotaxe/>
        <soumis_a_tva/>
    </client>
</ecare>

Schéma "synopsis" d'une ressource

En affichant le schéma "synopsis", l'API vous retournera le schéma "blank" de la ressource, tout en vous indiquant le format attendu pour les données. En prenant de nouveau la ressource "client" comme exemple :

<?xml version="1.0" encoding="utf-8"?>
<ecare>
    <client>
        <code format="int" readOnly="true"/>
        <code_enseigne format="int"/>
        <code_representant format="int"/>
        <date_modification format="string" readOnly="true" pattern="yyyy-mm-dd"/>
        <designation format="string" maxLength="60"/>
        <minimum_de_commande format="double"/>
        <modalites_de_reglement format="string" maxLength="121"/>
        <reference format="string" maxLength="13"/>
    </client>
</ecare>