Public
Documentation Settings
No Environment
Double Column
cURL - cURL
Dokumenten-Service API
Introduction
POST
Test-Methode
POST
Dokumente, Verträge und Provisionen auflisten (listTransferitems)
POST
Dokumente, Verträge und Provisionen abholen (getTransferitem)
POST
Dokumente, Verträge und Provisionen bestätigen (acknowledgeTransferitem)
POST
Dokumente abfragen (listShipments)
POST
Dokumente abholen (getShipment)
POST
Dokumente und Daten in Einem abholen (getShipmentV2)
POST
Dokumente bestätigen (acknowledgeShipment)
POST
Bestandsdaten auflisten
POST
Bestandsdaten abholen
POST
Bestandsdaten bestätigen/ löschen
POST
Abrechnungen auflisten
POST
Abrechnung abholen
POST
Abrechnung bestätigen/ löschen
POST
Verfügbare Gesellschaften
POST
Übertragungsprotokolle abrufen
POST
Testnachrichten erstellen
POST
Lieferung senden
POST
Zugangsdaten senden (Benutzername und Kennwort)
POST
Zugangsdaten senden (X509 Zertifikate)
POST
Zugangsdaten senden (OTP/RSA Token)
POST
Zugangsdaten löschen
POST
Zugangsdaten überprüfen
POST
Zugangsdaten auflisten

Dokumenten-Service API

Die API implementiert die allgemeinen Postkorbfunktionen für das Produkt Dokumenten-Service. Es werden Daten und Dokumente darüber bereitgestellt. https://zeitsprung-makler.de/software/dokumentenservice/

POSTTest-Methode

https://api.zeitsprung-makler.de/webservices/webApi/dokumenten-service/status

Bietet bei korrektem Aufruf mit funktionierenden und gültigen Zugangsdaten eine Rückmeldung mit dem Text "hello world". Die Methode dient dazu während der Entwicklung schnell herauszufinden ob der grundsätzliche Clientcode sauber funktioniert und die Zugangsdaten gültig sind die verwendet werden.

HEADERS
Content-Type

application/json

Bodyraw 
{
   "username": "zeitsprungapitestbenutzer",
   "password": "zUbIrE87",
   "apikey": "ab547a4e-f259-11e8-bd9b-000c297d9b43"
}

POSTDokumente, Verträge und Provisionen auflisten (listTransferitems)

https://api.zeitsprung-makler.de/webservices/webApi/dokumenten-service/listTransferitems

Stellt alle im Postkorb verfügbaren Lieferungen für einen Benutzer bereit und liefert die dazugehörigen Poststücke/ Lieferungs-IDs in einer Liste zurück. Die Lieferungen können einzeln anhand einer separaten Methode (getTransferitem) unter Angabe der transferID aus der hier zurückgegebenen Liste abgeholt werden. Bereits abgeholte und bestätigte Lieferungen erscheinen nicht mehr im Lieferungsabruf dieser Methode.

Die Angabe der Request-Parameter für listDocuments, listCommissions, listContracts sind optional. Geben Sie diese bei der Anfrage an listTransferitems nicht mit an, werden automatisch Dokumente, Provisionen und Vertragsdaten in der Lieferungsliste mit als Lieferungen angegeben, sofern diese im Postfach des Benutzers enthalten sind. Sollten Sie einen der drei Parameter mit false angeben (z.B. "listCommissions": false) werden die jeweiligen abgewählten Elemente nicht in der Lieferungsliste der Serviceantwort zurückgegeben (auch wenn formell diese Lieferungen vorhanden wären).

Die Consumer-ID ist eine freie von Ihnen gewählte Angabe, welche uns signalisiert von welcher Software der Request eingeht. Geben Sie hier gerne in Kurzfrom Ihren Softwarenamen oder ein Kürzel Ihrer Software an. Es werden keine Authentifizierungen oder Autorisierungen auf diesen Wert von uns ausgelöst und dient der Statistikerfassung für zeitsprung.

HEADERS
Content-Type

application/json

Bodyraw 
{
   "username": "zeitsprungapitestbenutzer",
   "password": "zUbIrE87",
   "apikey": "ab547a4e-f259-11e8-bd9b-000c297d9b43",
   "consumerid": "Beispiel-MVP",
   "listDocuments": "true",
   "listCommissions": "true",
   "listContracts": "true"
}

POSTDokumente, Verträge und Provisionen abholen (getTransferitem)

https://api.zeitsprung-makler.de/webservices/webApi/dokumenten-service/getTransferitem

Sie müssen zuvor die API mit der Methode listTransferitems aufgerufen haben, um eine gültige für Sie verfügbare Lieferungs-ID (Transferitem-ID) zu erhalten. Die gültigen Transferitem-IDs finden Sie in der Response von /listTransferitems für den angegebenen Benutzer.

Die getTransferitem-API bezieht genau diese eine Lieferung. Es kann sich dabei um verschiedene Responses mit jeweils verschiedenen Response-Modellen handeln, je nach dem welcher fachliche Typ bedient wird. Es gibt Provisionslieferungen (Commissions), Vertragslieferungen (Contracts) und Dateilieferungen (Documents).

Sie finden die verschiedenen möglichen Antwortmodelle und Inhalte in den Responsebeispielen dieser Dokumentation.

HEADERS
Content-Type

application/json

Bodyraw 
{
   "username": "zeitsprungapitestbenutzer",
   "password": "zUbIrE87",
   "apikey": "ab547a4e-f259-11e8-bd9b-000c297d9b43",
   "consumerid": "Beispiel-MVP",
   "transferID": "d#1234567"
}

POSTDokumente, Verträge und Provisionen bestätigen (acknowledgeTransferitem)

https://api.zeitsprung-makler.de/webservices/webApi/dokumenten-service/acknowledgeTransferitem

Bestätigt eine Lieferung die zuvor abgeholt wurde im System als abgeholt, sodass diese nicht erneut über die Lieferungsabfrage per listTransferitems-Methode angezeigt werden wird. Beachten Sie, dass bei der Bestätigung von Transfers in der Testumgebung mit dem öffentlichen Testbenutzer, die Dokumente nicht länger zum Abruf zur Verfügung stehen.

HEADERS
Content-Type

application/json

Bodyraw 
{
   "username": "zeitsprungapitestbenutzer",
   "password": "zUbIrE87",
   "apikey": "ab547a4e-f259-11e8-bd9b-000c297d9b43",
   "consumerid": "Beispiel-MVP",
   "transferID": "d#1234567"
}
Loading