API koppeling: wat het is en wat bepaalt of het simpel of lastig wordt

Een API is de manier waarop een systeem gegevens beschikbaar maakt voor andere software. Is er een API, dan kunnen twee systemen gegevens uitwisselen zonder dat iemand ze overtikt.

Vrijwel elke koppeling is te bouwen; de vraag is wat het kost. Dat verschilt sterk, meestal om redenen die weinig met programmeren te maken hebben.

Wat een koppeling simpel maakt

• Beide kanten hebben een fatsoenlijke API. Gedocumenteerd, met een testomgeving, en iemand die de telefoon opneemt als er iets onduidelijk is.
• Eén richting. Systeem A stuurt naar systeem B.
• Eén duidelijke eigenaar per gegeven. De klantgegevens leven in het CRM, de facturen in de boekhouding, en er is geen twijfel welk systeem gelijk heeft.
• Bescheiden volume. Een paar honderd records per dag stelt geen eisen aan hoe je het bouwt.

Wat een koppeling lastig maakt

• Twee richtingen. Zodra beide kanten hetzelfde veld mogen wijzigen, moet je vastleggen wie wint bij een conflict — en dat is een businessvraag, geen technische. Zonder die afspraak overschrijven de systemen elkaar in de volgorde waarin de synchronisaties toevallig draaien.
• Geen echte API. Sommige systemen bieden alleen een export, een e-mail of een bestand op een server. Dat is te overbruggen, maar het is meer bouwwerk en het breekt makkelijker.
• Verschillende definities van hetzelfde woord. Wat in systeem A een "klant" is, is in systeem B een "relatie" die ook leveranciers bevat. Het merendeel van het werk in een koppeling is dit soort vertaling, niet de verbinding zelf.
• Volume. Vanaf een bepaald aantal records is alles-in-één-keer doorzetten niet meer haalbaar en moet je alleen wijzigingen verwerken. Dat is een andere bouwwijze, geen instelling die je omzet.
• Uitzonderingen. Eén record dat niet voldoet aan wat de andere kant verwacht. Of dat één record eruit valt of de hele batch, is het verschil tussen een melding en een storing.

Wat er stukgaat nadat het werkt

Een koppeling is na oplevering niet af, want beide kanten blijven veranderen. Dit deel ontbreekt vaak in offertes.

• Een leverancier faseert een oude API-versie uit. Dat wordt maanden vooraf aangekondigd, maar zo'n aankondiging wordt makkelijk gemist — en dan valt de koppeling ogenschijnlijk uit het niets uit.
• Een veld dat altijd gevuld was, is bij één record ineens leeg.
• Iemand voegt een nieuw type toe in het ene systeem dat het andere niet kent.
• De verbinding valt een keer weg en niemand merkt dat de synchronisatie sindsdien niet meer draait.

Daarom hoort er monitoring bij: een controle of er vandaag iets doorgekomen is. Dat is weinig werk, en het maakt het verschil tussen een probleem van een dag en een probleem van een maand.

Wat je vraagt voordat je laat bouwen

Aan de leverancier van elk systeem:

1. Is er een API, en zit die in mijn huidige abonnement of kost hij extra?
2. Wie vraagt hem aan — ik of mijn bouwer? En wie houdt de sleutel?
3. Werkt hij beide kanten op, of alleen lezen?
4. Kan ik opvragen wat er sinds gisteren gewijzigd is, of moet ik elke keer alles ophalen?
5. Zijn er limieten op het aantal verzoeken?
6. Hoe word ik gewaarschuwd als er iets aan de API verandert?

Die zes antwoorden bepalen de prijs grotendeels. Heb je ze bij het eerste gesprek, dan kan een bouwer snel een offerte maken.

Als je hier hulp bij nodig hebt

Koppelingen zijn het meeste van wat ik doe: webshop aan boekhouding, CRM aan website, kantoorsoftware aan portalen, of maatwerk waar er geen kant-en-klare oplossing bestaat.

Concrete voorbeelden staan bij vastgoedkoppelingen — zelfde patroon, andere systemen.