| Sommaire | ||||
|---|---|---|---|---|
|
Services Web
| Sommaire |
|---|
| Ancre | ||||
|---|---|---|---|---|
|
Service
Définition
Un service Web est un composant applicatif accessible sur le Web par une interface standard en utilisant des protocoles de communication basés sur le XML indépendamment du système d'exploitation et des langages de programmation utilisés.
Le service Web met à disposition des fonctions (méthodes) sur un serveur HTTP.
Le client du service Web peut invoquer la méthode du serveur aussi simplement que s'il s'agissait d'une fonction locale. Il faut spécifier l'URL du service Web auquel on désire accéder, ainsi que les paramètres d'entrée de la méthode.
WebServiceDIvaWebServiceDiva
WebServiceDiva est une méthode générique permettant d'exécuter une action sur le serveur Web. L'action correspond à un programme Diva. Celui-ci récupère les paramètres (généralement une chaîne <hmp>), effectue le traitement et renvoie un résultat.
Le service est exécuté par le serveur HTTP IIS de Microsoft.
| Ancre | ||||
|---|---|---|---|---|
|
Architecture
...
| Ancre | ||||
|---|---|---|---|---|
|
WebServiceDiva
WebServiceDiva est un service Web générique qui sert à lancer tous les services Web DivaERP. La page générique WebserviceDiva.asmx est hébergée sur le serveur IIS de Microsoft. Elle contient la méthode WebServiceDiva qui permet d'exécuter un programme Diva sur le serveur en lui passant des paramètres
Int WebServiceDiva(string action,string param,out string retour)
...
Il peut être appelé depuis un programme Diva et depuis n'importe quelle autre application cliente de services Web.
Il exécute le programme XWebServices.dhop
Remarque :
Pour l'appel d'un service Web Diva depuis un programme Diva il faut utiliser la fonction WebServiceDivaExecute.
| Ancre | ||||
|---|---|---|---|---|
|
XwebServices
Le programme XwebServices.dhop est exécuté à chaque invocation d'un service Web DivaERP. C'est lui qui lance le programme Diva correspondant à l'action demandée.
Le programme de traitement de l'action est lancé par la fonction ProgramGoto. XwebServices.dhop lui envoie les paramètres par le tunnel.
Actions des services Web
Le paramètre <Action> permet de préciser l'action à exécuter pour ce message. Ce paramètre est obligatoirement une chaîne HMP dans laquelle le paramètre <ACTION> définit le traitement à effectuer. Il fait référence à une action décrite dans le fichier paramètres des actions. Ce fichier contient pour chaque action :
...
L'action « ping » permet de tester les services Web sans avoir à écrire de programme Diva. Elle est directement traitée par le programme XwebServices.dhop. Pour cela elle doit être créée et activée dans le fichier paramètre des actions. XwebServices renvoie un status à 0 et dans le paramètre de retour sa version ainsi que le nom du serveur sur lequel il s'exécute.
La durée de l'exécution de l'action doit être relativement courte. Le client attend la réponse en temps réel. Si le traitement est trop long, la liaison avec le client risque d'être interrompue.
Le service Web Diva ERP est un programme qui n'effectue pas d'affichage.
Si le paramètre Résidente de l'action n'est pas cochée, l'appel du programme se fait par un ProgramCall ce qui est nettement plus coûteux en temps.
Voir également :
Rubrique "Harmony Markup Parameters HMP" de la documentation Xwin - Programmation.
Rubrique "Tunnels" de la documentation Xwin - Programmation.
Rubrique "ProgramCall" de la documentation Xwin - Programmation.
| Ancre | ||||
|---|---|---|---|---|
|
Service Web
...
Divalto ERP
Le service Web Diva Divalto ERP est le programme chargé d'exécuter l'action demandée par le client du service Web.
Il récupère dans le tunnel par la fonction PingReceive les paramètres suivants :
WebServiceAction | La chaîne <action>. En plus du paramètre Action, cette chaîne peut comporter des paramètres complémentaires. Elle n'est jamais cryptée. |
WebServiceParameters | Les paramètres d'entrée de l'action. S'il y a plusieurs paramètres, on utilisera de préférence une chaîne au format <hmp>. Pour des besoins de confidentialité, ce paramètre peut être crypté. |
WebServiceParametersUnicode | Chaîne Unicode fournie par Dotnet. |
WebServiceParamAction | Les paramètres complémentaires en provenance du fichier des actions. |
Si l'action est paramétrée résidente
Il traite l'action et renvoie le résultat par la fonction WebServiceReturn.
Il enchaîne au programme XwebServices.dhop par l'instruction ProgramGoto
Si l'action n'est pas paramétrée résidente :
Il traite l'action puis renvoie les résultats dans le tunnel par la fonction Pong
WebServiceStatus | Le compte-rendu. La valeur 0 indique un traitement sans erreur. Une valeur différente de 0 correspond à une erreur de traitement. Dans ce cas, il est préférable de mettre un message d'erreur en clair dans le résultat. |
WebServiceResult | Le résultat ou un message d'erreur. Le résultat peut être crypté lorsque WebServiceStatus est nul. |
WebServiceVersion | (facultatif) Le numéro de version est journalisé dans le fichier XwebServices.log. |
Puis il se termine par l'instruction ProgramExit.
Remarques :
...
| Ancre | ||||
|---|---|---|---|---|
|
Services Web résidents
Principe
A partir de la version 6.3a d'Harmony, le système gère un pool de tâches pour l'exécution des services web. Ce pool permet de garder des tâches Harmony en attente et ainsi de réduire considérablement le temps d'exécution d'une requête.
Lors du premier appel à un service web, le programme XwebServices.dhop est chargé. Une fois le traitement de l'action effectué, le contrôle est rendu au programme XwebServices.dhop (par l'instruction ProgramGoto). Ce dernier se met alors en attente d'un appel de service web.
Lors de l'appel suivant à un service web, s'il existe une tâche disponible dans le pool, celle-ci est immédiatement activée.
Mise en oeuvre
...
| Ancre | ||||
|---|---|---|---|---|
|
Exemple de service Web
...
Divalto ERP
| Bloc de code |
|---|
;____________________________________________________________________
;Description :
; Service Web pour quantité en stock pour une référence article
;____________________________________________________________________
define MaVersion = "6.1 "
module "pmstock.dhop"
1 ParamEntree S
1 dos 3,0
1 ref 25
1 stock 12,D2
main
; récupération des paramètres d'entrée
PingReceive("WebServiceParameters",ParamEntree)
Dos = hmpseek(ParamEntree,"dos",998) ; Dossier par défaut 998
Ref = hmpseek(ParamEntree,"reference","")
; calcul du stock
stock = interro_stock(dos,ref)
; réponse
if IsProgramCalled = FALSE ; l'action est paramétrée Résidente
WebServiceReturn(stock,0)
ProgramGoto("xwebservices.dhop")
endif
Pong("WebServiceStatus",0) ; l'action n'est pas résidente
Pong("WebServiceResult",stock)
Pong("WebServiceVersion",MaVersion)
programexit
|
| Ancre | ||||
|---|---|---|---|---|
|
Installation du serveur Web
Les services Web Diva Divalto s'appuient sur la technologie .NET de Microsoft.
La mise en œuvre nécessite donc le serveur IIS (Internet Information Services) de Microsoft. Elle nécessite également l'installation du FrameWork .Net sur ce serveur.
Pour le détail de l'installation voir le chapitre « Installation Harmony Web » dans l'installation et paramétrage d'Harmony.
| Ancre | ||||
|---|---|---|---|---|
|
Client Diva d'un service Web
...
Divalto
La fonction WebServiceDivaExecute permet d'exécuter un service Web DivaDivalto.
Elle comporte 4 paramètres :
...
Confidentialité
Les paramètres d'entrée et de retour peuvent être cryptés pour assurer la confidentialité des informations transmises.
| Ancre | ||||
|---|---|---|---|---|
|
Exemple de client Diva d'un service Web
...
Divalto
| Bloc de code |
|---|
;____________________________________________________________________ ;Description : ; Demande la quantité en stock pour une référence article à ; un service Web Diva ;____________________________________________________________________ 1 Url S 1 St X 1 Retour S 1 Stock 12,D2 main ; Appel du service Url = "http://www.divalto.fr/Ws/WebServiceDiva.asmx" St = WebServiceDivaExecute(Url, \ "<action>Stock", \ "<dos>998<reference>ALB0001", \ Retour) ; en cas d'erreur Retour contient le message if St MessageBox(binhexa(stx(St)) & " " & Retour ," ") else Stock = Retour endif ProgramExit |
| Ancre | ||||
|---|---|---|---|---|
|
Programmation service web ou webhook : paramètre en entrée et sortie
L’exemple ci-dessous illustre la récupération en entrée dans un programme Diva des paramètres pour un service web ou un webhook, et les paramètres de retour
| Bloc de code | ||
|---|---|---|
| ||
;___________________________________________________________________________
;Description : Envoie la quantité en stock pour une référence article
;___________________________________________________________________________
module "ysystemex.dhop"
module "xwebservices.dhop"
public record ddsys.dhsd Action Bal
define Vers = "2023"
1 WebServiceAction 64
1 ParamAction 256
1 ParamEntree S
1 ParamEntreeUnicode S
1 WebServiceWebhook 40 = " "
1 WebServiceWebhookCode 256 = " "
1 WebServiceWebhookParamHMP 256 = " "
1 commProvenantDuFichierXbalwebHook 75 = " "
1 cappelProvenantDuFichierXbalwebHook 16 = " "
1 moderaw 3
1 WebServiceWebhookRaw S
1 WebServiceWebhookBody S
1 WebServiceWebhookHeaders S
1 WebServiceWebhookContentType 256
1 WebServiceWebhookParamsRaw s
1 WebServiceWebhookEncodingType 256
1 WebServiceTypeTransport 10
1 WebServiceCommAction 256
1 paramsortie S
1 paramsortiehh S
1 CodeHttpResponse 4,0
1 dos 3,0
1 ref 25
1 stock 12,D2
1 carreste L
1 szAuthorization 4096
procedure RecupererLesParametresEnEntree
beginp
; récupération des paramètres d'entrée
PingReceive("WebServiceParameters",ParamEntree)
ParamEntree = Fromutf8toAnsi(left(ParamEntree),carreste,0)
PingReceive("WebServiceParametersUnicode",ParamEntreeUnicode) ;idem en unicode mais je sais pas trop a quoi ca peut servir en diva
PingReceive("WebServiceAction",WebServiceAction) ; nom de l'action exemple "STOCK"
PingReceive("WebServiceTypeTransport",WebServiceTypeTransport) ;type de service contenant le texte "soap","rest","webhook"
PingReceive("WebServiceWebhook" ,WebServiceWebhook ) ;numero du webhook exemple F856B712803445A39E098456442C1EDC0C050A0C
PingReceive("WebServiceWebhookCode" ,WebServiceWebhookCode) ; la suite apres les 40 caracteres du webhook exemple F856B712803445A39E098456442C1EDC0C050A0Ctoto => on récupere "toto" (tel qu'il et écrit donc avec la case)
;infos provenant de la fiche webhook qui est dans le fichier xbalwebhook.dhfi/dhfd
PingReceive("WebServiceWebhookParamHMP" ,WebServiceWebhookParamHMP ) ;champ parametre hmp
PingReceive("WebServiceWebhookComm" ,commProvenantDuFichierXbalwebHook ) ;champ commentaire par exemple on peut le mettre dans du debug pour faire une trace
PingReceive("WebServiceWebhookCodeAppelant",cappelProvenantDuFichierXbalwebHook) ;champ code d'appel , par exemple on peut y mettre un nom de ste
;infos provenant de la fiche ACTION qui est dans le fichier xbal.dhfi/dhfd
PingReceive("WebServiceParamAction",ParamAction) ;param de l'action attention ne pas confondre avec WebServiceParameters
PingReceive("WebServiceCommAction,",WebServiceCommAction) ;commentaire de la fiche action , pour mettre dans du debug par exemple, ne pas confondre avec WebServiceWebhookComm
PingReceive("WebServiceWebhookContentType" ,WebServicewebhookContentType) ;exemple "application/json"
PingReceive("WebServiceWebhookEncodingType",WebServiceWebhookEncodingType) ;type d'encodage en general il contiens "UTF-8" ay milleu du texte donc faire string("UTF-8") et a= "UTF-8"
PingReceive("WebServiceWebhookBody" , WebServiceWebhookBody) ;c'est le body tel qu'on le recoit sans aucune transformation
WebServiceWebhookBody= Fromutf8toAnsi(left(WebServiceWebhookBody),carreste,0)
PingReceive("WebServiceWebhookHeaders" , WebServiceWebhookHeaders) ;entetes au format hmp valeur etc
WebServiceWebhookHeaders= Fromutf8toAnsi(left(WebServiceWebhookHeaders),carreste,0)
PingReceive("WebServiceWebhookRaw" ,WebServiceWebhookRaw) ;c'es un flag a 1 pour dire que c'est pas un format classique et qu'il faut aller voir webhookbody
PingReceive("WebServiceWebhookParamsRaw" ,WebServiceWebhookParamsRaw) ;reencodage du body mais au format hmp plus facile a traiter que le json
WebServiceWebhookParamsRaw= Fromutf8toAnsi(left(WebServiceWebhookParamsRaw),carreste,0)
;exemple pour lire les paramètres de la commande service web
Dos = hmpseek(ParamEntree,"dos",998)
Ref = hmpseek(ParamEntree,"reference","")
;j'ai fait deux service webhook et dans les parametres de mon service xbal
;webhook , j'ai mis <moderaw>1 dan l'un et <moderaw>0 dans l'autre
;c'est juste pour voir comment on peut activer ou pas des options dans un service diva
;de type webhook par exemple
moderaw = hmpseek(WebServiceWebhookParamHMP,"moderaw","")
;on peut aussi lire les headers de la requête web d'origine
if WebServiceWebhookHeaders <> " "
szAuthorization = hmpseek(WebServiceWebhookHeaders,"Authorization","")
endif
endp
procedure EnvoyerReponse
beginp
;exemple de retour
;on a fait 2 code de webhook , dans le premier on a mis le flag 1 et dans l'autre webhook 0
;juste pour tester les 2 types de reponses d'un webhook
if val(moderaw) = 0
paramsortie = stock & " éèà ParamEntree=" &left(ParamEntree) & \
" webhookrecu=" & left(WebServiceWebhook) & \
" webhookcode=" & left(WebServiceWebhookCode) & \
" webhookparamhmp=" & left(WebServiceWebhookParamHMP) & \
" webhookcom=" & left(commProvenantDuFichierXbalwebHook) & \
" codeappellant=" & left(cappelProvenantDuFichierXbalwebHook) & \
" ContentType=" & left(WebServicewebhookContentType) & \
" cappelProvenantDuFichierXbalwebHook=" & left(WebServiceWebhookRaw) & \
" body=" & left(WebServiceWebhookBody) & \
" reincodagebodyenhmp" & left(WebServiceWebhookParamsRaw) & \
" headers=" & left(WebServiceWebhookHeaders)
paramsortie = FromAnsitoutf8(paramsortie)
Pong("WebServiceResultContentType","")
Pong("WebServiceResultHeaders","")
CodeHttpResponse = 0 ; la valeur par defaut 0 indique que c'est le service web qui va mettre le bon code par exemple 200 si ok et 400 si erreur
;la liste est dans https://fr.wikipedia.org/wiki/Liste_des_codes_HTTP
else
paramsortie = '{ "test":"xxx","essai":"libre éàé' & left(szAuthorization) & '" }'
paramsortie = FromAnsitoutf8(paramsortie)
Pong("WebServiceResultContentType","application/json")
Pong("WebServiceResultUTF8","1") ;code en utf8 ou pas, c'est pas simple car postman reconvertie ! ce qui fait que pour postman il faudrait mettre 0 ici
;en hmp on peut utiliser valeur ou bien $03 motcle $04 valeur
;mais faut pas mixer les deux mode , c'est soit toujours < > ou soit toujours $03 $04
;le mode $03 $04 est mieux car il permet de passer les caractères < > dans le champ valeur
paramsortiehh = $03 & "test_de_headers" & $04 & "10" & $03 & "code_secret_a_moi" & $04 & "simple testéè"
;attention IL NE DOIT PAS Y AVOIR DE BLANC DANS LE NOM D'UN HEADERS, c'est une norme web
paramsortiehh = left(paramsortiehh ) & $03 & "Authorization" & $04 & "Bearer ExYYyd8YsaOOT7XuZRHiULleAJsDK4StFvh6QWbbca_ro45GQtk38gkeOF14Uzv03LD4ppZoDlOjEUbEVJ/HPXc/c9kYygaCuABB2zM2c6mdpAbNgnkNE0CSX22fGvlf"
paramsortiehh = FromAnsitoutf8(paramsortiehh)
Pong("WebServiceResultHeaders",left(paramsortiehh))
;Pong("WebServiceResultHeadersContent",left(paramsortiehh))
CodeHttpResponse = 402 ;exemple c'est juste pour test , ca renvoi le code "payment required" voir les codes https://fr.wikipedia.org/wiki/Liste_des_codes_HTTP
endif
; réponse
Pong("WebServiceStatus",0) ;erreur ou pas du programme
Pong("WebServiceResult",left(paramsortie)) ;la reponse
Pong("WebServiceVersion",Vers) ;version => je sais pas a quoi ca sert mais c'est comme ca
Pong("WebServiceResultCodeHTTP",CodeHttpResponse ) ;code de reponse http ; 0 pour dire "prendre le code par defaut" ou nnn pour fixer un code
endp
exemple d'utilisation
main
RecupererLesParametresEnEntree
stock = 457 ; calcul du stock
EnvoyerReponse
programexit |