Kundenportal-API für eigene Systeme deiner Kunden
Deine Kunden binden ihr Kundenportal per API an eigene Systeme an, etwa eine Hausverwaltungssoftware, mit eigenen Schlüsseln und Webhooks.
Große Kunden wie Hausverwaltungen arbeiten meist mit eigener Software. Mit der Kundenportal-API holen sie sich alles, was ihr Kundenportal zeigt, direkt in ihr System: Aufträge mit Status, unterschriebene Berichte, freigegebene Dokumente und Angebote. Sie können darüber auch Termine buchen, Angebote annehmen oder ablehnen und Schäden melden.
API für einen Kunden erlauben
Die API ist je Kunde aus, bis du sie bewusst erlaubst:
- Öffne Stammdaten → Kunden und klicke beim Kunden in der Spalte Portal auf Zugang verwalten.
- Klicke unter Kundenportal-API auf API erlauben.
Voraussetzung ist ein eingeschaltetes Kundenportal für diesen Kunden. Den Schlüssel legt der Kunde danach selbst an, du siehst ihn nie im Klartext.
API sperren widerruft sofort alle Schlüssel des Kunden und pausiert seine Webhooks. Auch das Ausschalten des Kundenportals sperrt die API. Unter Integrationen → Schnittstelle und Webhooks siehst du alle Schlüssel deiner Kunden und kannst einzelne widerrufen.
Was der Kunde tut
Im Portal findet der Kunde den Menüpunkt API-Zugang. Dort legt er bis zu fünf Schlüssel an und wählt, was sein System darf:
| Recht | Erlaubt |
|---|---|
portal:lesen |
Aufträge, Berichte (PDF), freigegebene Dokumente, Angebote, Terminwünsche und Schadensmeldungen lesen |
portal:angebote |
Angebote annehmen oder ablehnen (einfache elektronische Signatur mit Protokoll) |
portal:termine |
freie Zeitfenster buchen und Terminwünsche zurückziehen |
portal:meldungen |
Schäden melden, auch mit Fotos |
portal:webhooks |
eigene Webhook-Adressen anlegen und löschen |
Alle Adressen beginnen mit /api/v1/portal, gesendet wird der Schlüssel als Authorization: Bearer adk_…. Die vollständige Beschreibung steht in der Swagger-Oberfläche unter /api-docs/ui.
Webhooks für Kunden
Das System des Kunden kann sich über Änderungen an seinen Daten benachrichtigen lassen: auftrag.angelegt, auftrag.geaendert, auftrag.status_geaendert, auftrag.abgeschlossen, angebot.geaendert, terminanfrage.geaendert, schadensmeldung.geaendert, dokument.freigegeben und bericht.unterschrieben. Die Nachrichten sind signiert wie deine eigenen Webhooks.
Die API zeigt nur, was der Kunde auch im Portal sieht. Interne Notizen, Stunden und Material bleiben bei dir. Rechnungen erscheinen nur, wenn du sie als Dokument im Portal freigibst. Je Schlüssel sind bis zu 600 Anfragen pro Minute möglich.