-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Correct spelling mistakes * Improve formatting
- Loading branch information
Showing
1 changed file
with
28 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,8 @@ | ||
| # Kundenangaben API | ||
|
|
||
| As advisor with Kundenangaben API you can create new cases or update cases with customer data from your crm system or lead applications for a seamless and fast start of advising. | ||
|
|
||
| Kundenangaben are also named as `Erfasste Daten` in Mortgage APIs (Vorgaenge-API or Antraege-API) . | ||
| Kundenangaben are also named as `Erfasste Daten` in Mortgage APIs (Vorgaenge-API or Antraege-API). | ||
|
|
||
|  | ||
|  | ||
|
|
@@ -13,24 +14,29 @@ Kundenangaben are also named as `Erfasste Daten` in Mortgage APIs (Vorgaenge-API | |
| [](https://martinfowler.com/bliki/TolerantReader.html) | ||
|
|
||
| ## Documentation | ||
|
|
||
| [](https://refined-github-html-preview.kidonng.workers.dev/europace/baufismart-kundenangaben-api/raw/master/reference/index.html) | ||
| [](https://github.com/europace/baufismart-kundenangaben-api/blob/master/kundenangaben-openapi.yaml) | ||
| [](https://github.com/europace/baufismart-kundenangaben-api/blob/master/kundenangaben-openapi.json) | ||
|
|
||
| Feedback und Fragen zum Modell sind als [GitHub Issue](https://github.com/europace/baufismart-kundenangaben-api/issues/new) willkommen. | ||
| Feedback and questions about the model are welcome as [GitHub Issue](https://github.com/europace/baufismart-kundenangaben-api/issues/new). | ||
|
|
||
| ## Usecases | ||
|
|
||
| - create case with customer data from CRM system or lead applications | ||
| - get case with customer data | ||
| - to update CRM system or lead applications or | ||
| - to create own financing proposals with your structure, story and design | ||
| - overwrite existing case with customer data | ||
|
|
||
| ## Quick Start | ||
|
|
||
| To test our APIs and your use cases as quickly as possible, we have created a [Postman Collection](https://github.com/europace/api-quickstart) for you. | ||
|
|
||
| In the Postman collection in the folder "BaufiSmart Kundenangaben-API" you will find two examples. Since the data model in the Kundengaben API is very extensive, we provide a way to test/validate requests without storing data in Europace with the „validate customer data" request. This endpoint is for faster connectivity, but is not required for functionality. | ||
|
|
||
| ### Authentication | ||
|
|
||
| Please use [](https://docs.api.europace.de/common/authentifizierung/authorization-api/) to get access to the APIs. The OAuth2 client requires the following scopes: | ||
|
|
||
| | Scope | API Use case | | ||
|
|
@@ -39,7 +45,8 @@ Please use [](h | |
| | `baufinanzierung:vorgang:schreiben` | create cases for mortgage loans | | ||
|
|
||
| ## Create case | ||
| As Advisor you can create a case with your customers data to start seamless and fast advising. | ||
|
|
||
| As advisor, you can create a case with your customers data to start seamless and fast advising. | ||
|
|
||
| > **IMPORTANT: Provide privacy statement** \ | ||
| > Before you transfer consumer data to Europace please note our [terms of use](https://docs.api.europace.de/terms/) and [provide the privacy statement of the advisor](https://docs.api.europace.de/common/privacystatement/) (MUST). | ||
|
|
@@ -57,7 +64,7 @@ Host: baufinanzierung.api.europace.de | |
| Content-Type: application/json | ||
| Authorization: Bearer eyJraWQiOiJZUUZ... | ||
| ``` | ||
| ``` json | ||
| ```json | ||
| { | ||
| "importMetadaten": { | ||
| "datenkontext": "ECHT_GESCHAEFT", | ||
|
|
@@ -243,15 +250,16 @@ Authorization: Bearer eyJraWQiOiJZUUZ... | |
| ``` | ||
|
|
||
| example-response: | ||
| ``` json | ||
| ```http | ||
| 201 - created | ||
| { | ||
| "vorgangsnummer": "YX4MDU" | ||
| } | ||
| ``` | ||
|
|
||
| ## Get case | ||
| As advisor I can read out the data of the case, to create an individual financial proposal for a convincing sales story. | ||
| ## Get case | ||
|
|
||
| As advisor, I can read out the data of the case, to create an individual financial proposal for a convincing sales story. | ||
|
|
||
| Requirements: | ||
| * authenticated as advisor, editor or sales organisation with access to the case | ||
|
|
@@ -268,7 +276,7 @@ Authorization: Bearer eyJraWQiOiJZUUZYT... | |
| ``` | ||
|
|
||
| example-response: | ||
| ``` json | ||
| ```json | ||
| { | ||
| "haushalte": [ | ||
| { | ||
|
|
@@ -317,8 +325,9 @@ example-response: | |
| ``` | ||
|
|
||
| ## Replace case | ||
| As Advisor the input data of the case has to be replaced, to use the current customer data from a crm system or digital self-disclosure. | ||
| > Attention: The data will be completely replaced by the specified values. If data fields are not transferred, the data in the case will be replaced by ’null' and thus deleted. | ||
|
|
||
| As advisor the input data of the case has to be replaced, to use the current customer data from a crm system or digital self-disclosure. | ||
| > Attention: The data will be completely replaced by the specified values. If data fields are not transferred, the data in the case will be replaced by 'null' and thus deleted. | ||
| Requirement: | ||
| * OAuth token has the scope `baufinanzierung:vorgang:schreiben` | ||
|
|
@@ -327,12 +336,13 @@ Requirement: | |
| In the example the entered customer data of case A65JS6 will be replaced. | ||
|
|
||
| example-request: | ||
| ``` http | ||
| ```http | ||
| PUT /kundenangaben/A65JS6 HTTP/1.1 | ||
| Host: baufinanzierung.api.europace.de | ||
| Content-Type: application/json | ||
| Authorization: Bearer eyJraWQiOiJZUUZYT... | ||
| ``` | ||
|
|
||
| ```json | ||
| { | ||
| "updateMetadaten": { | ||
|
|
@@ -352,22 +362,22 @@ Authorization: Bearer eyJraWQiOiJZUUZYT... | |
| ``` | ||
| [Body as in create case (POST)] | ||
|
|
||
|
|
||
| example-response: | ||
| ``` http | ||
| ```http | ||
| 204 - no content | ||
| ``` | ||
|
|
||
| ## FAQ | ||
|
|
||
| ### Where is the case created? | ||
|
|
||
| The owner of a case is always the advsior. His settings are applied to the case and teh advisor usually also receives the sales commission. The editor of the case may differ, for example, if the completion of the customer data is done by a team assistant or a clearing takes place. | ||
|
|
||
| If the advisor is not specified under ‚betreuung', the subject of the API client is entered as advisor in the generated case. If no editor is specified, the user will be asked if he/she wants to take over the editing during the first editing. | ||
| If the advisor is not specified under 'betreuung', the subject of the API client is entered as advisor in the generated case. If no editor is specified, the user will be asked if he/she wants to take over the editing during the first editing. | ||
|
|
||
| If the case is to be created for a different advisor than the API user, then we recommend setting the roles of the case in the object ‚betreuung'. | ||
| If the case is to be created for a different advisor than the API user, then we recommend setting the roles of the case in the object 'betreuung'. | ||
|
|
||
| ``` json | ||
| ```json | ||
| "importMetadaten": { | ||
| "betreuung": { | ||
| "kundenbetreuer": "{{PARTNER_ID}}", | ||
|
|
@@ -407,7 +417,9 @@ We offer the most error-tolerant API possible. Errors would lead to interruption | |
| To increase the error tolerance of the API, the API applies the Tolerant Reader Pattern. That is, fields or enum values that are unknown to the API are ignored. For example, in the type `Bauspardarlehen.abschlussgebuehrmodus` only the values `SOFORTZAHLUNG` and `VERRECHNUNG ` are allowed. Other values are ignored by the API and processed as if the field was empty. | ||
|
|
||
| ## Terms of use | ||
|
|
||
| The APIs are provided under the following [Terms of Use](https://docs.api.europace.de/nutzungsbedingungen). | ||
|
|
||
| ## Support | ||
|
|
||
| If you have any questions or problems, you can contact [email protected]. | ||