API REST

API Thervy (Vulcain)

Integrez la puissance du moteur 3CL reglementaire 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 reel via webhooks
Voir la documentationCreer ma cle API

12 domaines, une API

Chaque domaine couvre un aspect cle de la renovation energetique : 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 batiment, travaux recommandes

Leads
/leads
5 EP

CRUD leads, notes, suivi pipeline

Dossiers
/dossiers
4 EP

CRUD dossiers CEE/MaPrimeRenov, changement statut

Webhooks
/webhooks
5 EP

CRUD webhooks, test ping, evenements temps reel

Utilisateurs
/users
3 EP

Gestion equipe et acces API

Agences
/agencies
3 EP

Gestion agences du reseau

Entreprises RGE
/companies
2 EP

Annuaire 60 000+ entreprises certifiees RGE

MAR
/mar
3 EP

Annuaire Mon Accompagnateur Renov, matching

Referentiel
/works, /energies
4 EP

Travaux, energies, baremes aides officiels

Calcul
/calculate
3 EP

Calcul simplifie, simulation apres travaux, aides

ADEME
/ademe
2 EP

Donnees DPE ADEME par adresse ou numero

Demarrage rapide

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

1

Creez votre compte

Inscrivez-vous en 2 minutes depuis la page d'inscription entreprise. Votre cle API est generee automatiquement et accessible depuis votre espace pro.

2

Authentifiez-vous

Ajoutez votre cle API dans le header Authorization (Bearer). Toutes les requetes sont authentifiees 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 reponse 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 prets a copier en cURL, JavaScript, Python et PHP pour demarrer en quelques minutes.

Requete
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
  }'
Reponse 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 reel

Recevez des notifications en temps reel quand une simulation est terminee, un lead genere ou un dossier d'aides mis a jour. Configurez vos endpoints depuis votre espace pro.

simulation.createdUne simulation vient d'etre creee
simulation.completedLe calcul 3CL est termine, resultats disponibles
lead.createdUn nouveau lead a ete enregistre
lead.updatedLe statut ou les infos d'un lead ont change
dossier.createdUn dossier CEE ou MaPrimeRenov a ete cree
dossier.status_changedLe statut d'un dossier a change (ex: valide, rejete)

Securite des webhooks

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

Authentification et securite

API Key

Header X-API-Key sur chaque requete. Les cles sont prefixees tv_ et peuvent etre revoquees a tout moment.

Rate limiting

100 requetes par 1 minute. Code 429 avec header Retry-After en cas de depassement.

CORS

Configurable par cle API. Recommandation : appels serveur a serveur pour ne pas exposer la cle.

Erreurs JSON

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

Reference technique

Documentation OpenAPI complete avec schemas, exemples de requetes/reponses et codes d'erreur pour chaque endpoint.

Ouvrir Swagger UITelecharger OpenAPI (JSON)

Questions frequentes

Comment obtenir une cle API ?
Creez un compte entreprise sur Thervy. Votre cle API est generee automatiquement et disponible dans votre espace pro > Parametres > API. Les plans Pro et Reseau incluent l'acces API.
Quel est le rate limit ?
Le rate limit depend de votre plan : 60 req/min pour le plan Pro, 300 req/min pour le plan Reseau. Les headers de reponse incluent les quotas restants.
L'API est-elle disponible en sandbox ?
Oui, un environnement sandbox est disponible avec des donnees de test. Utilisez votre cle API sandbox pour developper et tester sans consommer vos quotas de production.
Comment tester les webhooks ?
Utilisez un outil comme webhook.site ou ngrok pour capturer les evenements. Configurez votre URL de webhook depuis votre espace pro. Un bouton "Tester" envoie un evenement de test.
Quels formats de reponse sont disponibles ?
L'API retourne exclusivement du JSON (application/json). Les schemas de reponse sont documentes dans la specification OpenAPI disponible sur /api/vulcain/docs.

Pret a integrer Thervy ?

Creez votre compte, generez votre cle API et passez votre premier appel en moins de 5 minutes. Documentation complete et exemples de code disponibles.

Creer mon compteExplorer la documentation

API de renovation energetique pour les developpeurs

L'API Vulcain de Thervy est la premiere API REST francaise dediee a la renovation energetique. Elle couvre l'ensemble de la chaine de valeur : simulation DPE avec la methode 3CL, calcul des aides (MaPrimeRenov', CEE, eco-PTZ), annuaire des artisans RGE, enrichissement de biens immobiliers et generation de rapports PDF.

Pensee pour les developpeurs, l'API est documentee en OpenAPI 3.0, accessible en JSON, securisee par cle API et disponible en sandbox. Les webhooks permettent de recevoir des notifications en temps reel. Ideale pour les portails immobiliers, les CRM batiment, les comparateurs d'energie et les applications de gestion de patrimoine.

Pret a simuler votre DPE ?

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

Simuler mon DPE gratuitement
Nos partenaires
ArtiBoxQualibox
Voir les integrations →