Grundlagen zur Nutzung der API-Schnittstelle

Voraussetzung:

  • Ein fertig eingerichteter Business Account mit aktiver Jahreslizenz

  • Aktivierung der API Schnittstelle (erfolgt durch unseren Support, bitte dazu an mail@heizreport.com wenden.


 
Die Schnittstelle kann unter https://heizreport.de/api/ angesprochen werden.
Zum Auslösen der verschiedenen Aktionen sind die Daten als formatiertes JSON-Objekt zu senden.
Beispiel Workflow:
  • Anlegen eines Projektes über den API-Aufruf mit Rückgabe eines neuen ProjektKey
  • Speichern von bereits vorhanden Daten per zweitem API-Aufruf in dem Projekt
  • Einbinden des Heizreport-Abfrageformulars mittels iFrame in die eigene Seite (Beispiel: https://heizreport.de/report/?p=xxxxxxxxx) *xxxxxxxxx = der 9-stellige ProjektKeyAlternativ: zusenden des Links per Mail
  • Am Ende des Eingabeprozesses klickt der Kunde auf speichern. Jetzt wird ein Webhook Event ausgelöst, welches an eine vorher definierte Adresse gesendet wird.
  • Abruf der Dokumente wärmepumpenCHECK oder heizreportKOMPLETT. Die URL zu dem PDF Dokument wird übermittelt und kann weiter verarbeitet werden.
  • Abrufen sämtlicher Berechnungsergebnisse als JSON