Beschreibung
Die Status Import API ermöglicht das Importieren eines Status sowie Hinweisen für die nachträgliche Entgegennahme eines Beratungswunsches zu einen Vorgang. Hier finden Sie die Nutzungsbedingungen.
Status Import API
Status und Hinweise importieren
Die Schnittstelle ermöglicht das Importieren eines Status und Hinweisen zu einem bestehenden Vorgang.
Ein neuer Status wird per HTTP POST angelegt. Die URL für das Anlegen eines Status ist:
| Stage | Url |
|---|---|
| production | https://api.drkleinservice.de/vorgang/{vorgangsnummer}/status |
| development | https://testapi.drkleinservice.de/vorgang/{vorgangsnummer}/status |
Die Daten werden als JSON Dokument im Body des POST Requests übermittelt.
| Wert | Datentyp | Beschreibung |
|---|---|---|
| leadquelle | string | Aus welcher Quelle kommt der Status. |
| vorgangsnummer | string | Referenznummer aus Kreditsmart. |
| status | enum | Status zur Entgegennahme eines Beratungswunsches |
| hinweise | string[] | Hinweise zum Status. |
Status
| Wert | Beschreibung |
|---|---|
| KEINE_ANGEBOTE | Die erfassten Kundendaten ergaben keine Angebote. |
| ANGEBOTE_VORHANDEN | Die erfassten Kundendaten ergaben ein oder mehrere Angebote. |
| PERSOENLICHE_BERATUNG | Es sind Angebote möglich, der/die Kunde*in hat nicht vorgeprüft. |
| PRODUKTANBIETER_ABGELEHNT | Es wurden Angebot(e) vorgeprüft, Kunde*in wurde abgelehnt. |
| PRODUKTANBIETER_TIMEOUT | Die Vorprüfung bei dem Produktanbieter ist unterbrochen. |
| PRODUKTANBIETER_TECHNISCHER_FEHLER | Technischer Fehler bei der Vorprüfung. |
| PRODUKTANBIETER_ANGENOMMEN | Antrag vorhanden. |
| ANTRAGSTELLER_POST_VERSAND | Kunde*in wünscht Postversand. |
Ein erfolgreicher Aufruf resultiert in einer Response mit dem HTTP Statuscode 200 OK.
Authentifizierung und Autorisierung
Die Authentifizierung und Autorisierung erfolgt über OAuth2.
Beispiel
Request
Request-Header Name: Authentication
Request Header Value: Bearer {jwt}
Request-Header Name: content-type
Request Header Value: application/json
POST
https://api.drkleinservice.de/vorgang/12345/status
{
"leadquelle": "KREDIT_LEAD",
"status": "KEINE_ANGEBOTE",
"hinweise": "Die erfasste Kundendaten ergaben keine Angebote."
}
Response
{
"europaceVorgangsnummer": "12345",
"messages": []
}
| Wert | Datentyp | Beschreibung |
|---|---|---|
| europaceVorgangsnummer | String | Vorgangsnummer von Kreditsmart zum neuen Vorgang. |
| messages | [String] | Hinweise zum Import des Vorgangs. |