Wat is een API Request?

Hoe API-verzoeken werken

Bij het maken van een API-verzoek stuurt de clientapplicatie een verzoek naar een specifiek API-eindpunt, dat wordt geïdentificeerd door een unieke URL. Het verzoek bevat een HTTP-methode (zoals GET, POST, PUT of DELETE) die de uit te voeren actie op de resource aangeeft.

Bij ontvangst van het verzoek verwerkt de API-server dit, voert de acties uit of haalt de gevraagde gegevens op, en stuurt een reactie terug naar de clientapplicatie. De reactie bevat meestal een statuscode die het succes of falen van het verzoek aangeeft, samen met de gevraagde gegevens of relevante berichten.

Onderdelen van een API-aanroep

Voor een succesvolle API-aanroep zijn verschillende onderdelen nodig:

1. URI of URL: Het unieke adres van de externe server of het programma waarvan de gegevens of dienst wordt aangevraagd.
2. HTTP-werkwoord: De HTTP-methode (GET, POST, PUT, DELETE) die aangeeft welke actie op de resource moet worden uitgevoerd, zoals gegevens ophalen, een nieuwe resource aanmaken, een bestaande bijwerken of een resource verwijderen.
3. Header: Aanvullende informatie die de API vertelt over het verzoek en het verwachte reactieformaat, zoals het inhoudstype (bijvoorbeeld JSON of XML) en eventuele authenticatietokens.
4. API-sleutel of toegangstoken: Een unieke identifier die wordt gebruikt voor authenticatie en tracking, zodat alleen geautoriseerde clients toegang hebben tot de API en om het gebruik te monitoren voor facturering of snelheidsbeperkingen.
5. Parameters en verzoekbody: Gegevens die samen met het verzoek worden verzonden om informatie aan de API te verstrekken, zoals queryparameters in de URL of gegevens in de verzoekbody voor POST- en PUT-verzoeken.

Door deze onderdelen in een API-verzoek op te nemen, kan een clientapplicatie communiceren met een API-eindpunt, de gewenste gegevens ophalen of de gevraagde acties uitvoeren, en een reactie ontvangen die kan worden gebruikt om de status van de applicatie bij te werken of informatie aan de gebruiker te tonen.

REST API's

REST (Representational State Transfer) is een architectuurstijl voor het ontwerpen van netwerkgebaseerde applicaties. REST API's gebruiken standaard HTTP-methoden (GET, POST, PUT, DELETE) om bewerkingen op resources uit te voeren. Deze resources worden meestal weergegeven in JSON- of XML-formaat en zijn toegankelijk via unieke URL's.

REST API's zijn simpel, schaalbaar en flexibel. Ze zijn staatloos, wat betekent dat elk verzoek alle benodigde informatie bevat zodat de server het kan verwerken, zonder te vertrouwen op eerdere verzoeken. Dit maakt REST API's gemakkelijk te cachen en helpt de prestaties te verbeteren.

SOAP API's

SOAP (Simple Object Access Protocol) is een protocol voor het uitwisselen van gestructureerde informatie in webservices. In tegenstelling tot REST gebruiken SOAP API's XML voor berichten en volgen ze een striktere set regels. SOAP-berichten worden verzonden via verschillende protocollen, zoals HTTP, SMTP of TCP, en bestaan meestal uit een envelop, header en body.

SOAP API's kunnen complexer zijn dan REST API's vanwege hun uitgebreide configuratiemogelijkheden en het gebruik van XML. Ze bieden echter ingebouwde foutafhandeling, ondersteuning voor meerdere transportprotocollen en sterke typing, wat nuttig kan zijn in bepaalde scenario's.

GraphQL API's

GraphQL is een querytaal voor API's en een runtime voor het uitvoeren van die queries met bestaande gegevens. Ontwikkeld door Facebook, stelt GraphQL clients in staat om specifieke gegevensvelden op te vragen, waardoor het aantal benodigde verzoeken wordt verminderd en de hoeveelheid overgedragen gegevens wordt geminimaliseerd.

