| I. Technologie
|| 1. 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.
|| 2. 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/">
${color}[#ff0000](<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:getNbArticlesLibres>
[…]
</ges:getNbArticlesLibres>
</soapenv:Body>
</soapenv:Envelope>
La confidentialité et l’intégrité des messages ne sont pas implémentées à ce jour.
|| 3. 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 :
Le compte utilisateur sur cet environnement sera communiqué par mail.
| II. 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 ».
1. Retourne les nombre de nombre d'article libres facturés (getNbArticlesLibres)
2. Retourne une liste d'articles libres (getArticlesLibresWithOffset)
3. Retourne le nombre d'articles libres facturés et soldés (getNbArticlesLibresPayes)
4. Retourne une liste d''articles libres facturés et soldés (getArticlesLibresPayesWithOffset)
5. Retourne le nombre d'articles libres facturés et non-soldés (getNbArticlesLibresNonPayes)
6. Retourne une liste d''articles libres facturés et non-soldés (getArticlesLibresNonPayesWithOffset)
7. Retourne les informations liées à la référence de facture indiquée (getFacture)
8. Retourne les informations liées à la commande boutique indiquée (getFactureByNoCommande)
9. Retourne les informations liées au numéro de facture indiquée (getFactureByNoFacture)
10. Retourne le nombre de factures liées au client (getNbFactures)
11. Retourne le détail des factures liés au client (getFactures)
12. Retourne le détail des lignes de facture d'abonnements liés au client (getAbonnementsWithOffset)
13. Retourne le nombre de lignes de facture d’abonnements non réglés liés au client (getNbAbonnementsNonPayes)
14. Retourne le nombre d’abonnements réglés liés au client (getNbAbonnementsPayes)
15. Retourne le détail des lignes de facture d'abonnements réglés liés au client (getAbonnementsPayesWithOffset)
16. Retourne le détail des lignes de facture d'abonnements non-réglés liés au client (getAbonnementsNonPayesWithOffset)
17. Retourne le nombre des lignes de facture d'abonnements (getNbLignesFactures)
18. Retourne les lignes de facture (getLignesFactureWithOffset)
19. Retourne le nombre des lignes de facture d'abonnements (getNbLignesFactureByNoFacture)
20. Retourne le nombre des lignes de facture d'abonnements (getLignesFactureByNoFacture)
21. Retourne le nombre des lignes de facture d'abonnements (getNbLignesFactureByNoCommande)
22. Retourne les lignes de facture lié à la commande (getLignesFactureByNoCommande)
| III. 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.
|| WSLigneFacture
