# Documentatie en Gebruikersgids voor Postman Collection: Gebruikersbeheer API --- ## Inhoudsopgave 1. Overzicht 2. API Beschrijving 3. Belangrijke Endpoints - POST /users - GET /users/{id} - PUT /users/{id} 4. Testcases en Scenario’s 5. Gebruiksgids 6. Contact en Support --- ## 1. Overzicht Deze Postman Collection biedt tools om gebruikersaccounts en rechten te beheren via de Gebruikersbeheer API. De collectie bevat endpoints voor het aanmaken, ophalen en aanpassen van gebruikers. --- ## 2. API Beschrijving De API maakt het mogelijk om gebruikers te beheren binnen een systeem. Je kunt nieuwe gebruikers aanmaken, bestaande gebruikers bekijken en gegevens bijwerken. --- ## 3. Belangrijke Endpoints ### POST /users - **Beschrijving:** Maakt een nieuwe gebruiker aan. - **Benodigdheden:** JSON body met verplichte gegevens. - **Voorbeeld request:** ```json { "name": "Jan Jansen", "email": "jan.jansen@example.com", "password": "SterkWachtwoord123" } ``` - **Verplichte velden:** - `name` (string) - `email` (string) - `password` (string) --- ### GET /users/{id} - **Beschrijving:** Haalt informatie op over een gebruiker met een specifiek ID. - **Gebruik:** Vervang `{id}` door het gebruikers-ID. - **Voorbeeld URL:** `/users/12345` --- ### PUT /users/{id} - **Beschrijving:** Wijzigt de gegevens van een bestaande gebruiker. - **Gebruik:** Vervang `{id}` door het gebruikers-ID en stuur de gegevens die je wilt aanpassen. - **Voorbeeld request:** ```json { "name": "Jan Jansen", "email": "jan.jansen@nieuwemail.com" } ``` --- ## 4. Testcases en Scenario’s ### Scenario 1: Gebruiker aanmaken met alle verplichte velden - **Stap:** Gebruik POST /users met volledige gegevens. - **Verwacht resultaat:** Gebruiker wordt succesvol aangemaakt, ontvang status 201. ### Scenario 2: Aanmaken gebruiker zonder verplichte velden - **Stap:** Laat een van de verplichte velden weg in POST /users. - **Verwacht resultaat:** Foutmelding, status 400, met uitleg over ontbrekend veld. ### Scenario 3: Gebruiker ophalen met geldig ID - **Stap:** Gebruik GET /users/{id} met een bestaand ID. - **Verwacht resultaat:** Ontvang de gebruikersgegevens, status 200. ### Scenario 4: Gebruiker ophalen met ongeldig ID - **Stap:** Gebruik GET /users/{id} met een niet-bestaand ID. - **Verwacht resultaat:** Foutmelding, status 404. ### Scenario 5: Gebruiker bijwerken - **Stap:** Gebruik PUT /users/{id} met nieuwe gegevens. - **Verwacht resultaat:** Gegevens worden bijgewerkt, status 200. --- ## 5. Gebruiksgids ### Stap 1: Importeren van de Collection - Open Postman. - Klik op 'Import' en selecteer de JSON-bestand van deze collectie. - De collectie verschijnt in je overzicht. ### Stap 2: Basissetting - Stel de juiste API-basURL in (bijvoorbeeld `https://api.jouwdomein.nl`). - Voeg indien nodig authenticatiegegevens toe in de 'Authorization' tab. ### Stap 3: Uitvoeren van Endpoints - Selecteer een endpoint uit de collectie. - Vul de benodigde parameters en body in. - Klik op 'Send' om de request uit te voeren. - Bekijk de response onderaan het scherm. ### Stap 4: Testen - Gebruik de ingebouwde testfuncties in Postman om automatische tests te draaien. - Controleer of de responses voldoen aan de verwachte uitkomsten. --- ## 6. Contact en Support Voor vragen of hulp, neem contact op met de API-beheerder via support@jouwdomein.nl. --- **Einde documentatie.**

