Orientation Nomenclature des services Web

Orientation
Nomenclature des services Web
AE.ORI.053
Avertissement
Ce document constitue une orientation officielle du ministère de la Santé et des Services sociaux
(MSSS) du Q uébec. Il a été préparé par le Service des orientations stratégiques et de
l’architecture (SOSA) de la Direction générale des technologies de l’information (DGTI) du MSSS
du Québec, sous la direction de m adame Lise Verreault, sous-ministre associée au Bureau de
programme pour l’informatisation du réseau de la santé et des services sociaux (RSSS) et
présidente du conseil de gouvernance. Pour tout commentaire ou question, veuillez transmettre
un courriel à l’adresse [email protected].
Traitement des exceptions
Toute personne qui souhaite dévier des exigences ou des orientations technologiques spécifiées
dans ce document doit remplir une demande de dérogation disponible à l’adresse suivante, puis
attendre de recevoir une approbation avant d’aller de l’avant :
http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView&Start=1&Count=30&Collaps
e=5.3#5.3.
Responsable du document
Guy Laliberté
Chef du Service des orientations stratégiques et de l’architecture
DGTI
MSSS du Québec
Collaboration
Architectes du SOSA
Personnel de la DGTI
Membres de la Table permanente d’interopérabilité et de son comité d’experts en technologies
de l’information
Partenaires du RSSS
Remerciements
La DGTI tient à remercier toutes les personnes ayant participé à la production de ce document.
Date d’entrée en vigueur
:
Date(s) de révision
:
Catégorisation du document
Disponibilité
:
Intégrité
:
Confidentialité
:
2012-06-26
1 - Basse
2 - Moyenne
1 - Basse
Édition produite par :
La Direction générale des technologies de l’information du ministère de la Santé et des
Services sociaux du Québec
Le présent document est disponible uniquement en version électronique à l’adresse suivante :
http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView&Start=1&Count=30&Expand
=5.4#5.4.
Le genre masculin utilisé dans ce document désigne aussi bien les femmes que les hommes.
Table des matières
1.
MISE EN CONTEXTE ................................................................................................. 1
2.
DESCRIPTION ............................................................................................................ 1
Références, définitions, sigles et acronymes
Références
•
THE INTERNET SOCIETY. « Hypertext Transfer Protocol -- HTTP/1.1 », Juin 1999, [En
ligne]. [http://tools.ietf.org/html/rfc26160] (Consulté le 19 juin 2012).
Orientations
Cette orientation est associée à l’orientation suivante :
•
Orientation 013 : Architecture logicielle des services Web.
Les orientations en m atière de r essources informationnelles du MS SS sont disponibles à
l’adresse suivante :
http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView&Start=1&Count=30&Exp
and=5.4#5.4.
Principes
Cette orientation est associée aux principes suivants :
•
Pr.INT.04;
•
Pr.INF.02;
•
Pr.APP.03.
Les principes directeurs en m atière de ressources informationnelles du MSSS sont
disponibles à l’adresse suivante :
http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView&Start=1&Count=30&Ex
pand=3#3.
Définitions, sigles et acronymes
Le lexique complet du groupe de normalisation du SOSA est disponible à l’adresse suivante :
http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView&Start=1&Count=30&Expand
=5#5.
Notice au lecteur
•
Le Bureau de pr ogramme pour l’informatisation du RSSS a mandaté le SOSA afin de
produire les documents nécessaires à l’atteinte de ses objectifs de gouverne et
d’optimisation.
•
Les documents ainsi diffusés reposent sur des principes directeurs touchant plusieurs
volets de l’architecture d’entreprise (AE) du MSSS. Ces documents ont préséance sur
ceux existants et visent tout le secteur de la santé et des services sociaux (SSSS), pour
tout ce qui implique l’utilisation d’outils informatiques.
Toute personne qui souhaite dévier des exigences ou des règles spécifiées dans ce
document doit remplir une demande de dérogation disponible à l’adresse suivante, puis
attendre
de
recevoir
une
approbation
avant
d’aller
de
l’avant :
http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView&Start=1&Count=30&
Expand=5#5.
•
Les documents produits par le SOSA sont applicables pour toutes les nouvelles
initiatives du RSSS et du MSSS relativement aux ressources informationnelles.
Pour collaborer avec le SOSA et assurer ainsi une optimisation continue, vous pouvez
vous référer au site Internet du Bureau de programme pour l’informatisation du RSSS à
l’adresse suivante : http://msssa4.msss.gouv.qc.ca/extranet/ri.nsf/vcat?OpenView
ou bien contacter directement le SOSA au MSSS.
Orientation – Nomenclature des services Web
1. MISE EN CONTEXTE
La multiplication des services Web et de leurs méthodes d’appel dans le réseau de la santé et
des services sociaux (RSSS) forcent le MSSS à définir les règles de nomenclature de ceux-ci.
Dans un c ontexte où d’autres groupes ont déjà entamé des travaux de normalisation de la
nomenclature (notamment le DSQ), les règles de nomenclatures énoncées ici sont un minimum
exigible. Chaque groupe peut définir des règles plus spécifiques.
Le concepteur de l a solution doit consulter l’orientation sur l’architecture logicielle des services
Web ORI-013 avant de compléter son travail de conception.
Ce document s’adresse aux architectes organiques, concepteurs de s olutions offrant des
services Web et aux développeurs.
2. DESCRIPTION
Un service Web est nommé par son URL, dans sa forme la plus longue. Toutefois dans la
présente orientation, la nomenclature des serveurs est exclue. Donc, les règles énoncées ici ne
visent qu’à normaliser l’appellation des services Web suivant le premier « / » suivant le nom du
serveur.
Exemple : https://nom_du_serveur/debut_du_nom_du service_web/xxx.
Le nom du service Web doit être assez descriptif pour le différencier des autres, et surtout pour
simplifier son identification.
Selon le choix du concepteur, le nom du service Web peut contenir un verbe dans le cas d’un
service Web WS*I ou identifier la ressource visée dans le cas d’une architecture
Representational State Transfert (REST). La technique utilisée pour appeler l’un ou l’autre n’est
pas discutée ici, simplement la nomenclature.
Exemple WS*I : https://nom-du-serveur/obtenir-resultat-test/.
Exemple REST, méthode GET : https://nom-du-serveur/resultat-test/.
Le nom du service Web doit clairement identifier sa fonction ou la donnée traitée.
Une liste de verbes est fournie à titre d’exemple, ceux-ci peuvent s’exprimer en français ou en
anglais lorsque la technique WS*I est utilisée. Dans le cas du modèle REST, les méthodes sont
celles du protocole Hypertext Transfert Protocol (HTTP) donc toujours en anglais.
1
Orientation – Nomenclature des services Web
Francais
Anglais
Obtenir
GET
Soumettre
POST
Attention : POST implique un pr ocessus plus
complexe et est une méthode standard du http
(voir : http://fr.wikipedia.org/wiki/HTTP).
Détruire
DELETE
Déposer
PUT
Il est possible de précéder le nom du s ervice Web d’une ou de plusieurs étiquettes
supplémentaires selon les environnements et les versions. Ces étiquettes doivent toutefois être
représentées par des « dossiers » séparés par des barres obliques (/). Le nom du service Web
est représenté par la totalité de cette chaine de caractère.
Il est de la responsabilité de l ’architecte de chaque système de s e conformer à c ette
nomenclature et à chaque organisation de mettre en place les règles organiques et les outils afin
de permettre la réalisation de cette nomenclature.
Citons par exemple les règles retenues par le DSQ selon le document « DSQ-OA-001
Nomenclature de service web » (document fourni sur demande). Règles qui sont conformes à
celles d’Inforoute Santé du Canada.
HTTPS://<server-id>/<env>/<realm>/<ITS>/<version>/<domain+topic>/<service-name>.
Étiquette
Utilisation prévue
<server-id>
Identifiant du serveur exposant le service
<env>
Nom des environnements : (liste à définir)
<realm>
HL7 Realm name: QC, CA, US, UK, etc.
<ITS>
HL7 ITS: XML, CD
<pCSG service version>
Version de la norme pancanadienne ou celle du QC
Optional <local service version>
Optional {major release}.{minor release}
<domain+topic>
HL7 domain name + topic name (liste à definir)
<service-name>
business transaction name
2