Customer portal API for your customers' own systems
Your customers connect their customer portal to their own systems via API, such as property management software, with their own keys and webhooks.
Large customers such as property managers usually work with their own software. With the customer portal API they pull everything their customer portal shows directly into their system: orders with status, signed reports, shared documents and quotes. They can also book appointments, accept or decline quotes and report damage through it.
Allowing the API for a customer
The API is off for each customer until you deliberately allow it:
- Open Master data → Customers and click Manage access in the customer's Portal column.
- Under Customer portal API, click Allow API.
The customer portal must be switched on for this customer. The customer then creates the key themselves; you never see it in plain text.
Block API immediately revokes all of the customer's keys and pauses their webhooks. Switching off the customer portal also blocks the API. Under Integrations → API and webhooks you see all of your customers' keys and can revoke individual ones.
What the customer does
In the portal, the customer finds the menu item API access. There they create up to five keys and choose what their system may do:
| Right | Allows |
|---|---|
portal:lesen |
read orders, reports (PDF), shared documents, quotes, appointment requests and damage reports |
portal:angebote |
accept or decline quotes (simple electronic signature with audit log) |
portal:termine |
book free time slots and withdraw appointment requests |
portal:meldungen |
report damage, including photos |
portal:webhooks |
create and delete their own webhook addresses |
All addresses start with /api/v1/portal, and the key is sent as Authorization: Bearer adk_…. The full reference is in the Swagger UI at /api-docs/ui.
Webhooks for customers
The customer's system can be notified about changes to their data: auftrag.angelegt, auftrag.geaendert, auftrag.status_geaendert, auftrag.abgeschlossen, angebot.geaendert, terminanfrage.geaendert, schadensmeldung.geaendert, dokument.freigegeben and bericht.unterschrieben. The messages are signed like your own webhooks.
The API only shows what the customer also sees in the portal. Internal notes, hours and materials stay with you. Invoices only appear if you share them as a document in the portal. Each key allows up to 600 requests per minute.