Met GraphQL sturen clients queries naar één enkel eindpunt, waarbij ze de gewenste gegevensvelden specificeren. De server reageert vervolgens met precies de gevraagde gegevens in een gestructureerd formaat. Deze aanpak elimineert de behoefte aan meerdere eindpunten en overfetching of underfetching van gegevens, veelvoorkomende problemen bij REST API's.

Webhooks

Webhooks zijn een type API dat realtime meldingen stuurt naar een gespecificeerde URL wanneer bepaalde gebeurtenissen plaatsvinden. In plaats van constant een API te bevragen op wijzigingen, stellen webhooks applicaties in staat om directe updates te ontvangen wanneer een relevante gebeurtenis plaatsvindt.

Voorbeelden van het gebruik van webhooks zijn:

• Betalingsmeldingen: Een betalingsgateway kan een webhook-melding sturen naar een e-commerce applicatie wanneer een betaling succesvol is verwerkt of mislukt.
• Systeemmeldingen: Een monitoringdienst kan webhooks gebruiken om een DevOps-team te waarschuwen wanneer een server uitvalt of een fout optreedt.
• Gegevenssynchronisatie: Een CRM-systeem kan webhooks gebruiken om een marketingautomatiseringsplatform bij te werken wanneer klantinformatie verandert.

Webhooks zijn bijzonder handig voor applicaties die realtime updates en efficiënte communicatie tussen verschillende systemen vereisen.

HTTP-methoden

HTTP-methoden, ook bekend als HTTP-werkwoorden, geven de uit te voeren actie op de gespecificeerde resource aan. De meest voorkomende HTTP-methoden die worden gebruikt in API-verzoeken zijn:

• GET: Haalt een resource op van de server. GET-verzoeken moeten alleen worden gebruikt om gegevens te lezen en niet om deze te wijzigen.
• POST: Maakt een nieuwe resource aan op de server. De gegevens voor de nieuwe resource worden verzonden in de verzoekbody.
• PUT: Werkt een bestaande resource bij op de server. De bijgewerkte gegevens worden verzonden in de verzoekbody.
• DELETE: Verwijdert een resource van de server.

Headers

Headers bieden extra informatie over het verzoek en de verwachte reactie. Enkele veelvoorkomende headers zijn:

• User-Agent: Identificeert de clientapplicatie die het verzoek doet, zoals de naam en versie van de software.
• Content-Type: Specificeert het formaat van de gegevens die in de verzoekbody worden verzonden, zoals JSON of XML.
• Accept: Specificeert het gewenste formaat van de reactiegegevens, waardoor de client zijn voorkeur kan aangeven.

Verzoekbody

De verzoekbody bevat de gegevens die van de client naar de server worden verzonden. Het wordt voornamelijk gebruikt bij POST- en PUT-verzoeken om de gegevens te verzenden die nodig zijn voor het aanmaken of bijwerken van een resource. Het formaat van de verzoekbody is meestal JSON of XML, en de Content-Type header moet hierop worden afgestemd.

API-sleutels en toegangstokens

API-sleutels en toegangstokens worden gebruikt voor authenticatie en autorisatie. Het zijn unieke identifiers die clients toegang verlenen tot de API op basis van hun toegewezen rechten. API-sleutels en toegangstokens helpen ervoor te zorgen dat alleen geautoriseerde clients toegang hebben tot de API en de resources ervan.

Naast authenticatie kunnen API-sleutels en toegangstokens ook worden gebruikt om API-gebruik te volgen voor facturering en monitoring. Dit stelt API-providers in staat om snelheidsbeperkingen af te dwingen, gebruikspatronen te monitoren en clients te factureren op basis van hun gebruik van API-resources.

Door deze onderdelen in een API-verzoek op te nemen, kunnen clients goed communiceren met de API, de gewenste actie specificeren, benodigde gegevens verstrekken en veilige en geautoriseerde toegang tot de resources van de API waarborgen.

Het API-eindpunt vinden

De eerste stap bij het maken van een API-aanroep is het vinden van de URI of URL van de server of het programma waarvan je gegevens wilt ophalen. Deze informatie is meestal beschikbaar in de API-documentatie die door de API-provider wordt aangeboden. De documentatie bevat ook een lijst van beschikbare eindpunten en wat elk eindpunt doet.

