API Mes Aides Réno
Notre API vous permet d'intégrer Mes Aides Réno au coeur de votre service. Si votre objectif est simplement de l'intégrer dans une page Web ou un article de blog, nous avons une solution bien plus simple.
ℹ️ Cette API est basée sur le modèle de calcul qui fait tourner mesaidesreno.betagouv.fr, déjà utilisé par des milliers d'utilisateurs par mois. L'API est en version beta, il est de votre ressort d'en avertir vos utilisateur si cela vous semble légitime.
Plus d'informationsNous sommes actuellement en train de revoir notre documentation technique. En attendant, voici notre proposition :
- Accompagnement sur-mesure:
L'un des développeurs de l'équipe, Morgan ou Maël, peut se rendre disponible pour vous assister en live dans l'intégration. D'expérience, 45 minutes suffisent. C'est votre souhait ? Merci d’adresser votre demande ici. Nous prendrons contact avec vous sous 3 jours ouvrés. - Intégration en autonomie:
Vous préférez mettre les mains dans la documentation existante ? Elle est accessible juste en-dessous.
À votre disposition pour avancer ensemble !
Démonstration
Notre API est basée sur Publicodes. Nous vous conseillons de faire un petit tour (10 minutes) sur la documentation de Publicodes pour mieux comprendre ses fondamentaux.
Modifier la situation (les paramètres à gauche), puis cliquer sur le bouton "Executer" pour voir le résultat.
Documentation{}Que permet l'API ?
Calculer les deux parcours Ma Prime Rénov' 2024, accompagné et non accompagné, ainsi que les CEE, à partir de la situation d'un utilisateur.
La situation comprend le revenu fiscal du ménage, les sauts de DPE envisagés, mais aussi le projet d'isolation par geste, et quelques autres données.
L'API est disponible en version GET ou POST.
Que renvoie-t-elle ?
L'API vous renvoie, pour chacun des deux dispositifs de Ma Prime Rénov' : le résultat numérique ou 'Non applicable' ainsi que la liste des questions auxquelles l'utilisateur doit encore répondre (c'est une API conversationnelle).
Spécification
Pour découvrir l'API, le plus simple est de faire votre simulation sur la page d'accueil, ou de cliquer directement sur un persona pour charger une des simulations pré-remplies, puis de préfixer l'URL de simulation par `/api?PARAMÈTRES`.
Publicodes offre nativement une documentation Web qui vous permet d'explorer les calculs de façon granulaire. Pour la découvrir, suivez les liens "Inspection" de la section "Tests" de la page personas.
Mode de simulation
Le modèle de calcul offre deux modes de simulation : le mode "max" qui maximise les aides, et le mode "moyen". Ce mode ne vous importe que si vous voulez afficher un résultat à l'utilisateur avant qu'il finisse de répondre à toutes les questions. Les réponses manquantes (appelées missing variables dans Publicodes) seront remplacées par au choix, des valeurs maximales ou des valeurs moyennes estimées.
Le code
Tout le code du calculateur (site en NextJS), l'API (Route handler NextJS) ainsi que les règles de calcul complètes sont disponibles sur Github. Les règles sont aussi accessibles en JSON à cette adresse.
Privilégiez l'intégration directe du modèle si vous le pouvez
Plutôt que de dépendre d'une API tierce, si vous avez confiance dans votre capacité à mettre des services en ligne, le mieux reste d'intégrer le moteur de calcul publicodes chez vous. C'est ce qui rend la démonstration plus haut si fluide, les calculs sont faits dans votre navigateur, sans appel réseau. Si vous êtes dans un environnement Javascript, il suffit de quelques lignes de code. Sinon, un simple projet Javascript avec ExpressJs permet de faire tourner une API en 30 minutes sur vos serveurs.
Pour ce faire, nous vous proposons un paquet NPM. NPM est le standard de facto de la publication de module de code Javascript.
Démonstration d'intégration
Ci-dessous, un exemple très basique d'intégration du modèle de calcul dans une maquette de projet NextJS.
N'hésitez pas à nous contacter si vous estimez que ce paquet NPM ne répond pas à vos besoins.