Le processus Qualicharge en détail

Comment vous raccorder à notre API ?

Avant toute chose, nous vous invitons à consulter notre documentation technique disponible ici 👉 (Ouvre une nouvelle fenêtre) https://fabrique-numerique.gitbook.io/qualicharge

Créer un compte sur notre instance de staging

Afin que nous puissions vous créer un compte sur notre instance de staging, deux possibilités s'offrent à vous, un compte nominatif ou un compte générique partagé (préconisé par nos équipes techniques). Pour ce faire, nous aurions besoin des informations suivantes à envoyer à contact@qualicharge.beta.gouv.fr ou via (Ouvre une nouvelle fenêtre) notre formulaire de contact.

• Nom (ou service)
• Prénom (ou service)
• Email
• Code AFIREV des unités d'exploitation opérées *

* Cette unité d'exploitation doit être publiée sur le site de l' (Ouvre une nouvelle fenêtre) AFIREV pour être rattachée à votre compte.

Vous pouvez demander un compte API par aménageur que vous gérez, avec des autorisations limitées sur les données aménageur associées (associées aux unités d'exploitation de l'aménageur, par exemple FRXXX et FRYYY), ou un compte global gérant l'ensemble de vos aménageurs, avec des autorisations sur toutes les unités d'exploitation associées.

Une fois votre demande effectuée, vous recevrez (dans les 5 jours ouvrés) deux e-mails pour récupérer vos identifiant et mot de passe.

⚠️ Ne tardez pas à les récupérer : les liens expirent au bout de quelques jours.

Se familiariser avec l'API Qualicharge

Notre instance de staging est un environnement de recette identique à l’environnement de production pour vous permettre de réaliser des tests et vous approprier l’API avec des jeux de données statiques ou dynamiques. Les données enregistrées sur la base ne sont pas contrôlées et peuvent être supprimées à tout moment.

Après l’envoi de vos données, un processus de contrôle et de validation de vos données débute.

La documentation officielle de notre API (Swagger) est accessible à l'adresse suivante (Ouvre une nouvelle fenêtre) https://staging.qualicharge.incubateur.net/api/v1/docs

Comprendre le processus de contrôle et de validation de vos données

Les données statiques et dynamiques qui nous sont transmises sont analysées par notre équipe pour en attester la qualité. Vous ne pourrez pas vous connecter à notre instance de production sans passer ces tests.

Le processus de validation s'applique par unité d'exploitation et comporte deux étapes principales :

Étape de validation des données

Cette étape a pour objectif de simuler un flux de production et de contrôler les données enregistrées. Pendant cette phase, des rapports de contrôle sont envoyés régulièrement ou à la demande indiquant les problèmes résiduels à traiter.

👉 Cette étape peut comporter une première boucle de validation avec les données statiques uniquement puis une seconde avec les données dynamiques.

Étape de validation du flux

Lorsque tous les contrôles sont valides, un test final d'une durée de deux semaines est réalisé avec des données de production. Les données doivent être observables et représentatives sur cette période.

A l'issue de cette période, et une fois les critères de qualité des données respectés et validés, un procès verbal (PV) de recette est établi et le flux peut être basculé sur la plateforme de production. Vous recevrez vos identifiant et mot de passe de production selon les mêmes modalités que pour l'instance de staging.

💡 La liste des contrôles et les critères d'acceptation associés sont joints (Ouvre une nouvelle fenêtre) au PV de recette.

Veuillez noter que, pendant la phase de production, les contrôles qualité ont toujours lieu dans une démarche d’amélioration continue.

En résumé, les étapes pour atteindre la mise en production du flux de données sont les suivantes :

En savoir plus sur le contrôle des données

La connexion d'un flux de données dans Qualicharge implique de respecter plusieurs types de contraintes :

• Format des attributs (voir (Ouvre une nouvelle fenêtre) schéma de données)
• Relations entre attributs (lié au (Ouvre une nouvelle fenêtre) modèle de données)
• Contraintes dynamiques (fraîcheur, unicité, cohérence)
• Contraintes spécifiques

Pour cela deux types de traitements sont en place dans QualiCharge :

• Un contrôle a priori au niveau des API : le chargement des données est conditionné par le respect des contraintes liées principalement au format des attributs et aux relations entre attributs
• Un contrôle a posteriori sur un historique de données : celui-ci concerne principalement les contraintes dynamiques et spécifiques