API REST

API Thervy (Vulcain)

Intégrez la puissance du moteur 3CL réglementaire dans vos applications. Simulation DPE, calcul des aides, annuaire RGE et enrichissement de biens : 12 domaines accessibles via une API REST unique.

43+
endpoints
100
req/min
Swagger
documentation OpenAPI
Webhooks
temps réel via webhooks
Voir la documentationCréer ma clé API

12 domaines, une API

Chaque domaine couvre un aspect clé de la rénovation énergétique : DPE, aides, artisans, biens, simulations, enrichissement, webhooks et plus encore.

Compte
/account
2 EP

Infos compte, quotas et usage

Simulations
/simulations
7 EP

CRUD simulations DPE, profil bâtiment, travaux recommandés

Leads
/leads
5 EP

CRUD leads, notes, suivi pipeline

Dossiers
/dossiers
4 EP

CRUD dossiers CEE/MaPrimeRénov', changement statut

Webhooks
/webhooks
5 EP

CRUD webhooks, test ping, evenements temps réel

Utilisateurs
/users
3 EP

Gestion équipe et accès API

Agences
/agencies
3 EP

Gestion agences du réseau

Entreprises RGE
/companies
2 EP

Annuaire 60 000+ entreprises certifiées RGE

MAR
/mar
3 EP

Annuaire Mon Accompagnateur Renov, matching

Referentiel
/works, /energies
4 EP

Travaux, énergies, barèmes aides officiels

Calcul
/calculate
3 EP

Calcul simplifie, simulation après travaux, aides

ADEME
/ademe
2 EP

Données DPE ADEME par adresse ou numéro

Démarrage rapide

Trois étapes pour passer votre premier appel API et obtenir une estimation DPE programmatique.

1

Créez votre compte

Inscrivez-vous en 2 minutes depuis la page d'inscription entreprise. Votre clé API est générée automatiquement et accessible depuis votre espace pro.

2

Authentifiez-vous

Ajoutez votre clé API dans le header Authorization (Bearer). Toutes les requêtes sont authentifiées et trackees avec des quotas par plan.

3

Appelez l'API

Lancez votre premier appel vers /api/vulcain/v1/simulation pour obtenir une estimation DPE. La réponse JSON inclut la lettre, les consommations et les aides disponibles.

curl -sS "https://www.thervy.com/api/vulcain/v1/account" \
  -H "X-API-Key: tv_votre_cle"

Exemples de code

Des exemples prêts à copier en cURL, JavaScript, Python et PHP pour démarrer en quelques minutes.

Requête
curl -X POST https://www.thervy.com/api/vulcain/v1/simulations \
  -H "X-API-Key: tv_votre_cle" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "12 rue de la Paix, 75002 Paris",
    "propertyType": "apartment",
    "area": 65,
    "rooms": 3,
    "constructionYear": 1985
  }'
Réponse 200
{
  "id": "sim_a1b2c3d4",
  "status": "completed",
  "address": "12 rue de la Paix, 75002 Paris",
  "dpe": {
    "letter": "D",
    "value": 231,
    "ges": "E",
    "gesValue": 58
  },
  "estimatedWorks": [
    { "type": "isolation_murs", "gain": 45, "cost": 12000 },
    { "type": "pompe_chaleur", "gain": 38, "cost": 9500 }
  ],
  "estimatedAids": {
    "maprimerenov": 5500,
    "cee": 3200,
    "total": 8700
  }
}

Webhooks temps réel

Recevez des notifications en temps réel quand une simulation est terminée, un lead généré ou un dossier d'aides mis à jour. Configurez vos endpoints depuis votre espace pro.

simulation.createdUne simulation vient d'être créée
simulation.completedLe calcul 3CL est terminé, résultats disponibles
lead.createdUn nouveau lead a été enregistré
lead.updatedLe statut ou les infos d'un lead ont change
dossier.createdUn dossier CEE ou MaPrimeRénov' a été créé
dossier.status_changedLe statut d'un dossier a changé (ex: valide, rejeté)

Sécurité des webhooks

  • Signature X-Thervy-Signature = HMAC_SHA256(body, secret)
  • Headers utiles : X-Thervy-Event, X-Thervy-Timestamp
  • Répondez 2xx rapidement — timeout court cote Thervy
  • Endpoint de test : POST /webhooks/{id}/test

Authentification et sécurité

API Key

Header X-API-Key sur chaque requête. Les clés sont préfixées tv_ et peuvent être révoquées a tout moment.

Rate limiting

100 requêtes par 1 minute. Code 429 avec header Retry-After en cas de dépassement.

CORS

Configurable par clé API. Recommandation : appels serveur à serveur pour ne pas exposer la clé.

Erreurs JSON

Format standard : { "error": "message", "code": 422 }. Codes HTTP semantiques (400, 401, 403, 404, 422, 429).

Référence technique

Documentation OpenAPI complète avec schémas, exemples de requêtes/réponses et codes d'erreur pour chaque endpoint.

Ouvrir Swagger UITélécharger OpenAPI (JSON)

Questions fréquentes

Comment obtenir une clé API ?
Créez un compte entreprise sur Thervy. Votre clé API est générée automatiquement et disponible dans votre espace pro > Paramètres > API. Les plans Pro et Réseau incluent l'accès API.
Quel est le rate limit ?
Le rate limit dépend de votre plan : 60 req/min pour le plan Pro, 300 req/min pour le plan Réseau. Les headers de réponse incluent les quotas restants.
L'API est-elle disponible en sandbox ?
Oui, un environnement sandbox est disponible avec des données de test. Utilisez votre clé API sandbox pour développer et tester sans consommer vos quotas de production.
Comment tester les webhooks ?
Utilisez un outil comme webhook.site ou ngrok pour capturer les événements. Configurez votre URL de webhook depuis votre espace pro. Un bouton "Tester" envoie un événement de test.
Quels formats de réponse sont disponibles ?
L'API retourne exclusivement du JSON (application/json). Les schémas de réponse sont documentés dans la spécification OpenAPI disponible sur /api/vulcain/docs.

Prêt à intégrer Thervy ?

Créez votre compte, générez votre clé API et passez votre premier appel en moins de 5 minutes. Documentation complète et exemples de code disponibles.

Créer mon compteExplorer la documentation

API de rénovation énergétique pour les développeurs

L'API Vulcain de Thervy est la première API REST française dédiée à la rénovation énergétique. Elle couvre l'ensemble de la chaîne de valeur : simulation DPE avec la méthode 3CL, calcul des aides (MaPrimeRénov', CEE, éco-PTZ), annuaire des artisans RGE, enrichissement de biens immobiliers et génération de rapports PDF.

Pensée pour les développeurs, l'API est documentée en OpenAPI 3.0, accessible en JSON, sécurisée par clé API et disponible en sandbox. Les webhooks permettent de recevoir des notifications en temps réel. Idéale pour les portails immobiliers, les CRM bâtiment, les comparateurs d'énergie et les applications de gestion de patrimoine.

Prêt à simuler votre DPE ?

Gratuit, en 30 secondes, avec estimation des aides et du reste à charge.

Simuler mon DPE gratuitement
Nos partenaires
ArtiBoxQualibox
Voir les intégrations →