API-tokens en de REST API
Met een API-token geef je externe software (een boekhoudpakket, een website of een eigen rapporteringstool) toegang tot de gegevens van je gebouwen, zonder dat die software je wachtwoord hoeft te kennen. De API van SyndiFlow is alleen-lezen: er kan niets gewijzigd worden, alleen opgevraagd. Dit artikel is bedoeld voor de syndicus die een koppeling laat bouwen; de technische details staan in de volledige API-referentie op /api/docs.
Waar vind je het
Menu Instellingen › API Tokens. Alleen een Super Admin en een Syndicus hebben toegang. Tokens zijn persoonlijk: je ziet alleen de tokens die je zelf aanmaakte, en een token krijgt dezelfde toegang tot gebouwen als jouw account.
Een token aanmaken
- Klik rechtsboven op Nieuw token aanmaken.
- Vul de velden in en bevestig.
- Het token verschijnt eenmalig in een groen kader. Klik op Kopieer en bewaar het op een veilige plaats (bijvoorbeeld in een wachtwoordbeheerder). Klik daarna op Sluiten.
| Veld | Verplicht | Uitleg |
|---|---|---|
| Token naam | ja | Waarvoor het token dient, bijvoorbeeld "Boekhoudkoppeling" of "Website integratie". |
| Vervaldatum | nee | Datum en uur waarop het token stopt met werken, ten vroegste morgen. Leeg laten geeft een token zonder vervaldatum. |
Let op: het token wordt maar één keer getoond. Sluit je het kader zonder te kopiëren, dan moet je het intrekken en een nieuw token aanmaken. In de lijst zie je nadien alleen nog de laatste acht tekens.
Tip: maak per toepassing een apart token met een duidelijke naam en een vervaldatum. Zo kan je één koppeling stopzetten zonder de andere te storen, en vervalt een vergeten token vanzelf.
Overzicht van je tokens
De tabel Uw API tokens toont per token de Naam, wanneer het Aangemaakt werd, wanneer het Laatst gebruikt werd (of Nooit) en wanneer het Vervalt (of Nooit). Een vervallen token krijgt de rode badge Verlopen en wordt grijs weergegeven. De kolom Laatst gebruikt is handig om te zien of een koppeling nog actief is.
Een token intrekken
- Klik in de rij op Intrekken.
- Bevestig de vraag "Weet u zeker dat u dit token wilt intrekken?".
- Je ziet de melding Token ingetrokken. De koppeling die dit token gebruikte, krijgt vanaf nu een foutmelding.
Trek een token onmiddellijk in als het gelekt is, als de leverancier van de koppeling stopt of als een medewerker met toegang het bedrijf verlaat.
Wat de koppeling kan opvragen
De koppeling stuurt het token mee in de header Authorization: Bearer <token> bij elke aanvraag naar /api/v1/…. Alle endpoints zijn GET (lezen). Bedragen zijn altijd gehele centen (amount_cents), datums in ISO-formaat.
| Endpoint | Wat het teruggeeft |
|---|---|
GET /api/v1/buildings |
De gebouwen waartoe het account toegang heeft, met aantal kavels en eigenaars. |
GET /api/v1/buildings/{slug} |
Details van één gebouw. |
GET /api/v1/buildings/{slug}/owners |
Eigenaars met e-mail, IBAN, RVME-vlag, hun kavels en totaal aandeel. |
GET /api/v1/buildings/{slug}/owners/{id} |
Eén eigenaar. |
GET /api/v1/buildings/{slug}/units |
Kavels met type, aandeel en huidige eigenaar. |
GET /api/v1/buildings/{slug}/units/{id} |
Eén kavel. |
GET /api/v1/buildings/{slug}/distributions |
Verdelingen per periode met huur-, onderhouds- en syndicusbedrag en status. |
GET /api/v1/buildings/{slug}/distributions/{id} |
Eén verdeling inclusief de lijnen per eigenaar en kavel. |
GET /api/v1/buildings/{slug}/maintenance-invoices |
Onderhoudsfacturen met leverancier, bedrag, categorie en status. |
GET /api/v1/buildings/{slug}/bank-transactions |
Banktransacties met tegenpartij, bedrag en of ze gekoppeld zijn. |
GET /api/v1/buildings/{slug}/cost-centers |
Kostenplaatsen met verdeelsleutel. |
De {slug} is het stukje van het webadres dat je gebouw identificeert; je vindt het in Gebouw instellingen. Lijsten zijn gepagineerd (page, per_page tot 100) en ondersteunen search, sort (met - voor aflopend) en filter[veld]=waarde, bijvoorbeeld:
GET /api/v1/buildings/residentie-voorbeeld-ab12c/distributions?filter[year]=2026&sort=-period_month
Een aanvraag zonder token geeft foutcode 401, een onbekend gebouw of record 404. Het overzicht GET /api/v1 (zonder token) vat de endpoints en limieten samen.
Limieten en abonnement
| Abonnement | Aanvragen per minuut |
|---|---|
| Basis | 60 |
| Pro | 120 |
| Enterprise | 300 |
Boven de limiet krijgt de koppeling foutcode 429 tot de minuut voorbij is. De headers X-RateLimit-Limit en X-RateLimit-Remaining tonen hoeveel ruimte er nog is.
API-toegang maakt deel uit van het Enterprise-abonnement: de gebouwenlijst toont voor een syndicus alleen gebouwen met een actief Enterprise-abonnement of Enterprise-proefperiode. Zie Abonnement en facturatie.
Let op: een token geeft in deze versie altijd volledige leestoegang; er zijn geen fijnere rechten per gebouw of per onderdeel. Behandel een token dus als een wachtwoord, deel het alleen met een leverancier die je vertrouwt en trek het in zodra de koppeling niet meer nodig is.