REST API-endpoints
Caution
Demopagina - Dit is een demopagina die de documentatiefunctie met meerdere tabbladen laat zien. Deze inhoud dient alleen ter illustratie.
Onze REST API biedt endpoints om gegevens op te vragen en te bewerken. Alle endpoints geven gegevens terug in JSON-formaat.
Basis-URL
Stuur alle API-verzoeken naar de volgende basis-URL:
https://api.example.com/v1Endpoints voor gebruikers
Alle gebruikers ophalen
GET /usersGeeft een lijst met alle gebruikers terug. Ondersteunt paginatieparameters.
Queryparameters:
| Parameter | Type | Beschrijving |
|---|---|---|
| page | integer | Paginanummer (standaard: 1) |
| limit | integer | Aantal records per pagina (standaard: 50, max: 100) |
| sort | string | Veld om op te sorteren (bijvoorbeeld “name”, “created_at”) |
Reactie:
{ "data": [ { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z" }, // More users... ], "meta": { "total": 250, "page": 1, "limit": 50 }}Gebruiker ophalen op ID
GET /users/{id}Geeft één gebruiker terug op basis van de ID.
Reactie:
{ "data": { "id": "user_123", "name": "John Doe", "created_at": "2023-01-15T08:30:00Z", "profile": { "bio": "Software developer", "location": "New York", "avatar_url": "https://example.com/avatars/john.jpg" } }}Endpoints voor producten
Alle producten ophalen
GET /productsGeeft een lijst met alle producten terug. Ondersteunt filteren en paginatie.
Queryparameters:
| Parameter | Type | Beschrijving |
|---|---|---|
| category | string | Filter op categorie |
| min_price | number | Filter op minimumprijs |
| max_price | number | Filter op maximumprijs |
| page | integer | Paginanummer (standaard: 1) |
| limit | integer | Aantal records per pagina (standaard: 50, max: 100) |
Reactie:
{ "data": [ { "id": "prod_123", "name": "Example Product", "description": "This is an example product", "price": 49.99, "category": "electronics" }, // More products... ], "meta": { "total": 350, "page": 1, "limit": 50 }}Foutafhandeling
Alle endpoints volgen de standaard HTTP-statuscodes en geven waar nodig gedetailleerde foutmeldingen terug:
| Statuscode | Beschrijving |
|---|---|
| 200 | OK - Het verzoek is geslaagd |
| 400 | Bad Request - Ongeldige parameters |
| 401 | Unauthorized - Authenticatie vereist |
| 403 | Forbidden - Onvoldoende rechten |
| 404 | Not Found - De resource bestaat niet |
| 429 | Too Many Requests - Snelheidslimiet overschreden |
| 500 | Internal Server Error - Er is een serverfout opgetreden |
Foutreacties bevatten een bericht dat uitlegt wat er misging:
{ "error": { "code": "invalid_parameter", "message": "The parameter 'email' is not a valid email address", "request_id": "req_abc123" }}