Als je bijvoorbeeld de GitHub API wilt gebruiken om informatie over een gebruiker op te halen, zou je in de documentatie kijken en het eindpunt voor gebruikersinformatie vinden: https://api.github.com/users/{username}.

Het verzoek formuleren

Zodra je het eindpunt hebt, moet je het API-verzoek samenstellen. Dit omvat verschillende onderdelen:

1. HTTP-methode: Specificeer de actie die je op de resource wilt uitvoeren met behulp van een HTTP-methode zoals GET, POST, PUT of DELETE. Om bijvoorbeeld gebruikersinformatie op te halen van de GitHub API, zou je de GET-methode gebruiken.

2. Headers: Voeg headers toe om de API meer context te geven over je verzoek en het reactieformaat dat je verwacht. Veelvoorkomende headers zijn:

   • Content-Type: Specificeert het formaat van de verzoekgegevens, zoals JSON of XML.
   • Accept: Specificeert het gewenste formaat voor de reactiegegevens.
   • Authorization: Bevat authenticatietokens zoals API-sleutels of toegangstokens.

3. API-sleutel of toegangstoken: Veel API's vereisen authenticatie om ervoor te zorgen dat alleen geautoriseerde clients toegang hebben tot de gegevens. Voeg je API-sleutel of toegangstoken toe aan het verzoek, ofwel in de headers of als een queryparameter.

4. Parameters: Sommige API-eindpunten stellen je in staat om parameters te verstrekken om specifieke gegevens op te halen of bepaalde acties uit te voeren. Deze kunnen in de URL worden opgenomen als queryparameters of in de verzoekbody voor POST- en PUT-verzoeken.

Hier is een voorbeeld van een compleet API-verzoek om informatie over een GitHub-gebruiker op te halen:

GET /users/octocat HTTP/1.1
Host: api.github.com
Authorization: token my_access_token
Accept: application/vnd.github.v3+json

Het API-verzoek verzenden

Om het API-verzoek te verzenden, kun je een HTTP-clientbibliotheek gebruiken in de programmeertaal van je keuze of een tool die speciaal is ontworpen voor het maken van API-verzoeken.

Populaire HTTP-clientbibliotheken zijn:

• Axios voor JavaScript
• Requests voor Python
• OkHttp voor Java

Deze bibliotheken vereenvoudigen het proces van het maken en verzenden van API-verzoeken en het verwerken van de reacties.

Je kunt ook tools zoals Postman of cURL gebruiken om API-verzoeken te maken. Deze zijn vooral handig voor test- en ontwikkelingsdoeleinden, omdat ze je in staat stellen om eenvoudig API-verzoeken en reacties te maken, te verzenden en te analyseren.

De API-reactie verwerken

Na het verzenden van het API-verzoek ontvang je een reactie van de API-server. De reactie bevat een statuscode die aangeeft of het verzoek succesvol was of niet, en de gevraagde gegevens (indien van toepassing) in het gespecificeerde formaat (meestal JSON of XML).

Veelvoorkomende statuscodes zijn:

• 2XX-codes (zoals 200 OK) voor succesvolle verzoeken
• 4XX-codes (zoals 404 Not Found) voor clientfouten
• 5XX-codes (zoals 500 Internal Server Error) voor serverfouten

Hier is een voorbeeldreactie van de GitHub API voor een succesvol verzoek om gebruikersinformatie:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "login": "octocat",
  "id": 1,
  "node_id": "MDQ6VXNlcjE=",
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "gravatar_id": "",
  "url": "https://api.github.com/users/octocat",
  "html_url": "https://github.com/octocat",
  ...
}

In je applicatie moet je de reactie verwerken, de statuscode controleren om te zien of het verzoek succesvol was, en de geretourneerde gegevens parsen om deze in je applicatie te gebruiken.

Door deze stappen en onderdelen van het maken van API-aanroepen te begrijpen, kun je beginnen met het integreren van gegevens en functionaliteit van externe diensten in je eigen applicaties.

Het belang van API-testen

