⚙️ API Développeur

v2.0.0

Intégrez la puissance des simulateurs Oriven directement dans vos applications via notre API RESTful.

Sommaire

Authentification

L’API Oriven utilise des tokens API Bearer pour l’authentification. Vous devez inclure votre clé API dans le header de chaque requête.

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Vous pouvez générer et gérer vos clés API depuis votre tableau de bord développeur.

Endpoints

POST/api/simulations/solar

Lance une simulation photovoltaïque.

Body Parameters:

{
  "lat": 48.8566,
  "lon": 2.3522,
  "surface_toiture": 45,
  "orientation": "SOUTH",
  "pente": 35
}

POST/api/leads

Crée un nouveau lead qualifié.

Webhooks

Recevez des notifications en temps réel lorsque des événements se produisent (ex: simulation terminée, nouveau lead assigné).

Voir la documentation complète →

Modèles de Données

Toutes les réponses de l’API sont au format JSON. Voici les schémas principaux retournés par les endpoints de simulation.

SimulationResult

{
  "id": "sim_8f3a...",
  "techno": "pac" | "pv" | "isolation",
  "computed_at": "2026-05-14T14:00:00Z",
  "context": { "surface": 110, "region": "ile-de-france", ... },
  "results": {
    "cout_total_ttc": 14200,
    "aides_cumulees": 6800,
    "reste_a_charge": 7400,
    "economies_annuelles": 1240,
    "roi_ans": 8.4
  }
}

Lead

{
  "id": "ld_8f3a...",
  "score": 87,
  "status": "qualified" | "rejected" | "pending",
  "simulation_id": "sim_8f3a...",
  "created_at": "2026-05-14T14:00:00Z"
}

Gestion des Erreurs

L’API utilise les codes HTTP standards. En cas d’erreur, un payload JSON est retourné avec un code et un message explicatifs.

{
  "ok": false,
  "error": {
    "code": "validation_error",
    "message": "surface must be between 20 and 1000",
    "field": "surface"
  }
}

Code HTTP	Code erreur	Signification
400	validation_error	Paramètres invalides
401	unauthorized	Clé API manquante ou invalide
403	forbidden	Scope insuffisant
404	not_found	Ressource introuvable
429	rate_limited	Quota atteint (voir Rate Limits)
500	internal_error	Erreur serveur — réessayer

Limites & Quotas

Les limites sont appliquées par clé API et par fenêtre glissante de 1 heure. Les headers de réponse indiquent l’état du quota courant.

Plan	Requêtes / heure	Burst
Free	100	20 / min
Pro	10 000	200 / min
Enterprise	Illimité*	Sur SLA

* Soumis aux limites infrastructure (fair-use). Contact commercial pour SLA contractuel.

Headers retournés

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9874
X-RateLimit-Reset: 1747234800

Besoin d’un quota plus élevé ? Contactez-nous.