KinTPV

Documentation

Outils pour utilisateurs

Outils du site


manuel:module-dev

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

manuel:module-dev [19/10/2018 21:26] (Version actuelle)
Ligne 1: Ligne 1:
 +README
 +
 +====== Créer son propre module ======
 +
 +Si vous souhaitez développer votre propre module intermédiaire entre KinTPV et votre site-web, nous ne pouvons que vous conseiller de suivre cette démarche (réservé aux développeurs) :
 +
 +**Envoi des articles sur votre page web**
 +1- Connexion au site-web pour récupérer un cookie.
 +2- Emission d'une requête pour recevoir un jeton d'autorisation. (**action=get_token**)
 +3- Transmission des articles selon le fichier .xml fourni (XML directement dans la requête, voir <a href="doc/kintpv_v6/Envoi_article.xml">**__ l'exemple __**) (**action=data&token=xxx**)
 +4- Emission d'une requête pour le traitement du fichier XML (**action=exec&token=xxx**)
 +5- Transmission des images d'illustration pour les articles (avec une requête par image) (**action=image_art&idarticle=xxxx&codebare=xxxxxx&num=xxx&token=xxx**)
 +6- Transmission des images correspondants aux critères (une requête par image) (**action=image&type=[nomducritere]&nom=[libelleducritere]&token=xxx**)
 +
 +
 +====== Import des commandes depuis le Web ======
 +La récupération des commandes passées depuis le site Web se fait par un appel à un XML depuis KinTPV.\\ 
 +Cet XML doit posséder des données spécifiques pour identifier parfaitement les ventes (Numéro de vente, code barre article vendu, informations sur le client).\\ 
 +Dans l'interface de caisse de KinTPV, il faut alors traiter chaque commande pour la transformer en ticket et valider ainsi la vente.\\ 
 +Une fois les commandes traitées, un export partiel vers le site Web est possible pour une mise à jour des stocks.\\ 
 +
 +\\ 
 +Vous pouvez forcer la récupération des ventes Web en utilisant le bouton &#8220;Récupération des ventes Web (FTP)&#8221; depuis le menu &#8220;Divers&#8221; de KinTPV.\\ 
 +Mais il est aussi possible de paramétrer KinTPV pour qu'il interroge de de manière automatisée et dans des intervalles de temps réguliers votre serveur Web. Lorsque KinTPV a récupéré des commandes Internet non traitées, une petite ic&ocirc;ne clignote dans le coin supérieur gauche du sommaire général de KinTPV ou le bouton &#8220;Vente Web&#8221; présent dans l'interface de caisse apparait sur fond rouge. Il vous faut alors valider manuellement et une à une ces commandes.\\ 
 +Depuis l'interface de caisse, cliquez sur le bouton &#8220;Vente Web&#8221;, une nouvelle interface s'ouvre et vous affiche par défaut la liste des commandes Internet récupérées mais non traitées, cliquez sur un élément de la liste, vérifiez les données puis faites &#8220;Transformer en ticket&#8221;. Pour valider et traiter l'achat effectué sur le site marchand, validez tout simplement le ticket comme s'il s'agissait d'une vente au comptoir.\\ 
 +
 +Les balises "VT_NumUniqueWeb" et "VT_CodeOrigineVente" permettent d'identifier une commande dans KinTPV et savoir si celle-ci a déjà été traitée. Il est impératif que le serveur Internet génère un code numérique unique par commande (incrémental) pour la balise "VT_NumUniqueWeb".\\ 
 +
 +Pour la gestion des frais de port, il suffit d'ajouter un bloque <DETAIL>, à comptabiliser dans le "VT_NbDetails", avec la configuration ci-dessous :\\ 
 +<DETAIL>\\ 
 + <VT_IdArticle/> //non obligatoire//\\ 
 + <VT_CodeBarre/> //Lien vers l'article de type "frais de port".//\\ 
 + <VT_Reference/> //non obligatoire//\\ 
 + <VT_Qte/> // = 1//\\ 
 + <VT_PrixVente/> //Prix UNITAIRE TTC payé pour les frais de port.//\\ 
 + <VT_Type/> //Indiquer le type de ligne "PORT".//\\ 
 + <VT_TauxTaxe/> //Indiquer le taux de taxe pour le frais de port.//\\ 
 +</DETAIL>\\ 
 +
 +\\ 
 +Structure brut du fichier XML à envoyer à KinTPV : \\ 
 +
 +<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>\\ 
 +<KINTPV>\\ 
 +  <VENTE>\\ 
 +    <VT_NumUniqueWeb/>\\ 
 +    <VT_CodeOrigineVente/>\\ 
 +    <VT_IdVendeurKinTPV/>\\ 
 +    <VT_MontantVente/>\\ 
 +    <VT_CodeClient/>\\ 
 +    <VT_Date/> //format = JJ/MM/AAAA//\\ 
 +    <VT_Heure/> //format = HH:MM:SS//\\ 
 +    <LV_Nom/>\\ 
 +    <LV_Adresse/>\\ 
 +    <CLI_Civilite/>\\ 
 +    <CLI_Prenom/>\\ 
 +    <CLI_Nom/>\\ 
 +    <CLI_Societe/>\\ 
 +    <CLI_Adr1/>\\ 
 +    <CLI_Adr2/>\\ 
 +    <CLI_Adr3/>\\ 
 +    <CLI_Adr4/>\\ 
 +    <CLI_CodePostal/>\\ 
 +    <CLI_Ville/>\\ 
 +    <CLI_IdPays/>\\ 
 +    <CLI_DateNaissance/>\\ 
 +    <CLI_TelM/>\\ 
 +    <CLI_TelP/>\\ 
 +    <CLI_TelT/>\\ 
 +    <CLI_Email/>\\ 
 +    <CLI_TypeFactImpr/> \\ 
 +    <VT_Commentaire/>\\ 
 +    <VT_NbDetails/>\\ 
 +    <VT_Etat/>\\ 
 +    <DETAIL>\\ 
 +      <VT_IdArticle/>\\ 
 +      <VT_CodeBarre/>\\ 
 +      <VT_Reference/>\\ 
 +      <VT_Qte/>\\ 
 +      <VT_PrixVente/>\\ 
 +      <VT_Type/>\\ 
 +      <VT_TauxTaxe/>\\ 
 +    </DETAIL>\\ 
 +    <REGLEMENT>\\ 
 +      <RG_IdTypeReglement/>\\ 
 +      <RG_Montant/>\\ 
 +    </REGLEMENT>\\ 
 +  </VENTE>\\ 
 +</KINTPV>\\ 
 +
 +ATTENTION : \\ 
 +  * La balise <VT_CodeOrigineVente/> //Code origine de la vente (10 caractères, préfixe du N&deg; de commande)//\\ 
 +  * La balise <VT_IdVendeurKinTPV/> //Numéro unique de lien du vendeur avec KinTPV (se trouve dans la liste des vendeurs)//\\ 
 +  * La balise <VT_CodeClient/> //Code unique du client (Lien avec KinTPV pour retrouver le client)//\\ 
 +  * La balise <CLI_IdPays/> //Numéro unique de lien du pays avec KinTPV (Il est possible d'importer les pays dans KinTPV)//\\ 
 +  * La balise <CLI_TypeFactImpr/> //Type d'impression des factures : 1 ou 0 = Standard avec règlement, 2 = Sans règlement, avec ligne HT//\\ 
 +  * La balise <VT_NbDetails/> //Doit comptabiliser le nombre de lignes de vente + le nombre de lignes de règlement. //\\ 
 +  * La balise <VT_Etat/> //Etat de la commande web (2 = VALIDEE; 1= NON VALIDEE)//\\ 
 +  * La balise <VT_IdArticle/> //Numéro unique de l'article dans KinTPV (non obligatoire)//\\ 
 +  * La balise <VT_Qte/> //Quantité commandée//\\ 
 +  * La balise <VT_Reference/> //Référence spécifique KinTPV (IdArticle + CodeDeclinaison) (non obligatoire)//\\ 
 +  * La balise <VT_CodeBarre/> //Code barre de l'article**(Lien à utiliser pour retrouver l'article dans KinTPV)**//\\ 
 +  * La balise <VT_PrixVente/> //Prix UNITAIRE TTC de l'article vendu.//\\ 
 +  * La balise <VT_Type/> //Indique le type de ligne "ARTICLE".//\\ 
 +  * La balise <VT_TauxTaxe/> //Indique le taux de taxe utilisé pour la vente de l'article (par exemple : 19,6).//\\ 
 +  * La balise <RG_IdTypeReglement/> //Correspond au N&deg; de règlement dans le logiciel KinTPV.//\\ 
 +
 +\\ 
 +Liste des N&deg; de règlement dans KinTPV :\\ 
 +
 +231 -> Espèces\\ 
 +232 -> Chèque\\ 
 +233 -> Carte\\ 
 +234 -> Carte Expr.\\ 
 +235 -> Carte Aurore\\ 
 +236 -> Autre Carte\\ 
 +237 -> Reprise crédit client\\ 
 +240 -> Carte BANCONTACT\\ 
 +241 -> Carte VISA\\ 
 +242 -> Carte MAESTRO\\ 
 +243 -> Chèque Fidélité\\ 
 +244 -> Carte CETELEM\\ 
 +245 -> Carte SOFINCO\\ 
 +246 -> Mastercard\\ 
 +247 -> American Express\\ 
 +248 -> Carte Fidélidé\\ 
 +249 -> Virement\\ 
 +250 -> Paiement Internet\\ 
 +251 -> Ticket Restaurant\\ 
 +252 -> PayPal\\ 
 +261 -> Reprise acompte client\\ 
 +305 -> Rendu\\ 
 +306 -> Rendu hors espèces\\ 
 +
 +
 +====== Import des S.A.V. (Dép&ocirc;t Client) ======
 +Lors de la récupération des commandes depuis le web, il est possible de récupérer les fiches de S.A.V.\\ 
 +Cette récupération est directement ajoutée dans la gestion des S.A.V. de KinTPV suivant la balise <SAV_RefUnique/>.\\ 
 +Si cette référence existe déjà elle ne sera pas ajoutée au fiche de S.A.V.\\ 
 +
 +Structure XML pour la récupération des fiches S.A.V. :\\ 
 +A insérer dans le XML de récupération des commandes web.\\ 
 +
 +  <SAV>\\ 
 +    <SAV_RefUnique/>\\ 
 +    <SAV_Remarque/>\\ 
 +    <SAV_Date>jj/mm/aaaa</SAV_Date>\\ 
 +    <SAV_IdVendeur/>\\ 
 +    <SAV_CodeClient/>\\ 
 +    <CLI_Civilite/>\\ 
 +    <CLI_Prenom/>\\ 
 +    <CLI_Nom/>\\ 
 +    <CLI_Societe/>\\ 
 +    <CLI_Adr1/>\\ 
 +    <CLI_Adr2/>\\ 
 +    <CLI_Adr3/>\\ 
 +    <CLI_Adr4/>\\ 
 +    <CLI_CodePostal/>\\ 
 +    <CLI_Ville/>\\ 
 +    <CLI_DateNaissance>jj/mm/aaaa</CLI_DateNaissance>\\ 
 +    <CLI_TelM/>\\ 
 +    <CLI_TelP/>\\ 
 +    <CLI_TelT/>\\ 
 +    <CLI_Email/>\\ 
 +    <ARTICLE>\\ 
 +      <SAV_ART_IdArticle/>\\ 
 +      <SAV_ART_DateEntree>jj/mm/aaaa</SAV_ART_DateEntree>\\ 
 +      <SAV_ART_HeureEntree>hh:mm:ss</SAV_ART_HeureEntree>\\ 
 +      <SAV_ART_DateSortie>jj/mm/aaaa</SAV_ART_DateSortie>\\ 
 +      <SAV_ART_HeureSortie>hh:mm:ss</SAV_ART_HeureSortie>\\ 
 +      <SAV_ART_NumSerie/>\\ 
 +      <SAV_ART_InfoLibel1/>\\ 
 +      <SAV_ART_Info1/>\\ 
 +      <SAV_ART_InfoLibel2/>\\ 
 +      <SAV_ART_Info2/>\\ 
 +      <SAV_ART_InfoLibel3/>\\ 
 +      <SAV_ART_Info3/>\\ 
 +    </ARTICLE>\\ 
 +    <TEST>\\ 
 +      <SAV_TST_Libel/>\\ 
 +      <SAV_TST_Oui>0|1</SAV_TST_Oui>\\ 
 +      <SAV_TST_Non>0|1</SAV_TST_Non>\\ 
 +    </TEST>\\ 
 +  </SAV>
 +
 +
 +====== Import des commandes depuis le Web ======
 +
 +La récupération des commandes passées depuis le site Web se fait par un appel à un XML depuis KinTPV.\\ 
 +Cet XML doit posséder des données spécifiques pour identifier parfaitement les ventes (Numéro de vente, code barre article vendu, informations sur le client).\\ 
 +Dans l'interface de caisse de KinTPV, il faut alors traiter chaque commande pour la transformer en ticket et valider ainsi la vente.\\ 
 +Une fois les commandes traitées, un export partiel vers le site Web est possible pour une mise à jour des stocks.\\ 
 +
 +Vous pouvez forcer la récupération des ventes Web en utilisant le bouton <<Récupération des ventes Web (FTP)>> depuis le menu <<Divers>> de KinTPV.\\ 
 +Mais il est aussi possible de paramétrer KinTPV pour qu'il interroge de de manière automatisée et dans des intervalles de temps réguliers votre serveur Web. Lorsque KinTPV a récupéré des commandes Internet non traitées, une petite ic&ocirc;ne clignote dans le coin supérieur gauche du sommaire général de KinTPV ou le bouton <<Vente Web>> présent dans l'interface de caisse apparait sur fond rouge. Il vous faut alors valider manuellement et une à une ces commandes.\\ 
 +Depuis l'interface de caisse, cliquez sur le bouton <<Vente Web>>, une nouvelle interface s'ouvre et vous affiche par défaut la liste des commandes Internet récupérées mais non traitées, cliquez sur un élément de la liste, vérifiez les données puis faites <<Transformer en ticket>>. Pour valider et traiter l'achat effectué sur le site marchand, validez tout simplement le ticket comme s'il s'agissait d'une vente au comptoir.\\ 
 +Les balises "VT_NumUniqueWeb" et "VT_CodeOrigineVente" permettent d'identifier une commande dans KinTPV et savoir si celle-ci a déjà été traitée. Il est impératif que le serveur Internet génère un code numérique unique par commande (incrémental) pour la balise "VT_NumUniqueWeb".\\ 
 +Pour la gestion des frais de port, il suffit d'ajouter un bloc <DETAIL>, à comptabiliser dans le "VT_NbDetails", avec la configuration ci-dessous :\\ 
 +<DETAIL>\\ 
 +<VT_IdArticle/> non obligatoire\\ 
 +<VT_CodeBarre/> Lien vers l'article de type "frais de port".\\ 
 +<VT_Reference/> non obligatoire\\ 
 +<VT_Qte/>\\ 
 += 1\\ 
 +<VT_PrixVente/> Prix UNITAIRE TTC payé pour les frais de port.\\ 
 +<VT_Type/> Indiquer le type de ligne "PORT".\\ 
 +<VT_TauxTaxe/> Indiquer le taux de taxe pour le frais de port. </DETAIL>\\ 
 +
 +Structure brut du fichier XML à envoyer à KinTPV :\\ 
 +<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>\\ 
 +<KINTPV>\\ 
 + <VENTE>\\ 
 +   <VT_NumUniqueWeb/>\\ 
 +   <VT_CodeOrigineVente/>\\ 
 +   <VT_IdVendeurKinTPV/>\\ 
 +   <VT_MontantVente/>\\ 
 +   <VT_CodeClient/>\\ 
 +   <VT_Date/> format = JJ/MM/AAAA\\ 
 +   <VT_Heure/> format = HH:MM:SS\\ 
 +   <LV_Nom/>\\ 
 +   <LV_Adresse/>\\ 
 +   <CLI_Civilite/>\\ 
 +   <CLI_Prenom/>\\ 
 +   <CLI_Nom/>\\ 
 +   <CLI_Societe/>\\ 
 +   <CLI_Adr1/>\\ 
 +   <CLI_Adr2/>\\ 
 +   <CLI_Adr3/>\\ 
 +   <CLI_Adr4/>\\ 
 +   <CLI_CodePostal/>\\ 
 +   <CLI_Ville/>\\ 
 +   <CLI_IdPays/>\\ 
 +   <CLI_DateNaissance/>\\ 
 +   <CLI_TelM/>\\ 
 +   <CLI_TelP/>\\ 
 +   <CLI_TelT/>\\ 
 +   <CLI_Email/>\\ 
 +   <CLI_TypeFactImpr/>\\ 
 +   <VT_Commentaire/>\\ 
 +   <VT_NbDetails/>\\ 
 +   <VT_Etat/>\\ 
 +   <DETAIL>\\ 
 +     <VT_IdArticle/>\\ 
 +     <VT_CodeBarre/>\\ 
 +     <VT_Reference/>\\ 
 +     <VT_Qte/>\\ 
 +     <VT_PrixVente/>\\ 
 +     <VT_Type/>\\ 
 +     <VT_TauxTaxe/>\\ 
 +   </DETAIL>\\ 
 +   <REGLEMENT>\\ 
 +     <RG_IdTypeReglement/>\\ 
 +     <RG_Montant/>\\ 
 +   </REGLEMENT>\\ 
 + </VENTE>\\ 
 +</KINTPV>\\ 
 +ATTENTION :\\ 
 +  * La balise <VT_CodeOrigineVente/> Code origine de la vente (10 caractères, préfixe du N&deg; de commande) - La balise <VT_IdVendeurKinTPV/> Numéro unique de lien du vendeur avec KinTPV (se trouve dans la liste des vendeurs) - La balise <VT_CodeClient/> Code unique du client (Lien avec KinTPV pour retrouver le client) - La balise <CLI_IdPays/> Numéro unique de lien du pays avec KinTPV (Il est possible d'importer les pays dans KinTPV) - La balise <CLI_TypeFactImpr/> Type d'impression des factures : 1 ou 0 = Standard avec règlement, 2 = Sans règlement, avec ligne HT - La balise <VT_NbDetails/> Doit comptabiliser le nombre de lignes de vente + le nombre de lignes de règlement. - La balise <VT_Etat/> Etat de la commande web (2 = VALIDEE; 1= NON VALIDEE) - La balise <VT_IdArticle/> Numéro unique de l'article dans KinTPV (non obligatoire) - La balise <VT_Qte/> Quantité commandée - La balise <VT_Reference/> Référence spécifique KinTPV (IdArticle + CodeDeclinaison) (non obligatoire) - La balise <VT_CodeBarre/> Code barre de l'article**(Lien à utiliser pour retrouver l'article dans KinTPV)**- La balise <VT_PrixVente/> Prix UNITAIRE TTC de l'article vendu. - La balise <VT_Type/> Indique le type de ligne "ARTICLE". - La balise <VT_TauxTaxe/> Indique le taux de taxe utilisé pour la vente de l'article (par exemple : 19,6). - La balise <RG_IdTypeReglement/> Correspond au N&deg; de règlement dans le logiciel KinTPV. \\ 
 +Liste des N&deg; de règlement dans KinTPV :\\ 
 +231 -> Espèces\\ 
 +232 -> Chèque\\ 
 +233 -> Carte\\ 
 +234 -> Carte Expr.\\ 
 +235 -> Carte Aurore\\ 
 +236 -> Autre Carte\\ 
 +237 -> Reprise crédit client\\ 
 +240 -> Carte BANCONTACT\\ 
 +241 -> Carte VISA\\ 
 +242 -> Carte MAESTRO\\ 
 +243 -> Chèque Fidélité\\ 
 +244 -> Carte CETELEM\\ 
 +245 -> Carte SOFINCO\\ 
 +246 -> Mastercard\\ 
 +247 -> American Express\\ 
 +248 -> Carte Fidélidé\\ 
 +249 -> Virement\\ 
 +250 -> Paiement Internet\\ 
 +251 -> Ticket Restaurant\\ 
 +252 -> PayPal\\ 
 +261 -> Reprise acompte client\\ 
 +305 -> Rendu\\ 
 +306 -> Rendu hors espèces\\ 
 +====== Import des S.A.V. (Dép&ocirc;t Client) ======
 +
 +Lors de la récupération des commandes depuis le web, il est possible de récupérer les fiches de S.A.V.\\ 
 +Cette récupération est directement ajoutée dans la gestion des S.A.V. de KinTPV suivant la balise <SAV_RefUnique/>.\\ 
 +Si cette référence existe déjà elle ne sera pas ajoutée au fiche de S.A.V.\\ 
 +
 +Structure XML pour la récupération des fiches S.A.V. :\\ 
 +A insérer dans le XML de récupération des commandes web.\\ 
 +
 +  <SAV>\\ 
 +    <SAV_RefUnique/>\\ 
 +    <SAV_Remarque/>\\ 
 +    <SAV_Date>jj/mm/aaaa</SAV_Date>\\ 
 +    <SAV_IdVendeur/>\\ 
 +    <SAV_CodeClient/>\\ 
 +    <CLI_Civilite/>\\ 
 +    <CLI_Prenom/>\\ 
 +    <CLI_Nom/>\\ 
 +    <CLI_Societe/>\\ 
 +    <CLI_Adr1/>\\ 
 +    <CLI_Adr2/>\\ 
 +    <CLI_Adr3/>\\ 
 +    <CLI_Adr4/>\\ 
 +    <CLI_CodePostal/>\\ 
 +    <CLI_Ville/>\\ 
 +    <CLI_DateNaissance>jj/mm/aaaa</CLI_DateNaissance>\\ 
 +    <CLI_TelM/>\\ 
 +    <CLI_TelP/>\\ 
 +    <CLI_TelT/>\\ 
 +    <CLI_Email/>\\ 
 +    <ARTICLE>\\ 
 +      <SAV_ART_IdArticle/>\\ 
 +      <SAV_ART_DateEntree>jj/mm/aaaa</SAV_ART_DateEntree>\\ 
 +      <SAV_ART_HeureEntree>hh:mm:ss</SAV_ART_HeureEntree>\\ 
 +      <SAV_ART_DateSortie>jj/mm/aaaa</SAV_ART_DateSortie>\\ 
 +      <SAV_ART_HeureSortie>hh:mm:ss</SAV_ART_HeureSortie>\\ 
 +      <SAV_ART_NumSerie/>\\ 
 +      <SAV_ART_InfoLibel1/>\\ 
 +      <SAV_ART_Info1/>\\ 
 +      <SAV_ART_InfoLibel2/>\\ 
 +      <SAV_ART_Info2/>\\ 
 +      <SAV_ART_InfoLibel3/>\\ 
 +      <SAV_ART_Info3/>\\ 
 +    </ARTICLE>\\ 
 +    <TEST>\\ 
 +      <SAV_TST_Libel/>\\ 
 +      <SAV_TST_Oui>0|1</SAV_TST_Oui>\\ 
 +      <SAV_TST_Non>0|1</SAV_TST_Non>\\ 
 +    </TEST>\\ 
 +  </SAV>
  
manuel/module-dev.txt · Dernière modification: 19/10/2018 21:26 (modification externe)