Einleitung und FAQ

Einleitung/Einführung

Erklärung Postman Collection 

Objekt-Zugriff  

Für welche Prozesse ist die JDC-API relevant? 

Allgemeine Erklärung REST/Token/OData/OAuth/Versions-Header 

Erklärung Put/Patch/Get/Post 

Technische Voraussetzungen 

  • Vertriebspartner/Mandanten-Ebene 

Authentifizierung

this HTTP authentication scheme involves providing a valid token for each API request. The API key that you use to confirm the request determines what interactions you can perform on the API. This means that a distinction is made for each account as to which functions are available in each case. 

First, make sure that you retrieve a valid token from the authentication endpoint. See Auth-Doku (https://documenter.getpostman.com/view/4290619/RztmtVLc ) for details on how to obtain a token. 

Rückgabewerte

The JDC API platform uses standard HTTP status codes. The following table gives you an overview of all codes.

Usually response codes in the range 2xx indicate a successful response, in the range 4xx a client error and in the range 5xx a server error (these are rare, however).

Code Header Description
200 OK The request is successful. The information returned with the response depends on the method used in the request.
201 Created The request was accepted and led to the creation of a new resource.
400 Bad request The request could not be understood by the server due to an incorrect syntax. The request may not contain any required parameters or the parameters do not pass the validation.
401 Unauthorized The request requires user authentication. The specified token has expired or is invalid.
404 Not found The server has not found anything that matches the request URI. — oder Versionsheader existiert nicht
422 (NEIN) Non-editable entity The input parameters do not pass the validations.
500 Internal server error The server encountered an unexpected condition which prevented it from fulfilling the request.
502 (NEIN) Bad gateway The server was unable to process your request.

API-Dokumentation

Authentifizierung

https://documenter.getpostman.com/view/4290619/RztmtVLc

Lesende Services

Mitarbeiter
https://documenter.getpostman.com/view/4290632/RzfZPYG4

Kunden, sowie Bankkonten und Notizen zu Kunden
https://documenter.getpostman.com/view/4586476/RzfZPYQu

Kommunikationsmittel zum Kunden
https://documenter.getpostman.com/view/4389651/RzfZPYVK

Dokumente
Die Dokumente-Meta-Daten werden zunächst gelesen zu Kunden, Verträgen, etc.
Dieser Response enthält eine DMSGuid. Mit dieser DMSGuid wird das Dokument über einen separaten Service aus dem DMS abgeholt
https://documenter.getpostman.com/view/4586476/RzfZQYw4

Wiedervorlagen
https://documenter.getpostman.com/view/4389651/RzfZPYBb

Tarife, Anbieter, Sparten, Spartengruppen und Versicherungstypen
https://documenter.getpostman.com/view/4290632/S1TU2dxL

Verträge und Notizen zu Verträgen
https://documenter.getpostman.com/view/4290619/RzZ3Mhqv

Schäden
https://documenter.getpostman.com/view/4389309/Szf3ZpzC

Schreibende Services

für Kunde, Vertrag und Schaden
https://documenter.getpostman.com/view/10575077/Szf817VL?version=latest

Prozessbeispiele

Kunden anlegen und Maklervertrag/Maklervollmacht hinterlegen

BÜ-Anstoßen (Fremdvertrag anlegen für Neukunden)

BÜ-Status abfragen

Datenanreicherung abholen

Schadentracking

Tarife Abfragen

Beispiele für ODATA-Abfragen

Einen bestimmten Mitarbeiter abfragen

Mit Postman Variablen: /crmApiEmployeesStagingJDC/odata/JDC Staging/Mitarbeiter/?$filter=id eq 527246d7-ddb5-dddd-96f8-017631bb4a95

Mit aufgelösten Variablen: https://staging.aragonitservices.de/crmApiEmployeesStagingJDC/odata/JDC Staging/Mitarbeiter/?$filter=id eq 527246d7-ddb5-dddd-96f8-017631bb4a95

Die ersten 10 Mitarbeiter abfragen

Mit Postman Variablen: /crmApiEmployeesStagingJDC/odata/JDC Staging/Mitarbeiter/?$top=10

Mit aufgelösten Variablen: https://staging.aragonitservices.de/crmApiEmployeesStagingJDC/odata/JDC Staging/Mitarbeiter/?$top=10

Die ersten 10 Kunden abfragen

Mit Postman Variablen: /crmApiCustomersStagingJDC/odata/JDC Staging/Kunden/?$top=10

Mit aufgelösten Variablen: https://staging.aragonitservices.de/crmApiCustomersStagingJDC/odata/JDC Staging/Kunden/?$top=10

10 Kunden abfragen und die ersten 10 überspringen

Mit Postman Variablen: /crmApiCustomersStagingJDC/odata/JDC Staging/Kunden/?$top=10&$skip=10

Mit aufgelösten Variablen: https://staging.aragonitservices.de/crmApiCustomersStagingJDC/odata/JDC Staging/Kunden/?$top=10&$skip=10

10 Kunden abfragen, die zwischen 26.05.2019 und 03.06.2019 geändert wurden. Die ersten 10 werden übersprungen.

Mit Postman Variablen: /crmApiCustomersStagingJDC/odata/JDC Staging/Kunden/?$top=10&$skip=10&$filter=Aenderungsdatum gt 2019-05-26T00:00:00.0Z and Aenderungsdatum lt 2019-06-03T00:00:00.0Z

Mit aufgelösten Variablen: https://staging.aragonitservices.de/crmApiCustomersStagingJDC/odata/JDC Staging/Kunden/?$top=10&$skip=10&$filter=Aenderungsdatum gt 2019-05-26T00:00:00.0Z and Aenderungsdatum lt 2019-06-03T00:00:00.0Z

Menü