REST API v1 · OpenAPI 3.1

API publique Efficience Platform

Intègre Efficience à ton SI : ERP, logiciel syndic, IoT, BI. Tokens Bearer, rate limit 1000 req/min, webhooks signés.

📖 Documentation OpenAPI 🔑 Générer un token API

🚀 Quick start

curl exemple — récupérer ses sites

curl https://api.platform.fr/v1/sites \
  -H "Authorization: Bearer eff_live_sk_4242abcd..." \
  -H "Accept: application/json"

# Response 200 OK
{
  "data": [
    {
      "id": "site-001",
      "nom": "Résidence Les Tilleuls",
      "adresse": "12 rue Jeanne d'Arc, 76000 Rouen",
      "energie": "gaz",
      "puissance_kw": 350,
      "syndic": { "id": "syn-001", "nom": "Foncia Rouen" },
      "contrats_actifs": 1,
      "url": "https://efficience.platform.fr/sites/site-001"
    }
  ],
  "pagination": { "total": 5, "page": 1, "per_page": 20 }
}

📡 Endpoints REST

Méthode	Endpoint	Description	Auth
GET	/api/v1/sites	Liste tous les sites du tenant	🔒
GET	/api/v1/sites/{id}	Détail d'un site	🔒
POST	/api/v1/sites	Créer un nouveau site	🔒
GET	/api/v1/equipements	Liste équipements (filtre par site)	🔒
POST	/api/v1/interventions	Créer une intervention	🔒
GET	/api/v1/contrats	Liste contrats P2/P3 actifs	🔒
GET	/api/v1/carnet/{siteId}	Entrées carnet de chaufferie d'un site	🔒
POST	/api/v1/carnet/{siteId}/entry	Ajouter entrée au carnet (immutable après validation)	🔒
GET	/api/v1/rapport-ag/{siteId}/{annee}	Générer rapport AG (PDF base64)	🔒
GET	/api/v1/fgas/cerfa/{siteId}/{annee}	Générer CERFA 15497 PDF	🔒
GET	/api/v1/devis	Liste devis	🔒
POST	/api/v1/devis	Créer un devis	🔒
POST	/api/v1/devis/{id}/send	Envoyer devis au syndic	🔒
GET	/api/v1/portail/{token}	Données portail syndic (public token)	🌐
POST	/api/v1/portail/{token}/ticket	Soumettre demande intervention	🌐

🔔 Webhooks

Configure une URL pour recevoir les événements en temps réel. Signature HMAC-SHA256 dans le header X-Efficience-Signature.

intervention.createdNouvelle intervention créée

intervention.completedIntervention terminée + signée

carnet.entry.validatedEntrée carnet immutable validée

rapport-ag.generatedRapport AG annuel généré

devis.signedDevis signé électroniquement par syndic

ticket.createdTicket portail soumis

alerte.detectedAlerte sur-conso ou panne détectée

contract.expiringContrat à 60j/30j/15j de l'échéance

📦 SDKs officiels

🟨

Node.js / TypeScript

npm install @efficience/sdk

🐍

Python

pip install efficience-platform

🐘

PHP

composer require efficience/php-sdk

⚙️ Limites & quotas

Rate limit	1000 req/min · burst 200
Plan inclus	Multi · Enterprise (read-only sur Pro)
Tokens	10 max actifs · rotation libre
Permissions	Granulaires par scope (read:sites, write:devis, ...)
Webhooks	5 endpoints max · retry 3x sur 4xx/5xx