Anwendungsbeispiele
Typische Anbindungen Schritt für Schritt – ERP-Abrechnung, Berichtsablage im DMS, Störungsmeldung aus einer Leitstelle, Stammdatenabgleich und Wartungsplanung im ERP.
Stand:
Die Beispiele zeigen, welche Endpunkte, Berechtigungen und Ereignisse für typische Anbindungen zusammenspielen. Für jede Anbindung einen eigenen API-Zugang und einen eigenen Webhook anlegen, dann lässt sich jede einzeln abschalten und im Protokoll zuordnen.
Abgeschlossene Aufträge ans ERP übergeben#
Ziel: Das ERP erstellt die Rechnung, sobald ein Auftrag abgeschlossen ist.
| Was | Einstellung |
|---|---|
| Berechtigungen | read:orders, read:master-data, read:reports |
| Ereignisse | order.completed, bei Abrechnung in Revisio invoice.created |
- Webhook
order.completedempfangen, Signatur prüfen,data.order.idin die eigene Warteschlange legen und mit204antworten. GET /orders/{id}laden: Auftragstyp, Anlagen, Techniker,overall_result, Berichte.- Den Kunden über
customer_idmitGET /customers/{id}laden und übernumberoderlegacy_numberdem Debitor im ERP zuordnen. - Optional das PDF des Berichts an den Rechnungsvorgang hängen (PDF herunterladen).
- Die Ereignis-
idals verarbeitet speichern, damit eine Wiederholung keine zweite Rechnung erzeugt.
Hinweis
Wer in Revisio selbst abrechnet (Rechnungen), nutzt stattdessen den Buchhaltungsexport. Den Status „abgerechnet“ setzt die API nicht.
Prüfberichte im Dokumentenmanagement ablegen#
Ziel: Jeder versendete Bericht landet in der Akte des Kunden im DMS.
| Was | Einstellung |
|---|---|
| Berechtigungen | read:reports, read:master-data |
| Ereignisse | report.sent (oder report.created, wenn schon vor dem Versand abgelegt werden soll) |
- Webhook empfangen,
data.report.idmerken. GET /reports/{id}laden; das Feldpdf.download_urlgilt 10 Minuten.- PDF laden, SHA-256 mit
pdf.sha256vergleichen und unterfull_numberablegen, z. B.B-2026-00211-v2.pdf. Als Akte dienencustomer_idundsite_id. - Ist
supersedes_report_idgesetzt, die ältere Fassung im DMS als ersetzt markieren.
Für die erstmalige Übernahme aller vorhandenen Berichte GET /reports?status=sent vollständig durchblättern.
Störungen aus einer Leitstelle melden#
Ziel: Eine Leitstelle oder Gebäudeleittechnik meldet Störungen direkt in Revisio und zeigt ihren Stand an.
| Was | Einstellung |
|---|---|
| Berechtigungen | read:master-data, write:faults, read:faults |
| Ereignisse | fault.status_changed, fault.sla_breached, order.created, order.rescheduled |
- Einmalig die Anlagen holen (
GET /assets) und SW-Nummer (number) mit der Kennung der Anlage in der Leitstelle verknüpfen. Einzelne Anlagen findetGET /assets?number=SW17 36033. - Bei einer Störung
POST /faultsmitasset_id,title,reported_atund passendercategory_idsenden. Die Antwort enthältidundnumber; beide in der Leitstelle speichern. fault.status_changedempfangen:previous_stateundfault.statezeigen den Fortschritt, z. B.open→planned→in_progress→resolved.- Wird ein Einsatz angelegt, verweist
fault.work_order_idauf ihn.order.createdundorder.rescheduledliefern den geplanten Termin, den die Leitstelle dem Melder mitteilen kann. fault.sla_breachedmeldet, wenn eine Störung ihre Reaktionszeit überschreitet, etwa um in der Leitstelle zu eskalieren.
Stammdaten mit CRM oder ERP abgleichen#
Ziel: Kunden, Objekte und Anlagen aus Revisio stehen auch im CRM oder ERP.
| Was | Einstellung |
|---|---|
| Berechtigungen | read:master-data |
| Ereignisse | customer.created, customer.updated, site.created, site.updated, asset.created, asset.updated, records.trashed, records.restored |
- Erstabgleich:
/customers,/sitesund/assetsvollständig durchblättern und jeidspeichern. - Laufend: bei jedem Ereignis den Datensatz über seine
idneu laden und überschreiben.changedzeigt, ob sich für das CRM relevante Felder geändert haben. - Bei
records.trasheddie genannten Datensätze im CRM als gelöscht markieren, beirecords.restoredwieder aktivieren. - Nächtlich: Abgleich mit
updated_since(Ablauf), damit auch Änderungen ankommen, deren Webhook ausgefallen ist.
Stammdaten lassen sich über die API nicht ändern. Führend für Kunden, Objekte und Anlagen bleibt Revisio; Daten aus dem ERP übernehmen Sie über den Datenimport.
Wartungen im ERP einplanen#
Ziel: Fällige Wartungen erscheinen in der Einsatz- oder Ressourcenplanung des ERP, Terminantworten der Kunden kommen dort an.
| Was | Einstellung |
|---|---|
| Berechtigungen | read:master-data, read:orders |
| Ereignisse | maintenance.due, maintenance.overdue, appointment.responded, order.rescheduled |
maintenance.dueempfangen und die Anlage überasset_idzuordnen. Istwork_order_idleer, gibt es noch keinen Auftrag; die Disposition plant ihn in Revisio aus den Fälligkeiten ein, damit die Durchführung der Fälligkeit zugeordnet wird.maintenance.overdueals Eskalation behandeln, etwa als Aufgabe für die Disposition.appointment.respondedmitresponsechange_requestedzeigt Terminwünsche des Kunden inpreferred_dates. Nach der Umplanung in Revisio folgtorder.rescheduledmit dem neuen Termin.