Documentation API Crisalid Websteri

Documentation de l'API Crisalid Websteri

Données de test

BaseUrl	http://testapi.crisalid.com
LOGIN	testapi
MOTDEPASSE	testapi

Authentification

Obtention d'un token :

BaseUrl/api/mailsteris/auth?login=LOGIN&password=MOTDEPASSE

Réponse :

          <authentification code="0">ICI UN TOKEN</authentification>

Articles

Obtention de la liste des articles :

BaseUrl/api/mailsteris/articles?token=TOKEN

Réponse :

          <articles>
            <article nom_complet="" famille="ENTREMET PâQUES" ref="09025013" id="260886" publie="V" prix="26.4" site="44" tva="5.5" tva_emportee="" disponible="V" points="0" position="1" description="" description_addon="" motscles_seo="" titre_seo="" description_seo="" webfamilles="">
              BÛCHE DE PAQUES
            </article>
            <article nom_complet="" famille="BUCHE DE NOEL" ref="08028007@04" id="261368" publie="V" prix="19.6" site="44" tva="5.5" tva_emportee="" disponible="V" points="0" position="2" description="" description_addon="" motscles_seo="" titre_seo="" description_seo="" webfamilles="">
              CARREMENT CHOCO 4 PERS
            </article>
            ...
          </articles>

Description de la réponse :

famille	string	nom de la famille d'article
nom_complet	string	nom complet de l'article
ref	string	référence du logiciel Crisalid XXXXXXXX[@XX]
id	integer	identifiant du logiciel Websteri (intermédiaire entre Crisalid et un système tier)
publie	boolean	V \| F
prix	float
tva	float	taux de TVA
tva_emportee	float	taux de TVA à emporter
disponible	boolean	V \| F : si l'article est disponible (en stock)
points	integer	Les points fidélités (points rapportés)
points-action	integer	Les points que "coûtent" l'article
bonus	float	Montant que rapporte l'article (fidélité)
hors-fidelite	boolean	Si l'article est pris en compte en fidélité (V\|F)
position	integer	La position des articles (permet le tri)
similar_products	string	Contient les ids des produits similaires séparés par des virgules
description	string	Contient une description
description_addon	string	Contient une seconde description, champs spécification (ingrédients par exemple)
valeur texte	string	nom de l'article
description_seo	string	Description pour le référencement
title_seo	string	Titre pour le référencement
motscles_seo	string	Mots-clés pour le référencement
webfamilles	tableau d'integer	id des webfamilles séparés par des ,

Création d'un article :

BaseUrl/api/mailsteris/new?token=TOKEN

new[ref]	string	référence de l'article
new[libelle]	string	libellé de l'article
new[prix]	float	prix de l'article (ex: 1.50)
new[tva]	float	taux de tva (ex: 20.0)
new[disponible]	boolean	article disponible à la vente (en stock) (V\|F)
new[publie]	boolean	article visible (V\|F)
new[famille]	string	libellé de la famille d'article
new[complement]	string	libellé complémentaire
new[poids]	float	poids de l'article
new[description]	string	description de l'article
new[plu]	string	PLU (price look-up)
new[points]	integer	Nombre de points rapporté par l'article (fidélité)
new[points-action]	integer	Nombre de points que "coûte" l'article (fidélité)
new[bonus]	float	Montant que rapporte l'article (fidélité)
new[hors-fidelite]	boolean	Si l'article est pris en compte en fidélité (V\|F)
new[selectionne]

Paramêtre :

Réponse :

Attention actuellement les articles créés dans Websteri ne sont pas créé dans la caisse.
Websteri ------X------> Logiciel Crisalid
Logiciel Crisalid -------------> Websteri

Mise à jour des articles :

BaseUrl/api/mailsteris/update?token=TOKEN

Paramêtre :

update[ID_ARTICLE][ref]	string	référence de l'article
update[ID_ARTICLE][libelle]	string	libellé de l'article
update[ID_ARTICLE][prix]	float	prix de l'article (ex: 1.50)
update[ID_ARTICLE][tva]	float	taux de tva (ex: 20.0)
update[ID_ARTICLE][disponible]	boolean	article disponible à la vente (en stock) (V\|F)
update[ID_ARTICLE][publie]	boolean	article visible (V\|F)
update[ID_ARTICLE][famille]	string	libellé de la famille d'article
update[ID_ARTICLE][complement]	string	libellé complémentaire
update[ID_ARTICLE][poids]	float	poids de l'article
update[ID_ARTICLE][description]	string	description de l'article
update[ID_ARTICLE][plu]	string	PLU (price look-up)
update[ID_ARTICLE][points]	integer	Nombre de points rapporté par l'article (fidélité)
update[ID_ARTICLE][points-action]	integer	Nombre de points que "coûte" l'article (fidélité)
update[ID_ARTICLE][bonus]	float	Montant que rapporte l'article (fidélité)
update[ID_ARTICLE][hors-fidelite]	boolean	Si l'article est pris en compte en fidélité (V\|F)
update[ID_ARTICLE][selectionne]

