API is de afkorting voor Application Programming Interface en meer info is terug te vinden op [1]
Voorbeeld
Situatieschets
Een concreet voorbeeld van het gebruik van een API wordt hieronder geschetst voor een toepassing in de waterwereld.
Een organisatie heeft temperatuur en pH sensoren geplaatst op verschillende plaatsen in een rivier. Via enkele technische stappen belanden deze data in een database. Stel dat de data als volgt wordt opgeslagen in de database:
Bevraging database
De organisatie zou graag deze data bevraagbaar maken via een website. Deze database zou via een SQL query bevraagd kunnen worden als volgt:
select value, timestamp from measurements m join sensor s on s.id = m.sensor_id join location l on l.id = s.location_id where l.name = "stiemerbeek_loc_01";
Indien iemand dezelfde query zou willen doen op de database, kan dit ook zonder dat de query geschreven moet worden in SQL: en dit via een API.
De API in gebruik
De api zou bijvoorbeeld toelaten dat iemand naar volgende web url surft:
www.fictiefvoorbeeld.be/query?location=stiemerbeek_loc_01?data=all
en op deze url zou er dan dezelfde data verschijnen als men de SQL query rechtstreeks uitvoerde op de database. Enkel moet de gebruiker nu de "regels" van de api kennen, meer bepaald dat:
- na
query?location=een locatienaam ingevuld kan worden, en - na
?data=men kan specifieren of men alle data wil opvragen of niet.
de code achter de API zelf vertaalt deze url specificaties naar de gewenste query in SQL formaat, bevraagt de database, en stuurt de resultaten terug naar de gebruiker:
