Introduction

Last updated 8 months ago

Ce document est destiné à contenir la documentation de tout ce qui touche de près ou de loin à API Entreprise. API Entreprise sert la donnée de référence administrative ou de meilleure qualité possible pour les entreprises connue des divers ministères et organismes publics en France. Ces données peuvent varier en précision, fraîcheur, fiabilité et public éligible à leur diffusion. La documentation externe indique le contexte donnée pour chaque endpoint publié.

Objet de la documentation

La présente documentation sert à la fois de guide pour les personnes nouvellement arrivées sur le projet et de référence pour l'équipe au quotidien. Elle aura tendance à suivre la structure du ansible (projet very_ansible) qui permet de déployer et administrer l'infrastructure supportant les applicatifs API Entreprise.

La documentation est écrite le plus souvent que l'on y pense de manière inclusive, la bienveillance est de mise, nul.le n'étant parfait.e dans ce processus, on corrigera et améliorera au fil de l'eau.