API Ma Prime Rénov' 2024

Vous pouvez utiliser ce calculateur via notre API.

C'est une API Publicodes. Nous vous conseillons de faire un petit tour (10 minutes) sur la documentation de Publicodes pour mieux comprendre ses fondamentaux.

⚠️ Attention, cette API bien que fonctionnelle, n'est pas encore suffisamment testée. Ne l'utilisez pas en production ou assurez-vous d'avoir averti vos utilisateurs sur ses inexactitudes potentielles.

Démonstration

Que permet-elle ?

Elle permet de calculer les deux parcours Ma Prime Rénov' 2024, accompagné et non accompagné, à 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 n'est pour l'instant disponible qu'en méthode GET : tous les paramètres de la simulation sont à sérialiser dans l'unique URL de simulation.

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', la liste des questions auxquelles l'utilisateur doit encore répondre (c'est une API conversationnelle), ainsi que l'objet complet de simulation Publicodes.

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 (appellé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 addresse.

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. Nous publierons un paquet NPM tout prêt.