Aperçu
Système de gestion centralisée de codes de référence et mise à disposition d'API REST spécifiques destinés à la consultation de ces codes
Services IT génériques
Sous-domaineSoftware factory - non lié à la sécurité
TypologieSystem
Service ownerONSS
2024
Réutilisation6
Effort d'intégrationQuelle en est l'utilité ?
Si vos applications ou services doivent consulter des listes publiques de codes de référence de la sécurité sociale, ils pourront appeler directement un service REST referenceData, spécifique à leur domaine, et obtenir la version désirée à une période précise de ces codes de référence.
Vous devez gérer une liste de codes de référence spécifique à votre domaine métier, avec l’aide de l’équipe de support, vous pouvez réaliser une API REST spécifique à votre métier et disposer d’une interface en ligne et d’un système centralisé afin d’éviter la duplication de ces données en de multiples versions.
Description fonctionnelle
Dans de nombreuses applications, des données dites de « référence » sont utilisées et doivent être maintenues à jour. Ces données de références sont des informations fondamentales qui servent de base à une organisation/un système d’information. Elles sont généralement stables et ne changent pas fréquemment.
Le système Reference Data Management permet de gérer ces codes de référence ainsi que des données associées ou des liens, et de les mettre à disposition d’applications tierces sous forme d’API REST spécifiques afin de faciliter leur réutilisation.
Les API REST referenceData offrent les fonctionnalités suivantes :
- Consulter les différents types de code de référence
- Rechercher et consulter les différents codes de référence d’un certain type
- Consulter les codes de référence et leurs détails, comme leurs labels, périodes d’activité et attributs
- Consulter les différents types de liens entre des codes de référence
- Rechercher et consulter les différents liens d’un certain type
- Consulter les liens entre les codes de référence
- Exporter les codes de référence et les liens
Reference Data Management c’est également une interface en ligne permettant aux utilisateurs de consulter et gérer les codes de référence et leurs détails, comme leurs labels, périodes d’activité et attributs, ainsi que les liens entre les codes de référence et ce, de manière centralisée.
L’interface utilisateur de gestion répond aux exigences légales en matières d’accessibilité numérique, notamment aux WCAG 2.1 niveau AA.
Sa réutilisation permet de produire des interfaces utilisateurs accessibles, mais ne dispense pas le site ou l’application qui l’utilise d’une vérification globale.
Description technique
Le système Reference Data Management est un ensemble d’API REST pour la gestion des codes de référence, enregistrés dans une base de données PostgreSQL. Ces API sont également appelables via une interface graphique Angular.
Public cible
Toute institution partenaire qui souhaite consulter des codes de référence ainsi que les liens entre eux ou qui souhaite mettre des codes de référence à disposition des autres institutions partenaires.
Conditions d'intégration
Si les codes de référence sont offerts via des API REST non sécurisées, ils seront accessibles sans conditions d’intégration.
Si les codes de référence sont offerts via des API REST sécurisées, l'utilisateur devra disposer d'un certificat applicatif, qui peut être demandé auprès de supportcertificates@smals.be. L'URN de l'application devra être ajouté aux règles d’accès du service via le « Dossier Unique ».
Pour ajouter de nouvelles listes de codes de référence dans le système Reference Data Management, il faudra vérifier si la situation répond aux critères d’acceptation suivants :
- Les données sont des données de référence, des informations fondamentales qui servent de base à une organisation/un système d’information. Elles sont généralement stables et ne changent pas fréquemment
- Les données de référence sont utilisées par plusieurs clients/business
- Les données de référence ne sont pas privées (RGPD)
La demande sera ensuite analysée par l’équipe ReferenceDataMgt sur base du :
- Contexte (domaine, stakeholders, usecase des codifications, etc)
- Planning
- Liste des codes et liens
Un travail collaboratif avec le client sera nécessaire afin de définir une API referenceData spécifique, en respectant les standards de Reference Data Management.
Documentation
- Gouvernance des API spécifiques
- Nouvelle intégration d'une API spécifique
- Analyse fonctionnelle
- Informations techniques
Contact
Contact : ReuseOperational@smals.be