F-Register
API documentatie
Overzicht van de F-Register API, webhooks en integraties voor externe CRM-, offerte- en facturatiesystemen.
API / integraties
Veilige koppelingen met externe systemen.
De F-Register API is bedoeld voor koppelingen met systemen zoals Teamleader, boekhoudsoftware, offertesystemen en toekomstige partnerintegraties. Externe pakketten kunnen gegevens aanleveren of ophalen, terwijl F-Register leidend blijft voor installaties, werkbonnen, rapporten, auditdata en documenten.
Basisprincipes
Integraties worden per klant en module geactiveerd via de monitor. Niet-actieve modules leveren geen API-functionaliteit.
Werkbonnen, koudemiddelmutaties, rapporten en documenten blijven gekoppeld aan de juiste klant, locatie en installatie.
Alleen noodzakelijke gegevens worden uitgewisseld. Publieke logboekpagina’s bevatten geen klant- of monteursgegevens.
Belangrijkste API-events
| Event | Doel | Voorbeeldgegevens |
|---|---|---|
| customer.created | Klant aanmaken vanuit extern CRM. | Naam, e-mail, telefoon, factuuradres, contactpersoon. |
| location.created | Installatieadres toevoegen onder klant. | Locatienaam, adres, postcode, woonplaats, contactgegevens. |
| installation.created | Koelinstallatie, warmtepomp of verbrandingstoestel registreren. | Merk, type, serienummer, installatieadres, module/vakgebied. |
| work_order.completed | Uitgevoerde werkbon beschikbaar maken voor facturatie. | Werkbonnummer, datum, status, materialen, uren, rapportlink. |
| document.created | Rapport of document koppelen aan extern dossier. | Documenttype, installatie, werkbon, bestandslink, aanmaakdatum. |
Gegevensvorm
De API werkt met JSON-objecten. Elke payload bevat minimaal een externe referentie, tenant, eventnaam, tijdstip en de relevante gegevensgroep. Waar mogelijk worden externe ID’s bewaard, zodat updates later op dezelfde klant, locatie, installatie of werkbon terechtkomen.
Teamleader-flow
- Een deal wordt gewonnen in Teamleader.
- Teamleader stuurt via webhook de klant- en projectgegevens naar F-Register.
- F-Register maakt klant, installatieadres en conceptinstallatie of werkbon aan.
- Na uitvoering stuurt F-Register werkboninformatie terug voor facturatie.
Veiligheid
API-toegang hoort per tenant en per module afgeschermd te zijn met tokens, scopes, logging en rate limiting. Bij foutmeldingen moet de integratie veilig falen: geen halve gegevens importeren zonder log, en geen klantdata tonen buiten de juiste omgeving.