Zeker, hier is een uitgebreide technische documentatie en gebruiksgids voor je Postman Collection. --- # Documentatie: Gebruikersbeheer API Collection ## 📋 Inhoudsopgave 1. [Collection Overzicht](#1-collection-overzicht) 2. [Omgevingsvariabelen](#2-omgevingsvariabelen) 3. [Endpoint Specificaties](#3-endpoint-specificaties) 4. [Testscenario's](#4-testscenario's) 5. [Collection Uitvoeren](#5-collection-uitvoeren) 6. [Bekende Beperkingen](#6-bekende-beperkingen) --- ## 1. Collection Overzicht **Naam:** Gebruikersbeheer API **Beschrijving:** Deze collection bevat alle endpoints voor het beheren van gebruikersaccounts en rechten binnen het systeem. **Basis-URL:** `{{baseUrl}}/api` **Standaard Headers:** - `Content-Type: application/json` - `Authorization: Bearer {{authToken}}` ## 2. Omgevingsvariabelen Maak een Postman Environment aan met volgende variabelen: | Variabele | Voorbeeldwaarde | Beschrijving | |-----------|-----------------|-------------| | `baseUrl` | `https://api.jouwdomein.nl` | Basis URL van de API | | `authToken` | `jwt-token-hier` | Authenticatietoken | | `userId` | `123` | Dynamisch opgeslagen user ID | ## 3. Endpoint Specificaties ### POST /users - Gebruiker Aanmaken **Beschrijving:** Maakt een nieuwe gebruiker aan in het systeem. **Request Body:** ```json { "voornaam": "string (verplicht)", "achternaam": "string (verplicht)", "email": "string (verplicht, uniek)", "wachtwoord": "string (verplicht, min. 8 chars)", "rol": "string (optioneel)" } ``` **Response (201 Created):** ```json { "id": 123, "voornaam": "Jan", "achternaam": "Jansen", "email": "jan@voorbeeld.nl", "rol": "gebruiker", "aangemaaktOp": "2024-01-15T10:30:00Z" } ``` ### GET /users/{id} - Gebruiker Ophalen **Beschrijving:** Haalt gebruikerdetails op basis van ID. **Path Parameters:** - `id`: Gebruikers-ID (vereist) **Response (200 OK):** ```json { "id": 123, "voornaam": "Jan", "achternaam": "Jansen", "email": "jan@voorbeeld.nl", "rol": "gebruiker", "actief": true, "aangemaaktOp": "2024-01-15T10:30:00Z" } ``` ### PUT /users/{id} - Gebruiker Bijwerken **Beschrijving:** Werkt gebruikergegevens bij. **Path Parameters:** - `id`: Gebruikers-ID (vereist) **Request Body:** ```json { "voornaam": "string (optioneel)", "achternaam": "string (optioneel)", "email": "string (optioneel, uniek)", "rol": "string (optioneel)" } ``` **Response (200 OK):** ```json { "id": 123, "voornaam": "Jan", "achternaam": "Jansen", "email": "jan@nieuwemail.nl", "rol": "beheerder", "bijgewerktOp": "2024-01-15T11:45:00Z" } ``` ## 4. Testscenario's ### Validatie Testcases voor POST /users **Test 1: Verplichte velden ontbreken** - **Request:** Body zonder verplichte velden - **Verwachte Response:** 400 Bad Request - **Verwachte Body:** ```json { "fout": "Validatiefout", "details": [ "voornaam is verplicht", "achternaam is verplicht", "email is verplicht" ] } ``` **Test 2: Ongeldig e-mailformaat** - **Request:** Body met ongeldige e-mail - **Verwachte Response:** 400 Bad Request **Test 3: Wachtwoord te kort** - **Request:** Body met wachtwoord < 8 tekens - **Verwachte Response:** 400 Bad Request **Test 4: Succesvolle aanmaak** - **Request:** Geldige body met alle verplichte velden - **Verwachte Response:** 201 Created - **Test Script:** ```javascript pm.test("Status code is 201", function () { pm.response.to.have.status(201); }); pm.test("Response bevat gebruiker ID", function () { var jsonData = pm.response.json(); pm.expect(jsonData.id).to.be.a('number'); // Sla ID op voor later gebruik pm.collectionVariables.set("userId", jsonData.id); }); ``` ## 5. Collection Uitvoeren ### Manuele Uitvoering 1. Importeer de collection in Postman 2. Stel environment variabelen in 3. Voer requests sequentieel uit (eerst POST, dan GET/PUT) ### Geautomatiseerde Uitvoering ```bash # Via Newman (Postman CLI) newman run "Gebruikersbeheer API.postman_collection.json" \ -e "productie.env.json" \ --reporters cli,json ``` ### Test Runner Gebruik Postman's Collection Runner voor: - Geautomatiseerde testuitvoering - Testresultaten rapportage - Performance monitoring ## 6. Bekende Beperkingen - **Rate Limiting:** Maximaal 100 requests per minuut - **Authenticatie:** Tokens verlopen na 24 uur - **Gebruikersrollen:** Alleen 'beheerder' rol mag gebruikers aanmaken --- ## 📞 Ondersteuning Voor vragen of problemen: 1. Controleer eerst of alle environment variabelen correct zijn ingesteld 2. Verify de API beschikbaarheid via health check endpoint 3. Raadpleeg de server logs voor gedetailleerde foutmeldingen **Laatste update:** 15 januari 2024 **Postman Version:** v10+ aanbevolen --- Deze documentatie is ontworpen om technische teams te ondersteunen bij het implementeren en testen van de Gebruikersbeheer API.