From 5989f427f12535178d7bb07f8412b4de8645f0c0 Mon Sep 17 00:00:00 2001 From: "jan.sandig" Date: Thu, 23 Apr 2020 11:35:59 +0200 Subject: [PATCH] =?UTF-8?q?KITT-58=20#dosimeta=5Fapi=5Fdoku=20#Sequenzdiag?= =?UTF-8?q?ramm=20f=C3=BCr=20das=20Annehmen=20erg=C3=A4nzt.=20API-Beschrei?= =?UTF-8?q?bung=20erweitert.,=20https://europace.atlassian.net/browse/KITT?= =?UTF-8?q?-58?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ... Engine API Annahme Sequenzdiagramm.drawio | 1 + ...ket Engine API Annahme Sequenzdiagramm.svg | 3 +++ README.md | 23 +++++++++++++------ 3 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 KEX Market Engine API Annahme Sequenzdiagramm.drawio create mode 100644 KEX Market Engine API Annahme Sequenzdiagramm.svg diff --git a/KEX Market Engine API Annahme Sequenzdiagramm.drawio b/KEX Market Engine API Annahme Sequenzdiagramm.drawio new file mode 100644 index 0000000..f4e861a --- /dev/null +++ b/KEX Market Engine API Annahme Sequenzdiagramm.drawio @@ -0,0 +1 @@ +7Vxbc+I2FP41POKxdbP9SEiy7WzbZCZtdrdvBgtwYyxWFknYX1/5CrLsYMCGZFvPziyWxJH9ne9cdCQygOPl6yfurRa/M5+GA2D6rwN4PQDAghaR/yUtm7zFdEDWMueBn7dtGx6CH7QYmLeuA5/GykDBWCiCldo4ZVFEp0Jp8zhnL+qwGQvVWVfePJ/R3DY8TL2weA4Db9u/BL5YZO0OINv2X2gwXxRzW8TNeibe9GnO2TrKZxwAOEuvrHvpFbLymeOF57OXnSZ4M4BjzpjIPi1fxzRM4C2Ay75329BbviCnkWjzBXJHbr+PN1/4ozcia3vjiRs+dOxMzLMXrmnxHvLVoVQQvGrxMX0zsSnwnAVhOGYh4+kt9D3qzKZyYCw4e6I7PWTq0MlM9qQI0uQZrVLgM+WCvja+p1WiJ4lJ2ZIKvpFD8i/YTg54wUk7v3/ZqhehvG2xo1pYDPRyUs1L2VtY5Ycc2QaU3RpA3wZpNqNkWguSb7sT02wASUOkBrdGkCy8HyRi9QXSfOGvfkyvh04M7QW4xo/42/XQKgzlAOjGY2QBXMsvYsqrA6QQsBWkoIk1pOqAkhCfDpRunZ859QPxsPS40MApPUxCkgpSIzBGY1dDKmIR7QAkiNzCkeYwAQh0mAjWccId8MnZTxzqS7+f36YvDa9o5I+SELJt8b14UVqZRINvvsob08DF7bfktri5flXuNvldI5wxW/MpVRQrPD6noo1RJM/fiq4OMSDEJnFReqlaIaSGuzXkLRvrtJLPfc8C+YLlxJhYBsCOY0OEie2alupfLFVehkUuYjdoVaQiaBq2+g64IirDUBOVcqbE53i35ML36JUItCsGJ3VutPNMFi6NtXMn7iINrfu7hz8HCY1v4+kiDGgc01E0pxMmRpM2ZpqAEsiM7TdvQsN7FgciYJHsFmy10zsKg3nSKsUKtpQdYWV4SGfy/a+8fBzP8Gi21r0GV+Dem0WVSUqpYXKcEZF9ghpMSLdxVc4QqmLYbBbTfoywJhDefJUNv3v8KZnSvInmQRLKzAfKn4Mp7Sw4dpJuYaIid9boWI/ox4uZbzJjbyQt/HjbQIqhazg7gZSoJuSg3uyeWEjGvKZICoF7rBeA1ZBh2ecNpfraKI8El48DOrFjiYYo2qahF8fBtMr346NHoRQMFZUgEylZlGmfLbxgE3UTXjRBPdPKMvWkQyPU+VM0x9ZSV2jX5d812oSoWZsNbv+vmPK7yT9JkQyYKenfjpOj+18HxeIiDKKnbPRCiKTyNkpmAbfzQCzWE2MqDQnc0jVnKy+JrLdP9HW4TCUOaSpv6K2CTNQeTeEdyHLdtozRPqaOj+o05oCJ1Fo3gdoxwf5Ajcrc+8RQLW931HYQ5Un34fvoGGwVJZH9y9nCVNv6RwcSAzm2g2yQXki1J9Kfe3RcYhAM7OJy1JkLnhzqLN8Wi3BFbN+u06pZ3dpXpmHAxAsu44F9/SavaDhhLzfbhqu0QXYsGA9+sEh4YTWUshWNVCrmLa0i9akBV/LIkMmcjV2Q/as4aNtwXbK9euQX0qY+klEVQWWqejYO6eH3kfJlIERIucYe6eNXycf1MhxNReLDGzM7NYe7KvdblNp5uuOi539ZVrgQy3BfqnZA0dytrKORpdED1rCD9LWIswqv/x8ot1R10INJVusbZan/4Kpl057BoQUXVPEJ/VVYkmy4mUpeFHmLpV5UucAyrSgwdFJeqLCufQaj87OPQgDSirz2kSVAByfV+aoswzQRcE0LJKtNt92qTedopR7fJ0f1rPeDFxB2CmYmUEtmhrttaOB1endPeSCRpfxAsjenSAhqXMHOucoSBFerCRURrSlvq4Uz5LqGbe5c7Xxyd+TVa9gfnLwnMw1CNU6iSuWzR5pVYz2ubtcfG+ux8g5OUWc/F8uInozflIWbCs3UUyUzuVorSFdTf2k4pdLdHglCoBLtLFvPr8uDK8qhlA4S7CH8K/r8K/v7x8vsG4s/ff/yh/84dOp2SUgocrgUOMn3NSs6hnF60m0kB1jm6nXbKT/NUwOUntubx9F6uUzWSJnICS+6DcMoGuVzZ1NlPZoSi/VUxESiiJdFIOhDqm54/cK9yipoe2jtbi3CpBKYtfsef7qT3wrEJgtGeMdL5E6jAx0Du5Jhg5psHtRoGHWg4foDcLqG7znz10/CiyZBGlZPMpuGE3CK2Zx03M2FKqR9Gk1TjTlZmssQksnroZhcrzl3B5fDaslt9ntPUoplAlUrl68j12Lo6ou+N5MRxsWCzVnkhbs1v61BJPnndsxvLElOUgX8Q4XY5Md/vbVgdbUZbTG2pxZd/0Y5ersLufqBDes4TkNPBM/qk3TudorH7HzL6kTa2s6xe1ZHbFm1g6pM7n4ikqK2JHXr9XUmkva1r9o5SRGsqwp2EvNaQnX4se9LQeVcGipwmDm33rrcb5pvAIWg4V5kn9EyHa3cAopf0Ry6GK0TdmSd74gVab26W5yf/VBl5BNoBkx1u9fpjVVO5Ucw5Xm1wxlVkxI46P1WjutJqBeOP7PIT1lCo/fAx3dVPD6B4m5xPL/c+rLOVTmuch4de0ajNmya4KJetO53epdn7YW8qKuoBrs9UqqyhwCPrBJLSrl60oo/mhvVi2VppfLyRPx53CdQ3ScG53OfFa7jys87TuI6hpd0n5b5v/9s9J+WeUYH6nTpQJ2P5kAtU/egj5JF3Ju/Bzr+rF40Sd4u5EWx2aEXlcL68aLydvuHKLLh2z/4AW/+BQ== \ No newline at end of file diff --git a/KEX Market Engine API Annahme Sequenzdiagramm.svg b/KEX Market Engine API Annahme Sequenzdiagramm.svg new file mode 100644 index 0000000..b8770f7 --- /dev/null +++ b/KEX Market Engine API Annahme Sequenzdiagramm.svg @@ -0,0 +1,3 @@ + + +KreditSmartPOST /schliesseAngebotAbKEX Market Engine ServiceAngebotKEX Market Engine API {0..30000ms}
Vermittler
Vermi...
POST /schliesseAngebotAbPOST /annahmeAngebotAngebotEuropace
antragsnummer
...
antragsnummer...
ProduktanbieterBackendKonditionen...Vertrag
Viewer does not support full SVG 1.1
\ No newline at end of file diff --git a/README.md b/README.md index d5b1431..48dd293 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # ⚠ HINWEIS: Diese API befindet sich aktuell in der Entwicklung und eignet sich noch nicht zum produktiven Einsatz! # kex-market-engine-api -API zur Anbindung von Produktanbietern im Ratenkreditgeschäft. +Die API ermöglicht es Produktanbietern (im Ratenkreditgeschäft), Services mit standardisierter API zu implementieren, mit dem Ziel sich an die Europace-Plattform anzubinden. -Die Schnittstelle ermöglicht die Annahme von Ratenkredit-Angeboten. +![](KEX%20Market%20Engine%20API%20Annahme%20Sequenzdiagramm.svg) > :warning: Diese Schnittstelle wird kontinuierlich weiterentwickelt. Daher erwarten wir > von allen Nutzern dieser Schnittstelle, dass sie das "[Tolerant Reader Pattern](https://martinfowler.com/bliki/TolerantReader.html)" nutzen, d.h. @@ -38,9 +38,18 @@ und ist in der [Swagger Definition](https://github.com/europace/kex-market-engin Die aktuelle Version der API ist jeweils in den [Releases](https://github.com/europace/kex-market-engine-api/releases) zu finden. -## Response +## Annahme -### Meldungskategorie +Die Annahme eines Antrags beinhaltet: +- die Ermittlung der Konditionen (inkl. Tilgungsplan), +- die Ermittlung einzureichender Unterlagen, +- die Prüfung der Bonität der Antragsteller +- ein Votum über die Machbarkeit des Antrags (inkl. Berücksichtigung der Scorings externer Anbieter z.B. Schufa) sowie +- die Erstellung der Vertragsdokumente. + +### Response + +#### Meldungskategorie | Meldungskategorie | Beschreibung | |--------|--------| | MACHBARKEIT | Der Antrag wird abgelehnt. | @@ -48,17 +57,17 @@ Die aktuelle Version der API ist jeweils in den [Releases](https://github.com/eu | HINWEIS | Hinweis an den Vermittler. | | ANPASSUNG | Information über eine Anpassung des Kundenwunsches, z.B. Rate, Auszahlungsbetrag oder Versicherungswunsch. | -### Machbarkeitsstatus +#### Machbarkeitsstatus | Machbarkeitsstatus | Beschreibung | |--------|--------| | MACHBAR | Dem Antrag kann entsprochen werden. | | MACHBAR_UNTER_VORBEHALT_PRODUKTANBIETER | Der Antrag konnte nicht abschliessend geprüft werden. | | NICHT_MACHBAR | Der Antrag wurde abgelehnt. | -### Tilgungsplan +#### Tilgungsplan In der Regel werden die Zahlungsperioden nur während des ersten (und ggf. des letzten) Jahres monatlich ausgewiesen. Die folgenden Perioden werden auf Jahresebene aggregiert, um den Tilgungsplan kurz zu halten. -## Beispiele +### Beispiele * [Annahme](beispiele/example-annahme.md)