Alle Endpunkte auf einen Blick
Durchsuchen Sie die Schnittstelle, öffnen Sie einzelne Operationen und sehen Sie Parameter, Berechtigungen und mögliche Antworten direkt im Browser.
Gegenprüfungen
Vorgänge einreichen, Status abfragen, Berichte abholen
get/api/v1/gegenpruefungenVorgänge auflisten
Vorgänge Ihrer Organisation, neueste zuerst. Seitenweise über den Parameter vor.
Parameter
limitquery · optional
Anzahl der Einträge.
vorquery · optional
Nur Vorgänge, die vor diesem Zeitpunkt angelegt wurden. Für die nächste Seite.
Antworten
post/api/v1/gegenpruefungenGegenprüfung einreichen
Legt einen Vorgang an, nimmt die Unterlagen entgegen und startet die Auswertung.
Die Antwort erfolgt, sobald die Auswertung durchgelaufen ist – bei üblichen
Dokumentgrößen nach etwa einer Sekunde. Verlassen Sie sich nicht darauf: Werten Sie
weiter_abfragen aus. Ist der Wert true, fragen Sie den Status erneut ab oder
warten Sie auf den Webhook.
Parameter
Idempotency-Keyheader · optional
Frei gewählter Wert je Anfrage, etwa Ihre Auftragsnummer. Wird dieselbe Anfrage nach einem Verbindungsabbruch wiederholt, erhalten Sie dieselbe Antwort statt eines zweiten Vorgangs.
Antworten
get/api/v1/gegenpruefungen/{id}Stand abfragen
Statt der Kennung können Sie Ihre eigene Referenz verwenden: ref:IHRE-NUMMER. Werten Sie weiter_abfragen und bericht_verfuegbar aus; die Statuswerte selbst müssen Sie dafür nicht kennen.
Parameter
idpath · erforderlich
Kennung des Vorgangs oder `ref:` gefolgt von Ihrer eigenen Referenz.
Antworten
get/api/v1/gegenpruefungen/{id}/berichtGegenprüfbericht abrufen (JSON)
Die technische Gegenüberstellung. Jede Position enthält Seitenzahl und wörtliches Zitat aus Kalkulation und Prüfbericht.
Parameter
idpath · erforderlich
Kennung des Vorgangs oder `ref:` gefolgt von Ihrer eigenen Referenz.
Antworten
get/api/v1/gegenpruefungen/{id}/bericht.pdfGegenprüfbericht abrufen (PDF)
Derselbe Bericht als Dokument zum Ablegen oder Weiterreichen.
Parameter
idpath · erforderlich
Kennung des Vorgangs oder `ref:` gefolgt von Ihrer eigenen Referenz.
Antworten
Unterlagen
Dokumente nachreichen und einsehen
get/api/v1/gegenpruefungen/{id}/dokumenteUnterlagen einsehen
Parameter
idpath · erforderlich
Kennung des Vorgangs oder `ref:` gefolgt von Ihrer eigenen Referenz.
Antworten
post/api/v1/gegenpruefungen/{id}/dokumenteUnterlagen nachreichen
Nach der Annahme wird die Auswertung erneut angestoßen, sofern nun alle erforderlichen Unterlagen vorliegen.
Parameter
idpath · erforderlich
Kennung des Vorgangs oder `ref:` gefolgt von Ihrer eigenen Referenz.
Idempotency-Keyheader · optional
Frei gewählter Wert je Anfrage, etwa Ihre Auftragsnummer. Wird dieselbe Anfrage nach einem Verbindungsabbruch wiederholt, erhalten Sie dieselbe Antwort statt eines zweiten Vorgangs.
Antworten
Webhooks
Ereignisbenachrichtigungen statt wiederholter Abfragen
get/api/v1/webhooksAdressen und letzte Zustellungen
Antworten
post/api/v1/webhooksBenachrichtigungsadresse hinterlegen
Antworten
delete/api/v1/webhooksAdresse abschalten
Parameter
idquery · erforderlich
Keine weitere Beschreibung.
Antworten
System
Selbstauskunft der Schnittstelle
get/api/v1/statusSelbstauskunft
Berechtigungen des Schlüssels, Grenzen, erwartete Feldnamen und alle Statuswerte. Nützlich für einen Verbindungstest nach der Einrichtung.