Een API-koppeling laten maken: wat moet er aan beide kanten vaststaan?

Wil je gegevens uit een externe bron in je eigen software gebruiken? Neem bij de aanvraag ook het ontvangende systeem mee. Bij Monad bekijken we de toegang tot de bron en de mogelijkheden van je bestaande software voordat we een koppeling kiezen.

Een API is een interface waarmee software gegevens kan uitwisselen. Afhankelijk van het ontvangende systeem kunnen we een bestaande API gebruiken, een eigen toegangspunt bouwen of bestanden in een afgesproken formaat leveren. Welke route past, moet eerst worden beoordeeld.

Beschrijf welke informatie moet aankomen

Begin met een voorbeeld van de gegevens die je nodig hebt. Zet erbij waarvoor je ze gebruikt en waar ze beschikbaar moeten zijn. Een bronadres of voorbeeldbestand helpt om die vraag concreet te maken.

• Welke velden heb je nodig in het ontvangende systeem?
• Hoe vaak moeten de gegevens worden bijgewerkt?
• Welke bestaande gegevens moeten worden aangevuld of gelijkgetrokken?
• Hoe moeten dubbele records worden behandeld?

Deze keuzes horen bij de afbakening van de data. Laat bij het voorbeeld ook zien wat voor jou een bruikbaar resultaat is, zodat de uitvoer kan worden beoordeeld voordat de volledige verwerking wordt aangesloten.

Laat de mogelijkheden van je bestaande software bekijken

De gewenste uitvoer bepaalt mede de aanpak. Neem daarom informatie mee over het systeem dat de gegevens moet ontvangen. Onze data-aanpak houdt rekening met de bestemming en het gebruik van de informatie, naast het verzamelen zelf.

Spreek de gegevensstructuur af aan de hand van een representatieve dataset. Daarmee beoordeel je het werkende voorbeeld op dezelfde velden die je straks in je systeem nodig hebt. Een bestand leveren en een bestaande API aansluiten zijn verschillende mogelijkheden; de keuze hangt af van het ontvangende systeem.

Neem ontbrekende gegevens en onderhoud mee

Bespreek wat er moet gebeuren als informatie ontbreekt of anders binnenkomt dan verwacht. Onze dienstenpagina beschrijft controles op zulke afwijkingen. Leg ook vast wie een storing oppakt en wie het verzamelen van de gegevens onderhoudt.

Bij de aansluiting maken we afspraken over monitoring, het volgen van de werking van het proces. Wijzigingen bij bronnen en onderhoud horen ook bij die afspraken. Zet de gewenste verversingsfrequentie daarom al in je aanvraag.

Bereid de intake voor

Neem een bronadres of voorbeeldbestand mee en beschrijf het ontvangende systeem. Vermeld welke gegevens je mist en hoe je het resultaat wilt gebruiken. Bij Monad begint een project met een gratis intakegesprek. Daarna volgt een vaste offerte voor een eerste werkende versie.

Lees meer over dataverzameling en API-koppelingen of beschrijf de koppeling die je wilt laten bouwen. Vermeld je bedrijf en welke informatie je op welke plek nodig hebt.