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.beta.gouv.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.

Icône information Plus d'informations

Vous souhaitez utiliser l'API? 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 !

Que permet l'API ?

L'API permet, à partir d'une situation d'entrée, d'évaluer l'éligibilité ainsi que le montant d'aides auxquels l'utilisateur peut prétendre.

Plus globalement, elle expose l'intégralité de notre modèle de calcul, ce qui permet d'accéder via le paramètre "fields" à l'ensemble des variables de notre modèle.
Exemple: /api/v1/?ménage.revenu.classe="modeste"&fields=ampleur.pourcent%20d%27écrêtement

Démonstration

Modifier la situation (les paramètres à gauche), puis cliquer sur le bouton "Executer" pour voir le résultat.

URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=eligibilite
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=gestes.chauffage.PAC.air-eau.montant
Icône documentationDocumentation
Geste :
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=MPR.accompagn%C3%A9e.montant
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=gestes.chauffage.PAC.air-eau.MPR.montant
Icône documentationDocumentation
Geste :
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=copropri%C3%A9t%C3%A9.montant
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=m%C3%A9nage.revenu.classe
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=PTZ.montant
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=PAR.montant
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=denormandie.montant
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=gestes.chauffage.PAC.air-eau.CEE.montant
Icône documentationDocumentation
Geste :
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}
URL: https://reno-git-2025-mesaidesreno.vercel.app/api/v1/?fields=taxe+fonci%C3%A8re.montant
Icône documentationDocumentation
Paramètres:
Exécuter
Voir la liste des paramètres
Résultat:
{}

Liste des Paramètres

Spécification

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.

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.

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.

mesaidesreno

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.