Skip to content

Catalogue des modules d'intégration

URL : /servicesMenu : Suivi des activités ▸ ServicesPermission requise : service_read (+ service_update pour basculer le statut Activé)

Catalogue des modules d'intégration publiés par la plateforme. Un module = un flux métier standardisé qu'une organisation peut activer.

Catalogue des modules d'intégration

Le compteur en haut affiche le nombre de modules trouvés (ex. « 3 éléments trouvés »). Une barre Rechercher un élément ici permet le filtrage rapide par code module ou nom. À droite, les icônes habituelles sélecteur de colonnes + rafraîchir.

Colonnes

ColonneSignification
Code moduleIdentifiant technique (mi-consultation-droits, mi-adjudication, mi-transmission…). Affiché en badge cliquable.
NomLibellé fonctionnel (Module Adjudication, Module Consultation des Droits, Module Transmission de Données…).
StatutActif (🟢), Maintenance (🟠), Déprécié (⚪).
VersionVersion contractuelle de l'API exposée (ex. 1.0.0).
Date enregistrementHorodatage de publication du module sur la plateforme.
ActivéBascule on/off — voir l'encadré ci-dessous.
Actions📄 Voir le contrat API — ouvre le volet Contrat API (cf. plus bas).

Bascule Activé — passage en maintenance

La bascule Activé dans la dernière colonne pilote le statut du module au niveau plateforme. Cliquer sur le toggle (qui porte le tooltip « Mettre le module en maintenance ») bascule le statut vers Maintenance : les services qui consomment ce module sont coupés le temps de la bascule, les flux entrants reçoivent une erreur de service indisponible.

C'est une action sensible (impact transversal). Réservée aux administrateurs plateforme avec la permission service_update. Prévenez les organisations concernées avant de basculer.

Statuts

Libellé UICode interneSignification
Actif 🟢ACTIVEModule en production, disponible pour activation sur de nouvelles organisations.
Maintenance 🟠MAINTENANCEEn maintenance temporaire — les flux dépendants sont coupés. À utiliser pour les opérations de mise à niveau planifiées.
DépréciéDEPRECATEDDéprécié — ne doit plus être activé sur de nouvelles organisations. Les services existants continuent de fonctionner.

Modules couramment déployés

CodeDescription
mi-consultation-droitsVérification en temps réel des droits d'un assuré (ayants droit, plan, taux de couverture). ResourceCode : rights.
mi-adjudicationDécision de prise en charge d'actes de soin, acte par acte. Expose deux endpoints : /claims (resourceCode claim) pour la décision, /invoices (resourceCode invoice) pour la facturation de clôture.
mi-transmissionEnvoi en lot (batch) de données inter-organisations — principalement la base d'adhérents (POPULATION). Asynchrone, via REST + URL pré-signée S3 ou SFTP, au format NDJSON ou CSV. Pattern fan-out : 1 émetteur → N destinations.

Contrat d'un module

Chaque module publie un contrat qui décrit :

  • connectors[] — connecteurs disponibles : code (REST_SYNC, REST_ASYNC, SFTP_OUTBOUND…), direction (INBOUND = entrant dans la plateforme / OUTBOUND = sortant de la plateforme), protocole (REST / SFTP), types d'authentification supportés, champs requis et optionnels, capacités.
  • supportedResourceCodes — codes de ressources acceptés. Dépend du module : rights pour la consultation des droits, claim et invoice pour l'adjudication, POPULATION (ou d'autres codes libres) pour la transmission. * signifie « toutes les ressources ».
  • baseUrl — URL de base du module.
  • healthEndpoint — endpoint de santé.
  • contractHash — empreinte du contrat, change à chaque évolution.

C'est ce contrat qui alimente les listes déroulantes du formulaire d'ajout de service.

Volet de détail — Contrat API

Cliquez sur l'icône 📄 « Voir le contrat API » dans la colonne Actions (ou sur la ligne) pour ouvrir le volet « Contrat API ». Ce volet affiche la spécification OpenAPI 3.0 complète du module — telle que publiée par le micro-service.

L'en-tête affiche : nom du module (ex. AdjudicationServiceAPI v1 OAS 3.0), URL de base et liste des serveurs disponibles :

http://mi-adjudication:8290     — Production (réseau Kubernetes interne)
http://mi-adjudication-dev:8290 — Développement
http://localhost:8290           — Local

Le contenu est organisé par regroupements (tags) :

  • Flux Métier — endpoints fonctionnels (ex. POST /claims pour l'adjudication, POST /invoices pour la facturation, POST /rights/check pour la consultation, POST /transmission/dispatch pour l'envoi batch).
  • Administration — endpoints d'exploitation : GET /health (santé), métriques, statut des dépendances.

Pour chaque endpoint sont listés : verbe HTTP, chemin, libellé court, description, paramètres, schéma de requête et de réponse, codes d'erreur.

Boutons disponibles :

  • Authorize — déclare un credential (clé API ou jeton OAuth2) pour tester depuis l'interface.
  • Ouvrir dans un nouvel onglet — bascule vers la spec en mode plein écran (Swagger UI standalone).
  • Fermer — ferme le volet.

Pour exposer le contrat aux partenaires

La spec OpenAPI affichée ici est aussi exportable au format JSON / YAML par le bouton Ouvrir dans un nouvel onglet. Elle peut être partagée à un partenaire technique pour générer son client (Java, .NET, Postman…).

Actions accessibles

Le catalogue est alimenté automatiquement par les MI eux-mêmes au démarrage (auto-déclaration). Les seules actions disponibles depuis la console sont :

  • Bascule Activé (toggle de la colonne) — passe le module en Maintenance ou le réactive en Actif. Voir l'avertissement plus haut.
  • Voir le contrat API (icône 📄) — affiche la spec OpenAPI complète.

Pour activer un module sur une organisation précise, voir :

Voir aussi

Documentation ASACI Santé Connect