Réponse :

          <reponse>
            <article ref="00000000@01" id="289944" libelle="4 fromages" />
            <article ref="00000001@01" id="289945" libelle="Romaine" />
            <article ref="00000002@01" id="289946" libelle="Marguarita" />
          </reponse>

Obtention de la liste des attributs surchargés des articles par magasin :

BaseUrl/api/mailsteris/articles_par_magasin?token=TOKEN

Paramètre :

magasin_id (Optionnel)

integer

id du magasin (pour filtrer pour un magasin

Réponse :

          <magasins>
            <magasin id="5">
              <articles>
                <article id="1" ref="00000001@01" disponible="F" prix="" temps-de-fabrication="45" />
                <article id="2" ref="00000002@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="3" ref="00000003@01" disponible="F" prix="" temps-de-fabrication/>
                <article id="4" ref="00000004@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="5" ref="00000005@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="6" ref="00000006@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="7" ref="00000007@01" disponible="V" prix="3.0" temps-de-fabrication="" />
              </articles>
            </magasin>
            <magasin id="57">
              <articles>
                <article id="1" ref="00000001@01" disponible="F" prix="" temps-de-fabrication="60" />
                <article id="2" ref="00000002@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="3" ref="00000003@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="4" ref="00000004@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="5" ref="00000005@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="6" ref="00000006@01" disponible="F" prix="" temps-de-fabrication="" />
                <article id="7" ref="00000007@01" disponible="F" prix="" temps-de-fabrication="" />
              </articles>
            </magasin>
          </magasins>

Description de la réponse :

Pour les noeuds magasin

integer

identifiant du magasin

Pour les noeuds article

ref	string	référence du logiciel Crisalid XXXXXXXX[@XX]
id	integer	identifiant du produit
disponible	boolean	V \| F : disponibilité générale du produit dans le magasin
prix	float	Prix dans le magasin
temps-de-fabrication	integer	Temps de fabrication pour le magasin

Familles

Obtention de la liste des familles :

BaseUrl/api/mailsteris/familles?token=TOKEN

Réponse :

          <familles>
            <famille site="67" description="Patisserie" photo_url="" id="874">Patisserie</famille>
            <famille site="67" description="Traiteur" photo_url="" id="875">Traiteur</famille>
            ...
          </familles>

Description de la réponse :

description	string	description de la famille
photo_url	string	url de la photo de la famille d'article
id	integer	identifiant du logiciel Websteri
valeur texte	string	nom de la famille

La familles sont automatiquement créées lorsqu'un article y est rattaché.

Commandes

Obtention de la liste des commandes depuis la dernière synchro :

BaseUrl/api/mailsteris/commandes?token=TOKEN&last_check=DATE

last_check

string

date au format YYYY-MM-JJ hh:mm:ss

Réponse :


          <commandes count="1" synchro="22/11/2013 16:14:22">
            <commande mode_livraison="retrait" al_num="146372" magasin="125" id="84515" imprimee="non">
              <dates pour="23/11/2013 09:30:00" passee="22/11/2013 16:00:16" />
              <contenu>
                <article remise="0.0" ref_ext="00000001@01" points="0" ref="00000001@01" name="Romaine" tva="19.6" quantite="2" id="289945" prix="0.0">
                  Romaine
                  <commentaire /></article>
                <article remise="0.0" ref_ext="00000002@01" points="0" ref="00000002@01" name="Margarita" tva="19.6" quantite="3" id="289946" prix="8.5">
                  Margarita
                  <commentaire /></article>
                <article remise="0.0" ref_ext="00000000@01" points="0" ref="00000000@01" name="4 fromages" tva="19.6" quantite="1" id="289944" prix="10.0">
                  4 fromages
                  <commentaire>Sans fromage...</commentaire></article>
              </contenu>
              <livraison>
                <id>212824</id>
                <nom>Claudel</nom>
                <prenom>Sylvain</prenom>
                <adresse>40 avenue de la libération</adresse>
                <code_postal>57160</code_postal>
                <ville>Chatel Saint Germain</ville>
                <raison_sociale />
              </livraison>
              <facturation>
                <id>212824</id>
                <nom>Claudel</nom>
                <prenom>Sylvain</prenom>
                <adresse>40 avenue de la libération</adresse>
                <code_postal>57160</code_postal>
                <ville>Chatel Saint Germain</ville>
                <raison_sociale />
              </facturation>
              <montant total_ht="29.69" frais_port="0">35.5</montant>
              <acompte type_reglement="Multiple" id_reglement="8">3.55</acompte>
              <remise>0.0</remise>
              <commentaire>Commentaire de la commande</commentaire>
            </commande>
          </commandes>

Noeud commande
count	integer	nombre de commande
synchro	string	date heure de dernière synchro
mode_livraison	string	(retrait\|livraison)
al_num	string	numéro de commande (non séquentiel)
magasin	integer	id du magasin dans lequel le retrait est prévu
id	integer	id de commande dans Websteri
Noeud dates
pour	integer	JJ/MM/AAAA hh:mm:ss
passee	integer	JJ/MM/AAAA hh:mm:ss

Enregistrement d'une commande :

BaseUrl/api/mailsteris/record_a_command?token=TOKEN

Paramètre :

xml

string

xml de la commande (ci-dessous un xml d'exemple)

Note par rapport à cet exemple :
/commande/facturation/id est vide si vous créez un nouveau contact ou n'avez pas connaissance de l'id dans websteri
/commande/livraison/id est vide si vous créez un nouveau contact ou n'avez pas connaissance de l'id dans websteri
/commande/al_num a pour valeur 0, websteri renvoie son id dans la réponse
/commande/id a pour valeur 0, websteri renvoie son id dans la réponse
/commande/contenu/article/prix a pour valeur (ttc unitaire * quantité)

Xml d'exemple :


          <commande mode_livraison="retrait" al_num="0" magasin="125" id="0" imprimee="non">
            <dates pour="23/11/2013 09:30:00" passee="22/11/2013 16:00:16" />
            <contenu>
              <article remise="0.0" ref_ext="00000001@01" points="0" ref="00000001@01" name="Romaine" tva="19.6" quantite="2" id="289945" prix="0.0">
                Romaine
                <commentaire /></article>
              <article remise="0.0" ref_ext="00000002@01" points="0" ref="00000002@01" name="Margarita" tva="19.6" quantite="3" id="289946" prix="8.5">
                Margarita
                <commentaire /></article>
              <article remise="0.0" ref_ext="00000000@01" points="0" ref="00000000@01" name="4 fromages" tva="19.6" quantite="1" id="289944" prix="10.0">
                4 fromages
                <commentaire>Sans fromage...</commentaire></article>
            </contenu>
            <livraison>
              <id></id>
              <nom>Claudel</nom>
              <prenom>Sylvain</prenom>
              <adresse>40 avenue de la libération</adresse>
              <code_postal>57160</code_postal>
              <ville>Chatel Saint Germain</ville>
              <raison_sociale />
            </livraison>
            <facturation>
              <id></id>
              <nom>Claudel</nom>
              <prenom>Sylvain</prenom>
              <adresse>40 avenue de la libération</adresse>
              <code_postal>57160</code_postal>
              <ville>Chatel Saint Germain</ville>
              <raison_sociale />
            </facturation>
            <montant total_ht="29.69" frais_port="0">35.5</montant>
            <acompte type_reglement="Multiple" id_reglement="8">3.55</acompte>
            <remise>0.0</remise>
            <commentaire>Commentaire de la commande</commentaire>
          </commande>

Réponse :

          <commande mode_livraison="retrait" al_num="146372" magasin="125" id="84515" imprimee="non">
            <dates pour="23/11/2013 09:30:00" passee="22/11/2013 16:00:16" />
            <contenu>
              <article remise="0.0" ref_ext="00000001@01" points="0" ref="00000001@01" name="Romaine" tva="19.6" quantite="2" id="289945" prix="0.0">
                Romaine
                <commentaire /></article>
              <article remise="0.0" ref_ext="00000002@01" points="0" ref="00000002@01" name="Margarita" tva="19.6" quantite="3" id="289946" prix="8.5">
                Margarita
                <commentaire /></article>
              <article remise="0.0" ref_ext="00000000@01" points="0" ref="00000000@01" name="4 fromages" tva="19.6" quantite="1" id="289944" prix="10.0">
                4 fromages
                <commentaire>Sans fromage...</commentaire></article>
            </contenu>
            <livraison>
              <id>212824</id>
              <nom>Claudel</nom>
              <prenom>Sylvain</prenom>
              <adresse>40 avenue de la libération</adresse>
              <code_postal>57160</code_postal>
              <ville>Chatel Saint Germain</ville>
              <raison_sociale />
            </livraison>
            <facturation>
              <id>212824</id>
              <nom>Claudel</nom>
              <prenom>Sylvain</prenom>
              <adresse>40 avenue de la libération</adresse>
              <code_postal>57160</code_postal>
              <ville>Chatel Saint Germain</ville>
              <raison_sociale />
            </facturation>
            <montant total_ht="29.69" frais_port="0">35.5</montant>
            <acompte type_reglement="Multiple" id_reglement="8">3.55</acompte>
            <remise>0.0</remise>
            <commentaire>Commentaire de la commande</commentaire>
          </commande>

Webfamilles

Obtention de la liste des webfamilles

BaseUrl/api/mailsteris/webfamilles?token=TOKEN

Réponse :

                      <?xml version="1.0" encoding="UTF-8"?>
            <webfamilles>
              <webfamille webfamille-parente="" id="1">Famille1</webfamille>
              <webfamille webfamille-parente="" id="2">Famille2</webfamille>
              <webfamille webfamille-parente="" id="3">Famille3</webfamille>
              <webfamille webfamille-parente="1" id="4">Famille1.1</webfamille>
              <webfamille webfamille-parente="1" id="5">Famille1.2</webfamille>
              <webfamille webfamille-parente="2" id="6">Famille2.2</webfamille>
              <webfamille webfamille-parente="4" id="7">Famille1.1.1</webfamille>
            </webfamilles>

webfamille-parente	integer	id de la famille parente dans l'arborescence
id	integer	id de la famille
Noeud texte webfamille	string	Nom de la famille

Moyens de paiement et points de vente

Obtention d'éléments de la configuration (type de réglement et point de vente):

BaseUrl/api/mailsteris/config?token=TOKEN

Réponse :

                      <config>
              <reglements>
                <reglement id="1">Chèque</reglement>
                <reglement id="2">Espèce</reglement>
                <reglement id="3">Carte Bleue</reglement>
                <reglement id="4">Paiement en ligne</reglement>
                <reglement id="6">Tickets restaurants</reglement>
                <reglement id="7">Avoirs fidélités</reglement>
                <reglement id="8">Multiple</reglement>
                <reglement id="9">Multiple</reglement>
                <reglement id="10">Multiple</reglement>
              </reglements>
              <magasins>
                <magasin id="125">Point de vente de test</magasin>
              </magasins>
            </config>

Points de vente

Récupération de la liste des points de vente

BaseUrl/api/mailsteris/get_subsidiaries?token=TOKEN

Réponse :

                      <subsidiaries type="array">
              <subsidiary>
                <opening-for-api>
                  <saturday></saturday>
                  <monday>9-12,14-18</monday>
                  <sunday></sunday>
                  <tuesday>9-12,14-22</tuesday>
                  <wednesday>9-12,14-18</wednesday>
                  <thursday>9-12,14-18</thursday>
                  <friday>11-12,13-16</friday>
                </opening-for-api>
                <position type="integer" nil="true"/>
                <number type="integer" nil="true"/>
                <name>Nom du point de vente</name>
                <id type="integer">6</id>
                <id-paypal type="integer" nil="true"/>
                <address>40 avenue de la libération</address>
                <updated-at type="datetime">2009-05-14T19:55:22+02:00</updated-at>
                <phone>03 87 65 98 80</phone>
                <mail>contact@crisalid.com</mail>
                <site-id type="integer">6</site-id>
                <designation nil="true"/>
                <city>Metz</city>
                <make-hour type="integer" nil="true"/>
                <created-at type="datetime">2009-05-13T16:12:53+02:00</created-at>
                <code-progial nil="true"/>
                <fax nil="true"/>
                <postcode>57000</postcode>
                <picture-id type="integer" nil="true"/>
              </subsidiary>
            </subsidiaries>

Pour les horaires dans le noeud xml opening-for-api :

Horaire
Valeur	Signification
810-1230	8h10 à 12h30
0810-1230	8h10 à 12h30
8-1230	8h00 à 12h30
8-12	8h00 à 12h00
8-12,13-16	8h00 à 12h00 13h00 à 16h00
Pas de valeur	Fermé

Historique de mise à jour

17/11/2014 : Ajout des champs concernant la fidélité

10/11/2014 : Ajout des horaires des points de vente

07/11/2014 : Ajout de l'url pour les webfamilles

02/10/2014 : TVA à emporter et description_addon, et champs référencements dans la fiche article, webfamilles, et filtre par magasin pour articles_par_magasin

29/09/2014 : Du champs description et description_addon dans la récupération des articles et des temps de préparation par magasin

24/07/2014 : Ajout des attributs surchargés par magasin (articles_par_magasin)

07/04/2014 : Précision sur l'attribut prix dans le noeud article

28/03/2014 : Erreur : changement de la route pour la configuration (paiement et point de vente)

27/03/2014 : Ajout de la récupération des points de ventes

22/11/2013 : Documentation de l'API