Het testen van API's op functionaliteit, betrouwbaarheid, prestaties en beveiliging is belangrijk om ervoor te zorgen dat de API voldoet aan de behoeften van de applicatie en de gebruikers. Grondig testen helpt bugs, prestatieproblemen en beveiligingslekken vroeg in het ontwikkelingsproces te vinden, waardoor het risico op problemen in productieomgevingen wordt verminderd.

API-testen controleert ook of de API correct reageert op verschillende soorten verzoeken, inclusief geldige en ongeldige invoer, en fouten correct afhandelt. Door verschillende scenario's te testen, kunnen ontwikkelaars ervoor zorgen dat de API robuust is en real-world use cases aankan.

Hoe je API-aanroepen test

Om API-aanroepen te testen, kunnen ontwikkelaars softwaretools of webservices zoals Postman of cURL gebruiken. Deze tools stellen ontwikkelaars in staat om API-aanroepen naar verschillende eindpunten te maken, verzoekparameters aan te passen en de API-reacties te analyseren.

Het algemene proces voor het testen van API-aanroepen omvat de volgende stappen:

1. Voer de URL in van het API-eindpunt dat je wilt testen.
2. Selecteer de juiste HTTP-methode (GET, POST, PUT, DELETE) op basis van de actie die je wilt uitvoeren.
3. Verstrek de benodigde authenticatiegegevens, zoals API-sleutels of toegangstokens, en stel de vereiste headers in.
4. Voeg eventuele vereiste of optionele parameters toe aan het verzoek, ofwel als queryparameters in de URL of als onderdeel van de verzoekbody.
5. Verstuur het API-verzoek en bekijk de reactie die van de API-server wordt ontvangen.
6. Analyseer de geretourneerde statuscode, reactietijd en de inhoud van de reactiebody om te verifiëren dat de API zich gedraagt zoals verwacht.

Door deze stappen te herhalen voor verschillende API-eindpunten, verzoektypes en invoerwaarden, kunnen ontwikkelaars de API grondig testen en de kwaliteit ervan controleren.

Typen API-tests

Er zijn verschillende soorten API-tests die ontwikkelaars kunnen uitvoeren om de betrouwbaarheid, prestaties en beveiliging van de API te controleren:

1. Functioneel testen: Dit type testen controleert of de API werkt zoals verwacht en de juiste gegevens retourneert. Ontwikkelaars testen verschillende API-eindpunten met verschillende invoerwaarden en vergelijken de werkelijke reacties met de verwachte resultaten. Functioneel testen helpt ervoor te zorgen dat de API voldoet aan de gespecificeerde vereisten en zich consistent gedraagt.

2. Prestatietesten: Prestatietesten meet de reactietijd, doorvoer en resourcegebruik van de API onder verschillende omstandigheden, zoals hoog verkeer of grote gegevensvolumes. Dit type testen helpt prestatieproblemen te vinden, de efficiëntie van de API te optimaliseren en ervoor te zorgen dat deze de verwachte belasting aankan.

3. Beveiligingstesten: Beveiligingstesten richt zich op het vinden van kwetsbaarheden en ervoor zorgen dat de API beschermd is tegen veelvoorkomende aanvallen, zoals SQL-injectie, cross-site scripting (XSS) en autorisatie-bypasses. Ontwikkelaars testen de authenticatie- en autorisatiemechanismen van de API, valideren invoergegevens en controleren op correcte foutafhandeling om beveiligingsrisico's te minimaliseren.

4. Betrouwbaarheidstesten: Betrouwbaarheidstesten controleert het vermogen van de API om fouten, randgevallen en onverwachte invoer correct af te handelen. Dit omvat het testen van correcte foutreacties, time-outs en het vermogen van de API om te herstellen van fouten. Betrouwbaarheidstesten helpt ervoor te zorgen dat de API stabiel en voorspelbaar blijft, zelfs in uitzonderlijke situaties.

Door deze verschillende soorten tests uit te voeren, kunnen ontwikkelaars verifiëren dat de API voldoet aan de vereiste kwaliteitsnormen en een betrouwbare, performante en veilige dienst biedt aan de gebruikers.

Een vlucht boeken

