APIantwoorden

APIantwoorden is de reactie die een API teruggeeft op een verzoek van een client. Een APIantwoord bevat doorgaans een HTTP-statuscode, headers en een optionele payload met data of foutinformatie. Het body-gegevenstype is meestal JSON, maar XML of een ander formaat is mogelijk afhankelijk van de afspraken in de API en de accept-header.

HTTP-statuscodes geven aan of het verzoek geslaagd is en waarom. Voorbeelden: 200 OK voor succesvolle antwoorden, 201 Created bij creatie, 204 No Content bij een succesvolle bewerking zonder payload, 400 Bad Request bij ongeldige input, 401 Unauthorized, 403 Forbidden, 404 Not Found en 5xx bij serverfouten. Veel API’s gebruiken een gestandaardiseerd foutobject in de body, bijvoorbeeld volgens RFC 7807, met velden zoals type, title, status, detail en instance.

Payloads bevatten meestal de gevraagde gegevens of, bij fouten, foutinformatie. Bij grote datasets wordt vaak paginering of cursor-gebaseerde navigatie gebruikt en metadata meegegeven, bijvoorbeeld total, per_page, page en links.

Content-negotiation vindt plaats via Accept- en Content-Type-header; dit bepaalt het formaat van het antwoord. Beveiliging en privacy worden in APIantwoorden gewaarborgd door het vermijden van ongewenste data en door authenticatie, rate limiting, en het beperken van gevoelige informatie in de payload.

Voorbeelden: een GET-verzoek aan /api/gebruikers/123 kan 200 OK opleveren met body {"id":123,"naam":"Emma"}; een verzoek naar een onbekende bron kan 404 Not Found opleveren met een foutobject volgens een gestandaardiseerd schema.