API und Webhooks im Überblick
Was die Schnittstelle kann, wie ein Fremdsystem angebunden wird und wo die technischen Einzelheiten stehen.
Stand:
Revisio hat eine REST-API und Webhooks. Über die API liest ein Fremdsystem Stammdaten, Aufträge, Berichte und Störungen, legt Aufträge und Störungen an und ändert den Auftragsstatus. Webhooks melden dem Fremdsystem sofort, wenn in Revisio etwas passiert, damit es nicht ständig nachfragen muss. Diese Kategorie richtet sich an die Entwickler, die die Anbindung bauen.
Hinweis
API und Webhooks sind im Tarif Premium enthalten und lassen sich im Tarif Basic als Zusatzoption buchen. Tarif und Optionen stellen Sie unter Abo und Nutzung ein.
Was die Schnittstelle kann#
| Bereich | Lesen | Schreiben |
|---|---|---|
| Stammdaten | Kunden, Objekte, Anlagen mit SW-Nummer, Auftragstypen | – |
| Aufträge | Liste, Details mit Anlagen, Technikern und Berichten | anlegen, Status ändern (offen, in Arbeit, pausiert, storniert) |
| Berichte | Berichtsdaten, Prüfcode, PDF über zeitlich begrenzten Link | – |
| Störungen | Liste, Details, Störungskategorien | Störung an einer Anlage melden |
| Webhooks | Benachrichtigung bei 23 Ereignissen | – |
Bewusst nicht über die Schnittstelle möglich sind Prüfprotokoll und Abschluss eines Auftrags, Freigabe und Versand von Berichten, Angebote, Rechnungen und das Ändern von Stammdaten. Diese Schritte bleiben in Revisio, weil sie Unterschrift, Prüfkette oder Abrechnung betreffen.
Anbindung in fünf Schritten#
- Unter Verwaltung → API & Webhooks einen API-Zugang mit den nötigen Berechtigungen anlegen
(Anleitung). Den Token (
rvs_…) sofort sichern. - Die Adresse der API aus dem Abschnitt Schnittstelle derselben Seite übernehmen, z. B.
https://app.revisio-app.net/api/public/v1. - Eine erste Anfrage senden (siehe unten) und die Grundlagen zu Anmeldung, Blättern und Fehlern lesen.
- Falls das Fremdsystem auf Ereignisse reagieren soll: einen Webhook mit HTTPS-Adresse anlegen, das
Signaturgeheimnis (
whsec_…) hinterlegen und die Signatur prüfen. - Mit Test senden die Zustellung prüfen und danach die echten Ereignisse abonnieren.
Erste Anfrage#
curl https://app.revisio-app.net/api/public/v1/order-types \
-H "Authorization: Bearer rvs_IhrToken" \
-H "Accept: application/json"
Antwort:
{
"data": [
{
"id": "01k79z8y7x6w5v4t3s2r1q0p9n",
"name": "Wartung",
"category": "maintenance",
"default_duration_minutes": 120
}
]
}
Kommt 401 unauthenticated zurück, ist der Token falsch, abgelaufen oder widerrufen. Kommt 403 insufficient_scope,
fehlt dem Zugang die Berechtigung Stammdaten lesen.
Technische Beschreibung als OpenAPI#
Die vollständige Beschreibung aller Endpunkte, Felder und Webhooks steht als OpenAPI 3.1 unter
/api/public/v1/openapi.yaml bereit, z. B. https://app.revisio-app.net/api/public/v1/openapi.yaml. Die Datei
lässt sich in Postman, Insomnia, Swagger UI oder einen Code-Generator laden. Sie ist ohne Anmeldung abrufbar und
enthält keine Daten Ihrer Organisation.