Wat is een API-koppeling?

Een API-koppeling zorgt ervoor dat twee verschillende systemen op een gecontroleerde manier gegevens met elkaar kunnen uitwisselen.

Hierdoor hoeft informatie niet steeds handmatig van het ene systeem naar het andere te worden overgenomen.

Wat doet een API?

Je kunt een API zien als een afgesproken verbinding tussen twee systemen.

Het ene systeem vraagt bepaalde informatie op of stuurt informatie door. Het andere systeem verwerkt deze gegevens vervolgens volgens vaste afspraken.

Denk bijvoorbeeld aan het uitwisselen van:

• producten;

• prijzen;

• voorraad;

• bestellingen;

• klantgegevens;

• afspraken;

• andere gegevens.

Wat is een praktisch voorbeeld?

Stel dat je producten beheert in een extern systeem en deze ook op je website wilt tonen.

Met een API-koppeling kan de website bepaalde productinformatie automatisch uit het externe systeem ophalen.

Daardoor hoef je dezelfde gegevens niet op meerdere plekken handmatig bij te houden.

Kan een API alle gegevens uitwisselen?

Nee. De leverancier van het externe systeem bepaalt welke gegevens via de API beschikbaar zijn en welke acties ermee uitgevoerd mogen worden.

Dat een systeem een API heeft, betekent dus niet automatisch dat iedere gewenste koppeling mogelijk is.

We moeten eerst de technische documentatie bekijken.

Werkt een API altijd realtime?

Niet per se.

Sommige koppelingen verwerken wijzigingen direct. Andere koppelingen halen gegevens op vaste momenten op of werken met een verwerkingswachtrij.

Hoe snel informatie wordt bijgewerkt, hangt dus af van de inrichting van de koppeling en de mogelijkheden van beide systemen.

Goed om te weten

Voor een API-koppeling zijn vaak technische toegangsgegevens nodig.

Deel API-sleutels, tokens, wachtwoorden of andere gevoelige gegevens niet zomaar. Wij geven aan welke toegang daadwerkelijk nodig is en hoe deze veilig kan worden geregeld.

Wil je een systeem via een API koppelen?

Stuur ons dan:

• de naam van het externe systeem;

• wat je met de website wilt koppelen;

• welke gegevens moeten worden uitgewisseld;

• hoe vaak de gegevens bijgewerkt moeten worden;

• de technische API-documentatie van de leverancier, indien beschikbaar;

• informatie over een eventuele testomgeving.

Wij kunnen vervolgens beoordelen welke mogelijkheden de API biedt en wat er nodig is om de koppeling te realiseren.