{"id":2430,"date":"2021-12-29T08:46:22","date_gmt":"2021-12-29T07:46:22","guid":{"rendered":"https:\/\/digital.gov.mg\/?p=2430"},"modified":"2022-11-14T14:31:08","modified_gmt":"2022-11-14T13:31:08","slug":"normes-et-standards-dinteroperabilite","status":"publish","type":"post","link":"https:\/\/digital.gov.mg\/en\/2021\/12\/29\/normes-et-standards-dinteroperabilite\/","title":{"rendered":"Normes et Standards d\u2019Interop\u00e9rabilit\u00e9"},"content":{"rendered":"\n

Il est \u00e0 noter que cet article est \u00e9volutif dans le temps selon les contextes<\/em><\/strong><\/p>\n\n\n\n

Derni\u00e8re mise \u00e0 jour : 14 novembre 2022 <\/p>\n\n\n\n

Version num\u00e9rique : Normes et standards d’interop\u00e9rabilit\u00e9 v1.0.0<\/a><\/strong><\/p>\n\n\n\n

\nDiffusion pour action <\/strong>\n<\/td>\nTous les services publics\n<\/td><\/tr>
\nDiffusion pour information <\/strong>\n<\/td>\nSecteur priv\u00e9\n<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

DOCUMENTS DE R\u00c9F\u00c9RENCE<\/strong><\/p>\n\n\n\n

\nN\u00b0<\/strong>\n<\/td>\nClassement<\/strong>\n<\/td>\nTitre<\/strong>\n<\/td><\/tr>
\n1\n<\/td> <\/td>\nCadre d\u2019interop\u00e9rabilit\u00e9<\/a>\n<\/td><\/tr>
\n2\n<\/td> <\/td>\nManuel des standards des services<\/a>\n<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

LISTE DES ABREVIATIONS<\/strong><\/p>\n\n\n\n

AES<\/strong> : Advanced Encryption Standard
AMOA<\/strong> : Assistant \u00e0 la Ma\u00eetrise d\u2019Ouvrage
API<\/strong> : Application Programming Interface
AWS<\/strong> : Amazon Web Services
CA<\/strong> : Certification Authority
CNaPS <\/strong>: Caisse Nationale de Pr\u00e9voyance Sociale
CSV <\/strong>: Comma-Separated Values
HTTP<\/strong> : HyperText Transfer Protocol
HTTPS<\/strong> : HyperText Transfer Protocol Secure
IPSEC<\/strong> : Internet Protocol Security
JSON<\/strong> : JavaScript Object Notation
JWT<\/strong> : JSON Web Token
MEF<\/strong> : Minist\u00e8re de l’Economie et des Finances
MEN<\/strong> : Minist\u00e8re de l’Education Nationale
MID<\/strong> : Minist\u00e8re de l’Int\u00e9rieur et de la D\u00e9centralisation
MINJUS<\/strong> : Minist\u00e8re de la Justice
MINSanP<\/strong> : Minist\u00e8re de la Sant\u00e9 Publique
MNDPT<\/strong> : Minist\u00e8re du d\u00e9veloppement Num\u00e9rique, de la transformation Digitale, des Postes et des T\u00e9l\u00e9communications
NTP<\/strong> : Network Time Protocol
OCSP<\/strong> : Online Certificate Service Protocol
OIDC<\/strong> : OpenID Connect
OSI<\/strong> : Open Systems Interconnection
PKI<\/strong> : Public Key Infrastructure
PMO<\/strong> : Partenaire de Mise en Oeuvre
PO<\/strong> : Product Owner
REST<\/strong> : REpresentational State Transfer
RGPD<\/strong> : R\u00e8glement G\u00e9n\u00e9ral sur la Protection des Donn\u00e9es
RSA<\/strong> : R\u00e8glement G\u00e9n\u00e9ral sur la Protection des Donn\u00e9es
SALM<\/strong> : Security Assertion Markup Language
SI<\/strong> : Syst\u00e8me d\u2019Informations
SOAP<\/strong> : Simple Object Access Protocol
SSL<\/strong> : Secure Sockets Layer
SSO<\/strong> : Single Sign-On
TLS<\/strong> : Transport Layer Security
TSA<\/strong> : Time Stamping Authority
UGD<\/strong> : Unit\u00e9 de Gouvernance Digitale
URI<\/strong> : Uniform Resource Identifier
VPN<\/strong> : Virtual Private Network
W3C<\/strong> : World Wide Web Consortium
WSDL<\/strong> : Web Services Description Language
XML<\/strong> : eXtensible Markup Language
X-ROAD SS<\/strong> : X-ROAD Security Server
<\/p>\n\n\n\n

I. Normes de d\u00e9veloppement des Services Web et des API\u2019s <\/strong><\/h1>\n\n\n\n

I.1. Introduction<\/strong><\/h2>\n\n\n\n

Sur la base des normes et des meilleures pratiques utilis\u00e9es \u00e0 l\u2019\u00e9chelle internationale, l\u2019utilisation des directives suivantes pour la construction de services Web et API\u2019s est sugg\u00e9r\u00e9e.<\/p>\n\n\n\n

I.2. D\u00e9finition des param\u00e8tres d\u2019entr\u00e9e\/sortie.<\/strong><\/h2>\n\n\n\n

Il est recommand\u00e9 que l\u2019institution \u00e9tablisse les param\u00e8tres d\u2019entr\u00e9e et de sortie du service selon leur nature. Chaque param\u00e8tre sera clairement d\u00e9fini et d\u00e9crira son objectif. Cette d\u00e9finition facilitera, plus tard, la g\u00e9n\u00e9ration de la documentation respective.<\/p>\n\n\n\n

I.3. Les bonnes pratiques.<\/strong><\/h2>\n\n\n\n

Lors de la mise en \u0153uvre d\u2019un service Web et d\u2019une API, il est important de prendre en compte les exp\u00e9riences de mise en \u0153uvre avec des r\u00e9sultats positifs qui aident \u00e0 am\u00e9liorer ou \u00e0 r\u00e9soudre les probl\u00e8mes lors de la mise en service des services. La syst\u00e9matisation de ces exp\u00e9riences est ce qu\u2019on appelle les bonnes pratiques.<\/p>\n\n\n\n

Il est recommand\u00e9 d\u2019\u00eatre coh\u00e9rent dans la mise en \u0153uvre des services Web et API\u2019s, en maintenant les bonnes pratiques dans tous les services en fonction de la technologie utilis\u00e9e.<\/p>\n\n\n\n

I.4. Validation des messages.<\/strong><\/h2>\n\n\n\n

La validation des messages est effectu\u00e9e pour v\u00e9rifier que la structure des objets utilis\u00e9s dans le service Web et l\u2019API est correcte.<\/p>\n\n\n\n

La validation des messages permet d\u2019\u00e9viter des dysfonctionnements impr\u00e9vus lorsque les clients consomment le service.<\/p>\n\n\n\n

Il est recommand\u00e9 de valider la structure, le format et la qualit\u00e9 des messages, \u00e0 la fois des param\u00e8tres d\u2019entr\u00e9e et de sortie.<\/p>\n\n\n\n

I.5. Gestion des versions<\/strong>.<\/strong><\/h2>\n\n\n\n

Parfois, il est n\u00e9cessaire d\u2019avoir plusieurs versions d\u2019un m\u00eame service. Cela peut arriver lorsque le service pr\u00e9sente de nouvelles caract\u00e9ristiques de fonctionnement (ou en cas de besoin d\u2019autres param\u00e8tres d\u2019entr\u00e9e\/sortie).<\/p>\n\n\n\n

Il est toujours recommand\u00e9 de versionner les services Web et API\u2019s pour \u00e9viter des d\u00e9sagr\u00e9ments aux consommateurs qui utilisent d\u00e9j\u00e0 le service. La gestion des versions doit \u00eatre envisag\u00e9e d\u00e8s le d\u00e9but du d\u00e9ploiement.<\/p>\n\n\n\n

Les changements ou modifications entre les versions sont document\u00e9s et publi\u00e9s conform\u00e9ment aux dispositions de sa Documentation.<\/p>\n\n\n\n

I.6. Gestion des erreurs.<\/strong><\/h2>\n\n\n\n

Tous les probl\u00e8mes pr\u00e9sent\u00e9s par les services Web et API\u2019s doivent \u00eatre identifi\u00e9s, collect\u00e9s et retenus dans la piste d’audit \/ journal, afin que l\u2019institution consommatrice (organisation cliente) interpr\u00e8te les raisons des \u00e9checs.<\/p>\n\n\n\n

Il est recommand\u00e9 que le message d\u2019erreur comporte au moins un code et une description permettant de le comprendre clairement.<\/p>\n\n\n\n

I.7. Codage.<\/strong><\/h2>\n\n\n\n

Les institutions qui participent \u00e0 l\u2019\u00e9change de donn\u00e9es \u00e0 partir d\u2019un service web ou d\u2019un API (m\u00eame s\u2019il \u00e9tait dans une autre langue) doivent interpr\u00e9ter de la m\u00eame mani\u00e8re les caract\u00e8res utilis\u00e9s pour la transmission des messages.<\/p>\n\n\n\n

Pour cette raison, il est toujours recommand\u00e9 d\u2019utiliser l\u2019encodage UTF-8 dans tous les services Web et API\u2019s.<\/p>\n\n\n\n

I.8. Fuseau horaire.<\/strong><\/h2>\n\n\n\n

Il est recommand\u00e9 que tous les services Web et API\u2019s d\u2019interop\u00e9rabilit\u00e9 utilisent le m\u00eame fuseau horaire, afin que toutes les institutions con\u00e7oivent les heures de la m\u00eame mani\u00e8re. Pour notre cas GMT+3.<\/p>\n\n\n\n

I.9. Fichier de services.<\/strong><\/h2>\n\n\n\n

Il est n\u00e9cessaire de documenter les services offerts par chaque institution. Pour chaque service, on doit d\u00e9tailler les donn\u00e9es telles que l\u2019url pour effectuer la consommation, les param\u00e8tres d\u2019entr\u00e9e et les donn\u00e9es de sortie.<\/p>\n\n\n\n

 <\/th>\nInformation technique<\/strong>\n<\/th> <\/th><\/tr><\/thead>
\nAdresse physique du service\n<\/td>\nURL de consommation de service\n<\/td> <\/td><\/tr>
\nType\n<\/td>\nTechnologie utilis\u00e9e pour obtenir des informations de service (SOAP, REST ou autre)\n<\/td>\nObligatoire\n<\/td><\/tr>
\nEnvironnement\n<\/td>\nEnvironnement de d\u00e9veloppement, de test, de production ou autre\n<\/td>\nObligatoire\n<\/td><\/tr>
\nDonn\u00e9es d\u2019entr\u00e9e\n<\/td>\nD\u00e9tail des param\u00e8tres d\u2019entr\u00e9e du service ou des modificateurs\n<\/td>\nObligatoire\n<\/td><\/tr>
\nDonn\u00e9es de sortie\n<\/td>\nD\u00e9tail de la structure de r\u00e9ponse du service\n<\/td>\nObligatoire\n<\/td><\/tr>
\nType de connexion\n<\/td>\nMoyens par lesquels les donn\u00e9es du fournisseur des services sont transmises aux clients\n<\/td>\nObligatoire\n<\/td><\/tr>
\nLogiciels associ\u00e9s\n<\/td>\nLiens logiciels li\u00e9s au service\n<\/td> <\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n