pmw readme
DESCRIPTION
webservicesTRANSCRIPT
-
Web Service PMW (mis jour le 05/05/2015)
WebService Catalogue
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/catalogue.php
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {langue: chaine alphanumrique (FR, EN)
}
Si la langue n'est pas prcise lors de l'appel c'est la langue franaise qui est prise en compte. Pour le moment O-Chateau a configur son systme en anglais (EN) et franais (FR) uniquement.
Description
Liste tous les cpages, modles, AOC et les rgles associes. Le service retourne l'intgralit du contenu de la base de donnes.Les donnes sont au format JSON encod en UTF8.
On distingue 4 groupes de donnes :
cpages modles aoc profils images produit option
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Exemple de fichier JSON
{ "cepages": [ { "id": "1", "nom": "Cabernet Franc", "region": "Bordeaux", "bois": "1", "degre": "0.00", "prof1": "1", "prof2": "2", "prof3": "3", "prof4": "4", "des": "......", "apport": ".......", "vue": "........", "odorat": ".........", "gout": "............", "img1": "..........................", "img2": "" }, { "id": "2", "nom": "Petit Verdot", "region": "Bordeaux", "bois": "0", "degre": "0.00", "degre": "0.00", "prof1": "1", "prof2": "2", "prof3": "3", "prof4": "4", "des": "......", "apport": ".......", "vue": "........", "odorat": ".........", "gout": "............", "img1": "..........................", "img2": "" } ], "modeles": [ { "idm": "1", "cat": "GV", "region": "Bordeaux", "nom": "Vin type Medoc", "producteur": "Chateau XXXX",
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
"aoc": "1", "mise_en_avant": "1", "photo": "http://www.beenbiz.com/o-chateau/photo-produits/P_pmw_1.jpg", "composition": [ { "idc": "1", "part": "10" }, { "idc": "2", "part": "80" }, { "idc": "1", "part": "13" } ], "boise": "0", "des": "" } ], "aoc": [ { "ida": "1", "region": "Bordeaux", "nom": "MEDOC", "aoc_certifie": "1", "regles": [ { "idc": "1", "min": "15", "max": "30" }, { "idc": "2", "min": "15", "max": "30" } ], "rg_cep": "1", "rg_op": "LE", "rg_percent": "23" } ],"profils": { "p1": { "1": ".....", "2": ".....", "3": ".....", "4": ".....",
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
"5": "....." , "titre": "....." }, "p2": { "1": ".....", "2": ".....", "3": ".....", "4": ".....", "5": ".....", "titre": "....." }, "p3": { "1": ".....", "2": ".....", "3": ".....", "4": ".....", "5": ".....", "titre": "....." }, "p4": { "1": ".....", "2": ".....", "3": ".....", "4": ".....", "5": ".....", "titre": "....." }, "images": { "img_fond": [ "http://www.beenbiz.com/o-chateau/media/454.jpg", "http://www.beenbiz.com/o-chateau/media/456.jpg" ], "img_etiquette": [ "http://www.beenbiz.com/o-chateau/media/457.png", "http://www.beenbiz.com/o-chateau/media/455.jpg", "http://www.beenbiz.com/o-chateau/media/453.jpg" ] }, "produit": [ { "id": "88", "code": "PMW_BOUT", "titre": null, "tarif_unite": "U", "tarif": "19.90", "option": "38,39" } ], "option": [ {
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
"id": "38", "code": "PMW_CaisseBois", "titre": "Caisse Bois", "description": "", "tarif_unite": "U", "tarif": "10.00" }, { "id": "39", "code": "PMW_Contre", "titre": "Contre Etiquette", "description": "", "tarif_unite": "U", "tarif": "5.00" } ]
}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Dictionnaire de donnes :
cpagesid entier Identifiant de la base de donnes nom Chaine alphanumriqueregion Chaine alphanumriqueregionDes Chaine alphanumrique Descriptif de la rgionbois entier 0 ou 1 pour indiquer si le cpage est
bois ou nondegr dcimal % (0-100)prof1 entier Valeur de 1 5prof2 entier Valeur de 1 5prof3 entier Valeur de 1 5prof4 entier Valeur de 1 5des Chaine alphanumrique Descriptif du cpageapport Chaine alphanumrique Apport au vinvue Chaine alphanumrique Caractristique Organoleptique Vueodorat Chaine alphanumrique Caractristique Organoleptique
Odoratgout Chaine alphanumrique Caractristique Organoleptique Gotimg1 Chaine alphanumrique URL web de l'image 1img2 Chaine alphanumrique URL web de la carte rgion
modlesidm entier Identifiant de la base de donnes cat Chaine alphanumrique Peut avoir l'une des trois valeurs
suivantes :"VT"=>"Vin Type""GV"=>"Grand Vin""VP" => "Vin VIP"
rgion Chaine alphanumriquenom Chaine alphanumriqueproducteur Chaine alphanumriqueaoc entier Rfrence (ID) de l'AOCphoto Chaine alphanumrique URL complte du fichier image
lorsqu'il existemise_en_avant entier 0 ou 1
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
composition tableau(1 n) rfrences de cpages- idc : ID du cpage, voir cpages - part : % (0-100)
boise entier 0 ou 1description Chaine alphanumrique Description du modle
aocida entier Identifiant de la base de donnes rgion Chaine alphanumriquenom Chaine alphanumriqueaoc_certifie entier 0 ou 1rgles tableau (1 n) rgles
- idc : ID du cpage, voir cpages - min : % minimum (0-100) - max : % maximum (0-100)
rg_cep Chaine alphanumrique Liste des id cpages concerns par la rgle de cumul gnral de l'AOC.Chaque id est spar par une virgule.Si aucune rgle n'est dfinie la chaine est vide.
rg_op Chaine alphanumrique Indique l'oprateuur :
"GT" => ">","LT" => "=","EQ" => "="
rg_percent entier Pourcentage applicable
profilsp1 Axe 1 : De 1 5
+ titre (traduction de Axe 1)correspond aux traductions de chaque niveau de profil organoleptiquevoir prof1 dans cpages
p2 Axe 2 : De 1 5+ titre (traduction de Axe 1)correspond aux traductions de chaque niveau de profil organoleptiquevoir prof2 dans cpages
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
p3 Axe 3 : De 1 5+ titre (traduction de Axe 1)correspond aux traductions de chaque niveau de profil organoleptiquevoir prof3 dans cpages
p4 Axe 4: De 1 5+ titre (traduction de Axe 1)correspond aux traductions de chaque niveau de profil organoleptiquevoir prof4 dans cpages
imagesimg_fond Chaine alphanumrique Images de fond
URL complteimg_etiquette Chaine alphanumrique Images de fond
URL complteProduit
id entier ID uniquecode Chaine alphanumrique Code produittitre Chaine alphanumriquetarif_unite 1 caractre P : par personne (adulte, enfant)
U : l'unitG : par tranche
tarifoption Liste des ID option Voir la correspondance dans option
Optionid entier Id uniquecode Chaine alphanumriquetitre Chaine alphanumriquedescription Chaine alphanumriquetarif_unite P : par personne (adulte, enfant)
F : forfaitaire quelque soit la quantitG : par trancheU : l'unit
tarif
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
WebService login
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/login.php
Description :
Connexion au compte client soit par la mthode FaceBook soit par la mthode BeeNbiz.Retourne le profil du client :
coordonnes historique des commandes etiquettes
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {login : chaine alphanumrique,pass : chaine alphanumrique,mode : FB (facebook) ou BB (beeNbiz) ou GG (Google)
}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Valeurs retournes :
En cas d'erreur
{"erreur" : "numro de l'erreur","erreurDescription" : "descriptif de l'erreur"
}
En cas de succs
{"erreur" : "0","erreurDescription" : "ok",
"client" :{"temp_id" : "chaine de 32 caractres","first_name" : "xxxxx","last_name" : "xxxx","email" : "xxxx",
},"commandes" : [
{"numero" :"","date" :"","objet_commande" :"","remarque" :"","assemblage" :"",},
etc ...],"etiquettes" :[
{"etiquette_recto_png": "",
"etiquette_recto_svg": "", "etiquette_verso_png": "", "etiquette_verso_svg": ""
},etc ...
]}
temp_id est un identifiant unique qui permet d'appeler le service de login sans passer par le couple de donnes login/pass
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice logout
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/logout.php
Description :
Deconnexion du compte
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {temp_id : chaine alphanumrique (ID dlivr suite l'appel du service de login)
}
Valeurs retournes :
En cas d'erreur
{"erreur" : "numro de l'erreur","erreurDescription" : "descriptif de l'erreur"
}
En cas de succs
{"erreur" : "0","erreurDescription" : "ok"
}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
WebService inscription
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/inscription.php
Description :
Cration d'un compte
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {login : chaine alphanumrique,pass : chaine alphanumrique,first_name: chaine alphanumrique,last_name: chaine alphanumrique
}
Valeurs retournes :
En cas d'erreur
{"erreur" : "numro de l'erreur","erreurDescription" : "descriptif de l'erreur"
}
En cas de succs
{"erreur" : "0","erreurDescription" : "ok","temp_id" : identifiant unique (chaine de 32 caractres)
}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
WebService mot de passe oubli
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/mot_de_passe_oublie.php
Description :
Envoie par mail le mot de passe
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {login : chaine alphanumrique}
Valeurs retournes :
En cas d'erreur
{"erreur" : "numro de l'erreur","erreurDescription" : "descriptif de l'erreur"
}
En cas de succs
{"erreur" : "0","erreurDescription" : "ok"
}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
WebService modifier mon compte
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/modifier_mon_compte.php
Description :
Envoie par mail le mot de passe
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {"login": "","pass": "" ,"first_name": "","last_name": "","new_pass": ""
}
Login et Pass sont obligatoires. Seuls les paramtres passs dans la chaine JSON sont modifis.Si new_pass n'est pas renseign, le mot n'est pas modifi.
Valeurs retournes :
En cas d'erreur
{"erreur" : "numro de l'erreur","erreurDescription" : "descriptif de l'erreur"
}
En cas de succs
{"erreur" : "0","erreurDescription" : "ok"
}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
WebService commande
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/ajoutCommande.php
Description :
JSON passer en post
{ "login": "webOCPMW75", "pass": "75zy99wu", "temp_id": " chaine de 32 caractres ", "langue": "FR", "code": "PMW_Bout", "quantite": 1, "prix": 30, "nom": "Client Test", "prenom": "robert", "email": "[email protected]", "option": [ { "code": "PMW_VINBOISE", "quantite": "1", "prix": 5 }, { "code": "PMW_CaisseBois", "quantite": "1", "prix": 10 } ], "pmw": { "etiquette_recto_png": "", "etiquette_recto_svg": "", "etiquette_verso_png": "", "etiquette_verso_svg": "", "assemblage": "", "livraison": "", "facturation": "" }}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Descriptions des variables
login Obligatoire si pas de temp_id webOCPMW75pass Obligatoire si pas de temp_id 75zy99wu temp_id Obligatoire si pas de login +
passChaine de 32 caractres dlivre lors du login
langue obligatoirecode obligatoire Code du produit TourBizquantite obligatoireprix obligatoirenom obligatoireprenom obligatoireemail obligatoire
option facultatif Tableau avec pour chaque option- code- quantite- prix
pmw tableauetiquette_recto_png Champ blobetiquette_recto_svg Champ text
etiquette_verso_png Champ blobetiquette_verso_svg Champ texte
assemblage Champ texte Format JSONlivraison Champ texte Format JSON
facturation Champ texte Format JSON
Valeurs retournes :
JSON
{erreur : 0,erreur_message : '' id_commande : '100'
}
si erreur = 1 => commande non valide erreur_message contient le libell du messageid_commande n'est pas renseign
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice livraison
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/livraison.php
Description :
JSON passer en post
demande = {"code_pays" : "FR","paris" : "1","langue": "FR"
}
code_pays : format ISO sur deux caractresparis : 0 ou 1langue : 2 caractres
retourne un JSON dcrivant les options de livraison proposes.
Voir la description du service catalogue (rubrique option) pour l'explication du format.
Optionid entier Id uniquecode Chaine alphanumriquetitre Chaine alphanumriquedescription Chaine alphanumriquetarif_unite P : par personne (adulte, enfant)
F : forfaitaire quelque soit la quantitG : par trancheU : l'unit
tarif
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice paiement par carte bancaire
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/pcb.php
JSON passer
demande={"langue" : "FR","id_commande" : "66522"
}
Langue :
id_commande : l'id retourn par le service ajoutCommande
Si l'appel est autoris, le serveur retourne le code HTML du formulaire appeler.
Sur le serveur 2 pages sont configurer :
erreur-reglement.htmok-reglement.htm
En fin de rglement le client est dirig soit vers la page ok-reglement.htm soit vers erreur-reglement.htm
IMPORTANT :
Le serveur banque est en mode production car utilis par O-chateau. Donc toute tentative d'appel correspond une vritable demande.
Il reste valider avec Nicolas la procdure (envoi de mail ) suite au retour de banque positif. Bien que dj configure dans TourBiz il y aura sans doute des adaptations spcifiques pour PMW.
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice Catalogue boutique (vente sur place)
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/catalogue-boutique.php
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {langue: chaine alphanumrique (FR, EN)
}
Si la langue n'est pas prcise lors de l'appel c'est la langue franaise qui est prise en compte. Pour le moment O-Chateau a configur son systme en anglais (EN) et franais (FR) uniquement.
Produit tableauid ID unique du produitcode Code du produitTitre Libell du produit dans la langue appeledescription Descriptif dans la langue appleepaysregionaoccouleurproprietairemillesimecepagescuveevolumetaux_alcooltarif_unite U : prix par bouteilletarif Prix unitaireoption Liste des options (cf voir catalogue PMW pour
la description)image_1 URL de l'image 1 image_2 URL de l'image 2Option Tableau des options rattaches aux produits
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Exemple de rsultat
{ "produit": [ { "id": "94", "code": "BT_PMW_BORDEAUX_2", "titre": "Bordeaux 2", "description": "", "pays": "", "region": "", "aoc": "", "couleur": "", "proprietaire": "", "millesime": "", "cepages": "", "cuvee": "", "volume": "", "taux_alcool": "", "tarif_unite": "U", "tarif": "50.00", "option": "", "image_1": "", "image_2": "" },etc]}
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice Liste Images utilisateur
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/get-image.php
Mthode d'appel :
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {temp_id : chaine alphanumrique
}
Retourne un tableau JSON avec la liste des images de l'utlisateur
Webservice Poster une Image utilisateur
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/put-image.php
Appel en Post via formulaire
image temp_id
Exemple de formulaire :
Image
Retoune le tableau JSON actualis des images utilisateur
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice liste des tiquettes utilisateur
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/get-etiquette.php
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {temp_id : chaine alphanumrique
}
Retourne la liste des tiquettes au format JSON
[{
svg : xxxxx,png : xxxxx
},{
svg : xxxxx,png : xxxxx
},etc ]
Webservice liste des tiquettes administrateur
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/get-etiquette-admin.php
Retourne la liste des tiquettes au format JSON pour le compte [email protected]
[{
svg : xxxxx,png : xxxxx
},{
svg : xxxxx,png : xxxxx
},etc ]
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice Poster une etiquette utilisateur
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/put-etiquette.php
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {temp_id : chaine alphanumrique,svg : XXXXX ,png : xxxxxxx
}
Retourne la liste actualise des tiquettes au format JSON
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice Promo (la liste des promotions)
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/promo.php
Retourne la liste des promotions au format JSON
[ { "titre": "Wine tasting", "description": "Wine tasting", "url": "http://www.o-chateau.com/book-your-wine-tasting-in-paris", "image": "http://www.beenbiz.com/o-chateau/photo-produits/P_pmw_promo1_1.jpg" },
etc ...]
Webservice aide
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/aide.php
Retourne la liste des textes d'aide au format JSON
[ { "code": "home", "description_1": "description", "description_2": "description", "description_3": "description", "image_1": "url photo 1", "image_2": "url photo 2", "image_3": "url photo 3" }]
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice code promo
URL appeler :
http://beenbiz.com/o-chateau-itsmywine/webservice/code-promo.php
Post / UTF8 paramtres transmettre au format JSON dans une variable nomme demande
demande = {code : chaine alphanumrique,date_prestation: YYYY-MM-DD ,date_reservation : YYYY-MM-DD
}
Ces trois valeurs sont obligatoires
Rsultat retourn
Tableau JSON
erreur 0 ou 1 (si erreur)code_erreur Chaine alphanumriquemessage_erreur Chaine alphanumriqueapplicable_produit Si est gal 1
ne s'applique qu'aux produits lists dans liste_produit sinon s'applique toute la commande
liste_produit Tableau contenant la liste des codes produits auxquels s'applique le code promotion
pourcentage Si est gal 1 indique que la rduction est applique en pourcentage
montant Montant de la rduction
WMS WEBSERVICE PMW document mis jour le 05/05/2015
-
Webservice save data
Sauvegarde une chaine de caractre sous forme de clef / valeur
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/save-data.php
Mthode Post
Paramtres :
clef Chaine alphanumrique de 50 caractres maxdata Les donnes sauvegarder
Webservice get data
Rcupre une chaine de caractre partir de sa clef
URL appeler :
http://beenbiz.com/o-chateau-pmw/webservice/get-data.php
Mthode Post
Paramtre :
clef Chaine alphanumrique de 50 caractres max
WMS WEBSERVICE PMW document mis jour le 05/05/2015