Skip to content

europace/baufismart-vorgaenge-api

Repository files navigation

Vorgaenge-API

Als Vermittler kann ich mit dieser API alle Daten aus meinen Vorgängen auslesen.

Vertrieb Baufinanzierung

Authentication GitHub release

Pattern

Dokumentation

YAML YAML YAML

Anwendungsfälle der API

  • eigene Finanzierungsvorschläge mit individuellem Aufbau und Design erstellen
  • eigenes CRM-System mit den BaufiSmart Daten aktualisieren
  • Kundenbetreuer und Sachbearbeiter ändern und so die Auslastung der Mitarbeiter automatisch steuern
  • individuelle Benachrichtigungen erzeugen
  • Anträge als vollständig kennzeichnen

Schnellstart

Damit du unsere APIs und deinen Anwendungsfall schnellstmöglich testen kannst, haben wir eine Postman-Collection für dich zusammengestellt.

Authentifizierung

Bitte benutze Authentication, um Zugang zur API bekommen. Um die API verwenden zu können, benötigt der OAuth2-Client folgende Scopes:

Scope API Use case
baufinanzierung:vorgang:lesen Daten des Vorgangs auslesen
baufinanzierung:echtgeschaeft nicht nur Testvorgänge abrufen, sondern produktive Vorgänge

Beispiel: Vorgang Auslesen

Für das Auslesen eines Vorgangs wird die sechs-stellige alpha-nummerische Vorgangsnummer (z.B. CH6407) als Referenz und ein gültiger Access-Token gebraucht. Der Access-Token muss Zugriffsrechte auf den Vorgang haben.

Request:

curl --location --request GET 'https://api.europace2.de/v2/vorgaenge/{{vorgangsnummer}}' \
--header 'Authorization: Bearer {{access_token}}'

Response:

siehe API-Spezifikation

Beispiel: zuletzt geänderten Vorgänge ermitteln

Die API stellt eine Liste mit Vorgängen zur Verfügung, auf die der Access-Token Zugriff hat. Diese Liste ist absteigend sortiert nach der letzten Änderung. Damit wird ermöglicht, dass man zwischen zwei Zeitpunkten alle sich veränderten Vorgänge ermitteln und in einem weiteren Schritt auslesen kann.

Request:

curl --location --request GET 'https://api.europace2.de/v2/vorgaenge' \
--header 'Authorization: Bearer {{access_token}}'

Response:

{
    "vorgaenge": [
        {
            "datenKontext": "ECHT_GESCHAEFT",
            "vorgangsNummer": "A74QK3",
            "letztesEreignis": "2020-12-30T09:53:16.165Z",
            "letzteAenderung": "2020-12-30T09:53:16.126Z",
            "_links": {
                "self": {
                    "href": "https://baufismart.api.europace.de/v2/vorgaenge/A74QK3"
                }
            }
        },
        {
            "datenKontext": "TEST_MODUS",
            "vorgangsNummer": "ED7PIS",
            "letztesEreignis": "2020-12-30T09:52:34.557Z",
            "letzteAenderung": "2020-12-30T09:53:15.331Z",
            "_links": {
                "self": {
                    "href": "https://baufismart.api.europace.de/v2/vorgaenge/ED7PIS"
                }
            }
        },
        {
            "datenKontext": "ECHT_GESCHAEFT",
            "vorgangsNummer": "JA624A"
            ...
        }
    ]
}

Vorgang verändern

Erläuterungen & Patch-Beispiele

Nutzungsbedingungen

Die APIs werden unter folgenden Nutzungsbedingungen zur Verfügung gestellt.

Support

Bei Fragen oder Problemen kannst du dich an [email protected] wenden.