Pré-analyse DPE

POST

/partners/dpe/pre

curl --request POST \
  --url https://api-demo.apihom.com/partners/dpe/pre \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "dpeId": "2575E3361224X", "customerId": "client-123", "userId": "user-456", "userName": "Jean Dupont", "customerName": "Agence Immobilière XYZ" }'

• Démo / Test

Lance une pré-analyse du DPE et retourne les résultats (classe énergétique, alertes, gains potentiels). Crée aussi un token de connexion pour l’utilisateur.

Alertes possibles :

• block — Le DPE ne peut pas être traité (trop ancien, erreur dans le XML)
• confirm — Normalisation recommandée (écart entre moteur et ADEME)
• warning — Information (pas bloquant)

Authorizations

• partnerAuth

Request Body ^required

Media type application/json

object

dpeId

required

string

/^[0-9]{4}E[0-9]{7}[A-Z]$/

customerId

required

string

userId

required

string

userName

required

string

customerName

required

string

query

object

coef2026

Mode coefficient 2026 (1.9) ou 2025 (2.3)

string

Allowed values: activated desactivated

forceNormalization

Forcer la normalisation pour les écarts entre 5% et 15%

boolean

expireInMinutes

Durée de validité du token de connexion

integer

>= 1

Example

{
  "dpeId": "2575E3361224X",
  "customerId": "client-123",
  "userId": "user-456",
  "userName": "Jean Dupont",
  "customerName": "Agence Immobilière XYZ"
}

Responses

201

Pré-analyse effectuée

Media type application/json

object

url

URL de connexion pour l’utilisateur

string format: uri

maxCalculation

Résultats de la pré-analyse (consommation, GES, deltas)

object

consommationInitiale

number

consommationXML

number

gesInitiale

number

gesXML

number

deltaConso

number

deltaGES

number

warnings

Array<object>

object

id

Identifiant unique de l’alerte

string

type

• block : Erreur bloquante, le DPE ne peut pas être traité
• confirm : Normalisation recommandée, l’utilisateur doit confirmer
• warning : Information, pas bloquant

string

Allowed values: block confirm warning

title

string

content

string

Example

{
  "warnings": [
    {
      "type": "block"
    }
  ]
}

400

Requête invalide

Media type application/json

object

error

Message d’erreur

string

errorObject

Détails supplémentaires (optionnel)

object

Example

{
  "error": "Demande non valide: dpeId is required"
}

401

Non autorisé — clé partenaire invalide ou manquante

Media type application/json

object

error

Message d’erreur

string

errorObject

Détails supplémentaires (optionnel)

object

Example

{
  "error": "Unauthorized"
}