Heizreport API v2

REST API einfach erklärt

Diese Seite beschreibt die neue REST API unter /api/v2. Die Authentifizierung erfolgt über einen Bearer-Token im HTTP-Header. Pro Token sind aktuell maximal 5 Requests pro Sekunde erlaubt.

Base URL: https://heizreport.net/api/v2 Auth: Authorization: Bearer TOKEN Format: JSON Rate Limit: 5 Requests / Sekunde / Token

Schnellstart

Jeder geschützte Request braucht den Bearer-Token im Header.

curl -X GET "https://heizreport.net/api/v2/health" \
  -H "Accept: application/json"

curl -X GET "https://heizreport.net/api/v2/reports" \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Accept: application/json"

Verfügbare Funktionen

GET /health

Einfacher Healthcheck für Monitoring und schnelle Verbindungsprüfungen.

Keine Authentifizierung notwendig.
{
  "status": "ok",
  "timestamp": "2026-04-23T07:00:00+00:00"
}
POST /reports

Legt ein neues API-Projekt an und gibt den Projekt-Key sowie Basisdaten zurück.

Auth erforderlich.
curl -X POST "https://heizreport.net/api/v2/reports" \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Accept: application/json"
POST /reports/with-data

Legt ein neues Projekt an und schreibt direkt erlaubte Projektdaten hinein.

Auth erforderlich.
{
  "projektData": {
    "projektName": "Max Mustermann",
    "projektPostleitzahl": "10115",
    "telefon": "+49 30 123456"
  }
}
PATCH /reports/{projektKey}

Aktualisiert bestehende Projektdaten für ein eigenes Projekt.

Auth erforderlich. Nur freigegebene Felder werden verarbeitet.
{
  "projektData": {
    "projektName": "Neuer Name",
    "projektPostleitzahl": "50667"
  }
}
PUT /reports/{projektKey}/password

Ändert das Projektpasswort. Das Passwort muss mindestens 12 Zeichen lang sein.

Auth erforderlich.
{
  "newPassword": "einSehrLangesPasswort123"
}
GET /reports/{projektKey}/pdf?type=heizreport

Erzeugt einen PDF-Link. type kann heizreport oder check sein.

Auth erforderlich.
curl -X GET "https://heizreport.net/api/v2/reports/abcdefghi/pdf?type=check" \
  -H "Authorization: Bearer DEIN_API_TOKEN"
GET /reports/{projektKey}/pictures

Gibt alle verknüpften Bilder mit Typ und Raumbezeichnung zurück.

Auth erforderlich.
GET /reports/{projektKey}/results

Liefert die Ergebnisdaten. Optional können vorlaufT und spreizung übergeben werden.

Auth erforderlich.
GET /api/v2/reports/abcdefghi/results?vorlaufT=55&spreizung=10
GET /reports

Listet alle eigenen Projekte, Leads, API-Projekte und Archiv-Einträge des Tokens auf.

Auth erforderlich.

Erlaubte Projektfelder

Diese Felder können aktuell über projektData gesetzt oder aktualisiert werden:

projektName
projektPostleitzahl
projektArtHeizung
projektAlterHeizung
projektBewohner
projektJahresverbrauch
projektBaujahr
projektTrinkwasser
projektWaermeerzeugerSolarStatus
projektWaermeerzeugerSolarArt
projektKollektorflaecheSolar
projektWaermeerzeugerHolzStatus
projektJahresverbrauchHolz
projektWaermeerzeugerHolzArt
email
anrede
vorname
name
strasse
hausnummer
plz
ort
telefon
bemerkungen

Typische Antworten

Erfolgreich

{
  "status": 200,
  "action": "createReport",
  "projektHeader": {
    "key": "abcdefghi",
    "link": "https://heizreport.net/report/p=abcdefghi",
    "id": 12345,
    "status": 1
  },
  "projektData": {
    "projektName": "Max Mustermann"
  }
}

Fehler

{
  "status": 401,
  "error": "Bearer-Token fehlt oder ist ungültig",
  "details": {
    "type": "authentication"
  }
}