Een JSON API is een manier voor softwaresystemen om data uit te wisselen met JSON, een simpel tekstformaat dat een beetje op een gelabeld lijstje lijkt. Het ene systeem vraagt informatie op via het web en het andere antwoordt met netjes gestructureerde JSON, die de ontvangende app direct kan lezen.
Stel je twee mensen voor met een verschillende moedertaal die afspreken elkaar in eenvoudig Engels te schrijven. Het bericht blijft simpel, beide kanten begrijpen het en er is geen speciale apparatuur nodig. JSON speelt die rol tussen programma’s. Het is het formaat achter de meeste REST API’s en bouwt rechtstreeks op het JSON-formaat.
In de praktijk is dit wat je website live data van elders laat tonen: prijzen uit een ERP-systeem, beschikbaarheid uit een magazijn of content uit een aparte teksttool. De data komt binnen als JSON en je site toont het aan de bezoeker. Een headless CMS werkt precies zo: het levert je artikelen en pagina’s als JSON, die een site of app vervolgens toont zoals die wil.
Een paar praktische punten houden zo’n koppeling gezond. Een JSON API geeft meestal bij elk antwoord een status mee, zodat je site weet of een verzoek lukte of mislukte, en vaak is er een limiet op hoe vaak je hem per minuut mag aanroepen. Goede API’s hebben ook versies, zodat een wijziging aan hun kant de jouwe niet stilletjes ‘s nachts breekt. De meeste vragen ook om een sleutel of token, die als wachtwoord werkt zodat alleen jouw site de data leest en je kunt worden afgesloten als er iets misgaat.
Bij TopDevs bouwen we JSON API’s als het schone koppelpunt tussen de website van een klant en de systemen erachter, zodat data automatisch stroomt in plaats van met de hand wordt overgetypt.