Ce tuto traite de l'utilisation des services web à partir de WINDEV ou de WEBDEV. Les services web utilisent la norme SOAP 1.1 et JSON pour les tableaux. Ils sont donc utilisables depuis tous les langages de programmation récents. L'ensemble des actions sur les données sont disponibles dans les services web.
L'utilisation des services web doit être effectuée par un informaticien.
La structure des services web est fournie dans le WSDL. Cette structure est statique et dispose de 2 méthodes :
- WSDiscover_v1 : Permet de découvrir les ressources et méthodes disponibles.
- WSCall_v1 : Permet de transmettre des actions aux services web.
Si vous avez effectué une installation standard, le WSDL est disponible à l'adresse suivante : http://localhost/VIADEV_WEB/awws/ViadevWS.awws?wsdl
La méthode WSCall_v1 reçoit un tableau d'ordres ce qui permet de regrouper les actions. Il est par exemple possible d'annuler toutes les modifications effectuées sur la base de données si une erreur se produit à la fin du processus (annulation de la transaction). Si une erreur se produit sur un ordre, les ordres suivants ne seront pas exécutés et le service web retournera l'erreur rencontré.
Afin de simplifier l'utilisation des service web, nous avons développé le Viadev WSHelper qui permet de découvrir facilement les méthodes disponibles et de construire les appels sous WINDEV/WEBDEV.
Suivez ce tuto si vous n’avez pas encore installé les services web Viadev.
Suivez les étapes ci-dessous pour installer Viadev WSHelper
Téléchargez et exécutez le programme d'installation Viadev.
Lisez les Conditions Générales Viadev et cliquez sur « Accepter » si vous êtes d'accord avec celles-ci. Cliquez sur « Ouvrir la version PDF » si vous souhaitez les imprimer ou en conserver une copie.
Lorsque le menu simplifié s’affiche, cliquez sur « Ouvrir le menu avancé ».
Créez le dossier « C:\ProgramData\Viadev\WSHelper ».
Créez le dossier « C:\ProgramData\Viadev\WSHelperData ».
Cliquez sur « Services web » puis sur « Télécharger Viadev WSHelper ».
Sélectionnez le dossier « C:\ProgramData\Viadev\WSHelper ».
Exécutez « ViadevWSHelper.exe ».
Cliquez sur « Configuration ».
Ajustez les paramètres si nécessaire.
Cliquez sur « Fermer ».
Cliquez sur « Mettre à jour les ressources disponibles ».
Patientez pendant la récupération des ressources disponibles.
Cliquez sur « Mettre à jour les énumérateurs ».
Patientez pendant la récupération des énumérateurs.
Les fichiers sont téléchargés dans « C:\ProgramData\Viadev\WSHelperData ».
Il est recommandé d'exécuter à nouveau ces 2 mises à jour uniquement si de nouvelles ressources ou ordres ont été ajoutées au logiciel Viadev.
Suivez les étapes ci-dessous pour utiliser Viadev WSHelper
Exécutez « C:\ProgramData\Viadev\WSHelper\ViadevWSHelper.exe ».
Si votre action nécessite d'être dans le contexte d'un exercice comptable, renseignez l'ID de l'exercice comptable dans « ID du contexte (exercice comptable) ».
Dans la 1re liste, choisissez la ressource sur laquelle vous voulez effectuer une action.
Dans le 2e liste, choisissez l'ordre que vous voulez exécuter.
Dans la 3e liste, cliquez sur « Requis » lorsque vous voulez transmettre une donnée facultative.
Cliquez sur « Générer le code WLangage dans le presse-papier », collez-le dans votre application WINDEV/WEBDEV puis ajustez les paramètres. Dans notre exemple, l'ID de la comptabilité à charger en lecture doit être renseignée :
lclViadevWS.OrderAdd("Accounting","RecLoad",[["lnRecID","Nombre entier sur 8 octets."]])
L'onglet « Enumérateurs » permet de voir la correspondance entre les descriptions et les ID pour chaque énumérateur.
Suivez les étapes ci-dessous pour utiliser la classe C_ViadevWS dans vos projets WINDEV/WEBDEV
Le fichier « C_ViadevWS.wdc » est une classe WINDEV/WEBDEV que vous pouvez importer dans vos applications qui appellerons les services web Viadev.
Si vous utilisez un autre langage de programmation, il est recommandé de créer une classe au fonctionnement similaire afin de simplifier les appels aux services web.
Importez la classe « C:\ProgramData\Viadev\WSHelper\C_ViadevWS.wdc » dans votre projet.
Initialisez la classe
lclViadevWS est un C_ViadevWS("main.xml","ACCESSKEY1","localhost")
lsResult est une chaîne
Ajoutez les ordres
Collez le code généré par Viadev WS Helper dans l'ordre des actions à effectuer.
Appelez les services web
SI PAS lclViadevWS.WSCall(lsResult) ALORS Info(lsResult) SINON Info("Appel effectué avec succès.")
Les valeurs renvoyées pour chaque ordre sont disponibles dans le tableau de l'objet lclViadevWS :
lclViadevWS.m_WSRCall.m_arOrder
Par exemple pour récupérer la valeur de retour du 1er ordre transmis :
lclViadevWS.m_WSRCall.m_arOrder[1].m_sReturn