Handleiding voor de Integratie van MijnAPI Inleiding Deze handleiding begeleidt ontwikkelaars bij het integreren van MijnAPI, een API voor voorraadbeheer en productinformatie. Volg de stappen om een succesvolle verbinding tot stand te brengen en de API-functioniteiten te gebruiken. 1. Authenticatie en Beveiliging Gebruik OAuth2 voor authenticatie: - Verkrijg een access token via de OAuth2-autorisatiecodeflow. - Voeg het access token toe aan elke API-aanvraag in de Authorization-header: Authorization: Bearer {access_token} 2. API Endpoints en Functies a. Productinformatie (/producten) - Doel: Haal details op van producten. - Voorbeeld GET-aanvraag: GET https://api.mijnbedrijf.nl/producten b. Voorraadbeheer (/voorraad) - Doel: Bekijk of pas voorraadniveaus aan. - Voorbeeld GET-aanvraag: GET https://api.mijnbedrijf.nl/voorraad/{product_id} - Voorbeeld PUT-aanvraag (voor voorraadupdate): PUT https://api.mijnbedrijf.nl/voorraad/{product_id} Body: { "voorraad": 100 } c. Bestellingen (/orders) - Doel: Plaats en beheer bestellingen. - Voorbeeld GET-aanvraag: GET https://api.mijnbedrijf.nl/orders/{order_id} - Plaatsen van een nieuwe bestelling: POST https://api.mijnbedrijf.nl/orders Body: { "klant_id": "12345", "producten": [ {"product_id": "abc", "aantal": 2}, {"product_id": "def", "aantal": 1} ] } 3. Voorbeeld van een GET Request Hieronder een voorbeeld van een GET-aanvraag met cURL: ```bash curl -X GET \ -H "Authorization: Bearer {access_token}" \ https://api.mijnbedrijf.nl/producten ``` 4. Foutafhandeling De API gebruikt standaard HTTP statuscodes: - 200 OK: Succesvolle aanvraag. - 201 Created: Bij het aanmaken van nieuwe resources. - 400 Bad Request: Ongeldige aanvraag of ontbrekende parameters. - 401 Unauthorized: Ongeldig of verlopen access token. - 403 Forbidden: Geen toestemming voor de actie. - 404 Not Found: Resource niet gevonden. - 500 Internal Server Error: Serverfout. Bij fouten wordt een JSON-response geretourneerd met details: ```json { "error": "Foutmelding", "code": "ErrorCode", "message": "Duidelijke beschrijving van het probleem." } ``` 5. Ondersteuning Voor vragen of problemen kunt u contact opnemen met onze support via: - Email: support@mijnbedrijf.nl - Telefoon: +31 20 123 4567 6. Samenvatting - Verifieer uw OAuth2-token voor elke aanvraag. - Gebruik de juiste endpoints voor uw doeleinden. - Controleer de HTTP-statuscodes en foutmeldingen. - Raadpleeg onze support bij problemen of vragen. Veel succes met de integratie van MijnAPI!

### Technische Handleiding: Integratie van MijnAPI **Inleiding** MijnAPI is een krachtige API voor voorraadbeheer en productinformatie. Deze handleiding beschrijft de stappen voor een succesvolle integratie, inclusief authenticatie, beschikbare eindpunten, foutafhandeling en ondersteuning. --- #### 1. **Authenticatie en Beveiliging** MijnAPI gebruikt **OAuth2** voor authenticatie. Volg deze stappen om toegang te verkrijgen: - Registreer je applicatie bij het MijnAPI-portaal om een `client_id` en `client_secret` te ontvangen. - Verkrijg een **access token** via de OAuth2-tokenendpoint (bijv. `https://api.mijnapi.nl/oauth/token`). - Includeer het token in de `Authorization` header van elke aanvraag: ```http Authorization: Bearer <jouw_access_token> ``` - Tokens verlopen na een bepaalde tijd; vernieuw ze tijdig via de refresh-token flow. --- #### 2. **Belangrijke Eindpunten en Functies** MijnAPI biedt de volgende kernfunctionaliteiten: - **`GET /producten`** Haalt een lijst van alle producten op. **Parameters:** - `categorie` (optioneel): Filter op productcategorie. - `limiet` (optioneel): Aantal resultaten per pagina (standaard: 20). - **`GET /voorraad`** Geeft de actuele voorraadniveaus per product. **Parameters:** - `product_id` (optioneel): Specifiek product-ID voor gedetailleerde voorraad. - **`GET /orders`** Toont ordergeschiedenis en orderdetails. **Parameters:** - `status` (optioneel): Filter op orderstatus (bijv. "verzonden", "in behandeling"). --- #### 3. **Integratiecode: Voorbeeld GET-aanvraag** Hieronder vind je een voorbeeld van een **GET-aanvraag** naar het `/producten`-eindpunt, geschreven in **Python** met de `requests`-bibliotheek: ```python import requests # Basis-URL en toegangstoken base_url = "https://api.mijnapi.nl" access_token = "jouw_access_token_hier" # Headers met authenticatie headers = { "Authorization": f"Bearer {access_token}", "Content-Type": "application/json" } # GET-aanvraag naar /producten try: response = requests.get(f"{base_url}/producten", headers=headers, params={"limiet": 10}) response.raise_for_status() # Controleer op HTTP-fouten producten = response.json() print("Succesvol producten opgehaald:", producten) except requests.exceptions.RequestException as e: print(f"Fout bij aanvraag: {e}") ``` **Uitleg:** - Vervang `jouw_access_token_hier` door je geldige access token. - De `params`-optioneel kunt u gebruiken om filters toe te passen. --- #### 4. **Foutafhandeling** MijnAPI gebruikt standaard **HTTP-statuscodes** om de uitkomst van aanvragen aan te geven: - **200 OK**: Succesvolle aanvraag. - **400 Bad Request**: Ongeldige parameters of aanvraagbody. - **401 Unauthorized**: Ongeldig of verlopen token. - **403 Forbidden**: Onvoldoende rechten voor de aanvraag. - **404 Not Found**: Het opgevraagde resource bestaat niet. - **500 Internal Server Error**: Interne serverfout; probeer het later opnieuw. **Voorbeeld foutafhandeling in code:** Controleer altijd de statuscode en reageer dienovereenkomstig, zoals in het Python-voorbeeld hierboven. --- #### 5. **Ondersteuning** Voor technische ondersteuning of vragen over de API: - Raadpleeg eerst de [officiële documentatie](https://docs.mijnapi.nl). - Neem contact op via e-mail: **support@mijnapi.nl**. - Vermeld bij problemen altijd: - Je `client_id`. - De relevante API-eindpunten en parameters. - Foutcodes en logbestanden. --- #### 6. **Aanbevolen Procedures** - **Beveiliging**: Bewaar je `client_secret` en tokens veilig; gebruik nooit hardcoded waarden in productiecode. - **Rate Limiting**: Respecteer de limieten van de API (bijv. 100 aanvragen per minuut) om throttling te voorkomen. - **Testen**: Test integraties eerst in de sandbox-omgeving voordat je naar productie gaat. Met deze handleiding kun je eenvoudig MijnAPI integreren in je systeem. Succes! 🚀