Wanneer je een reiswebsite gebruikt om een vlucht te boeken, communiceert de website vaak met de API van de luchtvaartmaatschappij om realtime informatie over beschikbare vluchten te verkrijgen. Zo kan het proces werken:

1. Je voert je gewenste reisdata, vertrekvliegveld en bestemming in op de reiswebsite.
2. De reiswebsite stuurt een GET-verzoek naar het API-eindpunt van de luchtvaartmaatschappij, waarbij je zoekparameters worden meegegeven als onderdeel van de URL of queryparameters.
3. De API-server van de luchtvaartmaatschappij ontvangt het verzoek, doorzoekt de database op vluchten die aan je criteria voldoen, en stuurt een reactie terug met een lijst van beschikbare vluchten, samen met informatie zoals prijzen, vertrek- en aankomsttijden en vluchtnummers.
4. De reiswebsite parseert de API-reactie en toont de beschikbare vluchten aan jou, zodat je je gewenste vlucht kunt selecteren en boeken.

Door API-aanroepen te gebruiken, kan de reiswebsite je actuele vluchtinformatie bieden zonder een eigen database van vluchten bij te hoeven houden.

Posten op sociale media

Social media platforms zoals Facebook, Twitter en Instagram bieden API's waarmee applicaties van derden kunnen communiceren met hun diensten. Wanneer je iets post op een social media platform via een app, gebruikt de app de API van het platform om je post naar de servers van het platform te sturen. Zo werkt het:

1. Je stelt een nieuwe post samen in de app, die tekst, afbeeldingen of video's kan bevatten.
2. Wanneer je de post verstuurt, stuurt de app een POST-verzoek naar het API-eindpunt van het social media platform. Het verzoek bevat de inhoud van je post en eventuele benodigde authenticatietokens.
3. De API-server ontvangt het verzoek, verifieert je authenticatie en verwerkt de postgegevens.
4. Als de post geldig is, slaat de API-server de nieuwe post op in de database en stuurt een reactie terug naar de app die aangeeft dat de post succesvol is aangemaakt.
5. De app ontvangt de reactie en toont een bevestigingsbericht aan jou.

Door de API van het social media platform te gebruiken, kan de app je in staat stellen om posts aan te maken zonder een eigen backend-infrastructuur te hoeven bouwen voor het opslaan en verwerken van postgegevens.

Betalingen verwerken

Wanneer je een aankoop doet op een e-commerce website, gebruikt de website vaak de API van een betalingsgateway om je betaling veilig te verwerken. Hier is een voorbeeld van hoe het betalingsproces kan werken:

1. Je selecteert de artikelen die je wilt kopen en gaat naar de afrekenpagina op de e-commerce website.
2. Je voert je betalingsgegevens in, zoals je creditcardnummer en factuuradres.
3. Wanneer je het betalingsformulier verstuurt, stuurt de e-commerce website een POST-verzoek naar het API-eindpunt van de betalingsgateway. Het verzoek bevat je betalingsgegevens en het totale te betalen bedrag.
4. De API-server van de betalingsgateway ontvangt het verzoek en communiceert veilig met de betalingsprovider (zoals de creditcardmaatschappij) om de transactie te verwerken.
5. Als de betaling wordt goedgekeurd, stuurt de betalingsgateway een reactie terug naar de e-commerce website die aangeeft dat de betaling succesvol was. Als de betaling wordt geweigerd, stuurt de API een foutreactie terug.
6. De e-commerce website ontvangt de API-reactie en toont een bevestigingsbericht aan jou, waarin je wordt geïnformeerd of de betaling succesvol is verwerkt.

Door de API van een betalingsgateway te gebruiken, kan de e-commerce website betalingen veilig verwerken zonder gevoelige betalingsinformatie rechtstreeks te hoeven beheren.

Dit zijn slechts enkele voorbeelden van hoe API-aanroepen worden gebruikt in real-world applicaties. API's stellen verschillende softwaresystemen in staat om naadloos te communiceren en gegevens uit te wisselen, waardoor het mogelijk wordt om complexe applicaties te bouwen die gebruikmaken van de functionaliteit van meerdere diensten.