Services documentés dans cet article
Structure d'échange (WSCodeDeSelection)
Ajouter un code sélection pour un client (createCodeSelection)
Modifier pour un client la valeur d'un code de sélection identifiée par sa référence unique (updateCodeSelection)
Supprimer pour un client la valeur d'un code de sélection identifiée par sa référence unique (deleteCodeSelection)
Liste des valeurs des codes de sélection d'un client (listCodeSelection)
Valeurs possibles pour un code de sélection de type Sur Liste (getLibelles)

Technologie

Protocole
La solution technique mise en place côté AboWeb repose sur des Web Services sans états.
Le protocole utilisé est SOAP 1.1. La couche de transport utilisée est HTTP 1.1.
L’intérêt principal de cette technologie est de pouvoir fournir un moyen d’échange indépendant de la plateforme et du langage de programmation utilisé. Les messages basés sur XML peuvent également être validés par une grammaire et des outils appropriés pour s’assurer que leur structure est correcte avant toute tentative de traitement des données.

Sécurité
Les Web Services implémentent la norme WS-Security 1.0 afin de réaliser les fonctions d’authentification des messages échangés.
L’authentification est réalisée à l’aide d’un login et d’un mot de passe crypté avec l’algorithme de hachage SHA-1 en base64 dans l’en-tête des messages. La balise utilisée, à savoir <UsernameToken> est conforme au standard.

Exemple d’en-tête (en rouge) :
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ges="http://www.gesmag.com/">

<soapenv:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
<wsse:UsernameToken>
<wsse:Username>login</wsse:Username>
<wsse:Password>mdp</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soapenv:Header>

<soapenv:Body>
<ges:listCodeSelection>
[…]
</ges:listCodeSelection>
</soapenv:Body>
</soapenv:Envelope>

La confidentialité et l’intégrité des messages ne sont pas implémentées à ce jour.

Point d’accès
Les points d’accès sont contenus dans les fichiers WSDL générés sur les différents environnements.
Sur l’environnement de test, nous avons :

Service : gestion des codes de sélection
URL : http://preprod.aboweb.com/aboweb/CodeSelectionService?wsdl

Le compte utilisateur sur cet environnement sera communiqué par mail.

Structures d’échange
Ce chapitre présente les structures de données complexes utilisées comme paramètres et valeurs de retour des Web Services. Pour chaque structure, les noms, types et descriptions des paramètres sont fournies. Les valeurs obligatoires en entrée sont indiquées. Les données en lecture seule sont gérées exclusivement dans AboWeb.

WSCodeDeSelection



(*) id : le champ « id » n’est obligatoire que pour les méthodes « updateCodeSelection » et « deleteCodeSelection ».

(*) codeClient : le champ « codeClient » n’est obligatoire que pour la méthode « createCodeSelection ».

Services
Ce chapitre décrit l’ensemble des services nécessaires à la réalisation des cas d’utilisation. Pour chaque service, plusieurs informations sont fournies : le nom du service, la fonctionnalité réalisée, les paramètres en entrée, la valeur de retour et les cas d’erreurs (SOAPFault). Les structures de données complexes sont présentées dans le chapitre "Structures d'échange".
Les informations concernant l’éditeur sont déduites de l’utilisateur authentifié. On considère qu’il n’y a qu’une société.
Pour des raisons de performance, la taille des listes retournée est limitée à 50 objets. Par ailleurs, il faut éviter de réaliser des opérations d’ajout/suppression d’objets pendant le parcourt des listes à moins de savoir gérer le décalage à l’aide de l’attribut « offset ».

Ajouter un code sélection pour un client (createCodeSelection)


Modifier pour un client la valeur d'un code de sélection identifiée par sa référence unique (updateCodeSelection)


Chaque valeur de code de sélection ajoutée pour un client est identifié par une référence unique.

C'est cette référence qui doit être indiquée en paramètre.

Supprimer pour un client la valeur d'un code de sélection identifiée par sa référence unique (deleteCodeSelection)


Liste des valeurs des codes de sélection d'un client (listCodeSelection)


Valeurs possibles pour un code de sélection de type Sur Liste (getLibelles)


Lorsque l'on administre les codes de sélection de type "Sur Liste", on leur attribue des valeurs possibles.

Seules ces valeurs pourront être choisies lorsque l'on ajoutera ce code de sélection à un client.

Avec ce service, on récupère les valeurs possible d'un code de sélection identifié par son code.
Cet article a-t-il répondu à vos questions ?
Annuler
Merci !