Europace AG
Klosterstraße 71, 10179 Berlin
devsupport@europace2.de

Angebote API

API zum Erstellen von BaufiSmart Angeboten basierend auf den Angaben der Erfassten Daten oder eines Vorgangs


Eine API um Finanzierungs-Angebote zu ermitteln.

⚠️ Diese API hieß ehemals Finanzierungsvorschläge API oder Ergebnisslisten API (auch ELI genannt)

Aktuelle Version: 2.0.1

Wesentliche Änderungen zur Version 1.5.

Swagger Spezifikation

Die API ist vollständig in Swagger definiert. Die Swagger Definition wird im YAML-Format zur Verfügung gestellt.: swagger.yaml

Diese Spezifikation kann auch zur Generierung von Clients für diese API verwendet werden. Dazu empfehlen wir das Tool Swagger Codegen

Dokumentation

Generierung des Clients

JAVA mit Retrofit
  1. Die aktuelle Swagger-Codegen Version, mindestens 2.2.2, downloaden
  2. Client mit folgendem Kommando generieren:

Example:

java -jar swagger-codegen-cli-2.2.2.jar generate -i swagger.yaml -l java -c codegen-config-file.json -o europace-api-client

Example codegen-config-file.json:

{
  "artifactId": "europace-api-client",
  "groupId": "de.europace.api",
  "library": "retrofit2",
  "artifactVersion": "0.1",
  "dateLibrary": "java8"
}

Authentifizierung

Die Authentifizierung läuft über den OAuth2 Flow vom Typ ressource owner password credentials flow. https://tools.ietf.org/html/rfc6749#section-1.3.3

Credentials

Um die Credentials zu erhalten, erfagen Sie beim Helpdesk der Plattform die Zugangsdaten zur Auslesen API, bzw. bitten Ihren Auftraggeber dies zu tun.

Schritte
  1. Absenden eines POST Requests auf den Login-Endpunkt mit Username und Password. Der Username entspricht der PartnerId und das Password ist der API-Key. Alternativ kann ein Login auch über einen GET Aufruf mit HTTP Basic Auth auf den Login-Endpunkt erfolgen.
  2. Aus der JSON-Antwort das JWToken (access_token) entnehmen
  3. Bei weiteren Requests muss dieses JWToken als Authorization Header mitgeschickt werden.

Ein Beispiel mit curl sähe wie folgt aus:

curl -X POST \
  https://api.europace.de/login \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -d 'username={{BaufiSmart Nutzername (Mail-Adresse)}}&password={{BaufiSmart Passwort}}'

Der in der Antwort enthaltene Access-Token muss bei allen Folge-Requests im Header Authorization im Bearer-Format mit gesendet werden. Beispiel:

curl -X POST \
  https://baufismart.api.europace.de/v2/ergebnisliste/ermittlung \
  -H 'authorization: Bearer {{access_token}}' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
        "vorhaben": {
          ...
        }
      }'

Ergebnisse abrufen

Ermittlungsanfrage mit übermitteln

Für Ergebnisse/Finanzierungsvorschläge benötigen wir einen Darlehenswunsch. Ein möglicher Beispiel-Request wäre:

curl -X POST \
  https://baufismart.api.europace.de/v2/ergebnisliste/ermittlung \
  -H 'authorization: Bearer {{access_token}}' \
  -H 'cache-control: no-cache' \
  -H 'content-type: application/json' \
  -d '{
      "vorhaben": {
        "finanzbedarf": {
          "kaufpreis": 100000
        },
        "finanzierungswunsch": {
             "darlehensWuensche": [
               {
                 "annuitaetenDarlehen": {
                     "darlehensBetrag": 150000,
                     "provision": 1,
                     "tilgungsWunsch": {
                         "anfaenglicheTilgung": 2,
                         "volltilgerWennAnnuitaetenOderForward": false
                     },
                     "bereitstellungsZinsFreieZeitInMonaten": 2,
                     "sondertilgungOptionalJaehrlich": 100,
                     "zinsBindungInJahren": 10
                 }
               }

             ]
        }
      }
    }'

Ermittlungsanfrage mit Vorgangsnummer

Als valide Eingaben für diese Schnittstelle können die Ergebnisse der Vorgänge-API verwendet werden.

Desweiteren können auch direkt zu einem bestehenden Vorgang Finanzierungsvorschläge abgerufen werden:

curl -X POST \
  https://baufismart.api.europace.de/v1/finanzierungsvorschlaege/{vorgangsNummer}  \
  -H 'authorization: Bearer {{access_token}}' \
  -H 'cache-control: no-cache'
curl -X POST \
  https://baufismart.api.europace.de/v2/ergebnisliste/ermittlung?vorgangsNummer={vorgangsNummer}  \
  -H 'authorization: Bearer {{access_token}}' \
  -H 'cache-control: no-cache'

Häufige Fragen / FAQ

Es kommen keine oder wenige Angebote, woran liegt das?

Einige Anbieter sind nur regional aktiv -- um diese Angebote zu erhalten müssen "haushalte" und "finanzierungsobjekt" gefüllt sein

Wie erhalte ich Angebote mit KfW Produkten?

Hierfür müssen sie die Berechnung von Alternativen explizit anfordern: https://baufismart.api.europace.de/v2/ergebnisliste/ermittlung?vorgangsNummer=AB1234&alternativen=true

Kann ich meine eigene TraceId beim absenden des Requests mitgeben?

Ja. Der Vorteil dabei ist, dass wir Deinen Request in unserem System verfolgen und schneller und gezielter debuggen können.

Es geht mittels einem HTTP Header: x-TraceId. Den Wert kannst Du beliebig wählen. Es ist ratsam, bei jedem Request eine neue TraceId mitzugeben, damit Traces in unserem System eindeutig auffindbar sind.

Fragen und Anregungen

Bei Fragen und Anregungen entweder ein Issue in GitHub anlegen oder an devsupport@europace2.de schreiben.

Wir sind für Dich da! Wir beantworten gerne alle Fragen