Logo immonex QV

Dokumentation

immonex QV kann über Rest-API oder über eine Integration in vorhandenen Anwendungen genutzt werden.

Für den Zugriff auf immonex QV benötigen Sie einen Lizenzschlüssel (den API-Key).
Diesen können Sie unter Meine Lizenz abrufen. Dort sind ebenfalls Download-Links zu den Anwendungen enthalten.

Anwendungen

Folgende Anwendungen unterstützen immonex QV:

REST-API

Die Spezifikation der Rest-API finden Sie unter https://api.immonex-qv.de/apidoc.

Abläufe

Folgend einige Beispielabläufe für die Nutzung der API.

Status

GET /status liefert die Anzahl der Abfragen für den aktuellen Monat und die möglichen Abfragen.
Das Feld logos enthält die bereits hochgeladenen Logodateien (mit sha1-Hash), diese können dann später ohne neues Hochladen verwendet werden.

Bewertung ausführen

POST /valuation/asset-value erstellt aus den übergebenen Daten die Sachwert-Bewertung nach ImmoWertV-Verfahren.

Bewertung anpassen

PUT /valuation/{id} überschreibt die Werte, die aus der vorherigen Abfrage ermittelt wurden. Dies ist hilfreich, wenn man nach einer Auswertung eigene Anpassungen vornehmen will.

Test / Dry Run

Die Bewertung via POST /valuation/asset-value ist der kostenpflichtige Teil der API, d. h. bei Ausführung verringert sich die Anzahl der möglichen Abfragen in diesem Monat.

Möchte man in der Test-/Entwicklungsphase die API testen, dann kann diese Methode mit dem Parameter dryRun (Bool: true) aufgerufen werden. Es findet dabei keine echte Bewertung statt, stattdessen erhält man eine vordefinierte Antwort.

Fehlerbehandlung

Bei Fehler wird der entsprechende HTTP-Statuscode gemeldet und ein Objekt:

{
  status: 'error',
  statusCode: 400,
  statusText: 'Bad Request',
  error: {
    message: 'Kurze Fehlerbeschreibung.'
    // optional
    details: [
      {
        code: 'invalid_string', // zod-/app-Fehlercode
        message: 'Spezifische Fehlerbeschreibung.',
        path: ['feldname'],
        expected: 'string',
        received: 'number',
      }
    ],
    id: 'api call id', // nur zur internen Fehleranalyse
    ip: 'your ip',
  }
}

Der code in den details ist i.d.R. nicht wichtig, path + message enthalten die relevanten Informationen.