Technische documentatie API

Met de Assets API kunt u uw service-item gegevens (zoals keuringsrapporten, serienummers, locaties, enz.) van Vandeputte Medical ophalen en integreren in uw eigen asset-managementsysteem.

Authenticatie

API-sleutel ophalen
Als klant kunt u uw persoonlijke API-sleutel terugvinden in het “Mijn Account”‑gedeelte van de Vandeputte Medical webshop onder het kopje 'API-verbinding'. Dit kopje is enkel zichtbaar voor klanten waarvoor deze functionaliteit geactiveerd is. Wilt u deze functionaliteit gebruiken, neem dan contact op met onze klantenservice.

Belangrijke punten:

De sleutel:

• is 365 dagen geldig;
• is herroepbaar (kan ongeldig gemaakt worden);

API-sleutel gebruiken
Stuur de API-sleutel mee in de request‑headers middels de 'X-API-Key' header: 
GET /v1/serviceitems HTTP/1.1
Host: www.vdpmedical.com
X-API-Key: <uw-api-sleutel>
Accept: application/json
Zonder geldige sleutel krijgt u een 401 Unauthorized foutmelding.

 

Endpoint: serviceitems

URL:

GET https://www.vdpmedical.com/v1/serviceitems

 

Queryparameters (filters)
U kunt de resultaten beperken met de volgende optionele queryparameters.

1. lastmodified
Filter op items die sinds een bepaalde datum zijn gewijzigd.

Type: datum
Formaat: YYYY-MM-DD

Voorbeeld: 
Alle items gewijzigd sinds 1 januari 2025: GET /v1/serviceitems?lastmodified=2025-01-01

2. serialnumber
Filter op één of meerdere serienummers (op basis van het Serial_No veld in Business Central).

Type: string (één of meerdere waarden, komma‑gescheiden)

Voorbeelden:
Één serienummer: GET /v1/serviceitems?serialnumber=123456
Meerdere serienummers: GET /v1/serviceitems?serialnumber=24214079,24214080,24214081

Flags
includeInspectionreports
Bepaalt of keuringsrapporten (PDF’s) worden meegestuurd.

Type: boolean
Default: false
Wanneer true: veld inspection_reports wordt gevuld met base64‑gecodeerde PDF’s van de keuringsrapporten.

Voorbeeld: GET /v1/serviceitems?includeInspectionreports=true
Let op: het ophalen van PDF‑rapporten kan de respons groter maken en meer tijd kosten. Gebruik deze optie alleen wanneer nodig.

 

Paginering

Het resultaat van de API wordt gepageerd teruggegeven. De page size is 50 items per pagina. In de response vindt u onder veld 'total_records'. U kunt pagineren middels de ?page= parameter

 

Voorbeeldresponse

Onderstaand voorbeeld toont één service-item inclusief keuringsrapport in base64‑formaat:

{
  "service_item": "SA000001",
  "technical_lifetime_years": 8,
  "customer_identification": "000000",
  "description": "Voorbeeld apparaatomschrijving",
  "serial_number": "12345678",
  "condition_status": "GOED",
  "manufacturing_date": "2019-05-27",
  "object_category": "APPARAATCATEGORIE",
  "location_code": "LOC-001",
  "service_item_location": "ASSET-00001",
  "customer_name": "Voorbeeld Zorginstelling",
  "object_type": "VOORBEELD TYPE APPARAAT",
  "inspection_date": "2025-10-02",
  "inspection_status": "Approved",
  "resource_name": "Technicus Medewerker",
  "comment": "Voorbeeldopmerking over het apparaat of de uitgevoerde keuring.",
  "age_years": 7,
  "installation_status": "Installed",
  "software_version": "v1.0.0",
  "firmware_version": "FW-1.0.0",
  "electrode_expiry_date": "2027-06-30",
  "electrode_lot_number": "LOT-00001",
  "battery_expiry_date": "2026-12-31",
  "battery_serial_number": "BAT-00001",
  "inspection_reports": [
    {
      "report_name": "Inspection_Report_Example.pdf",
      "file_base64": "JVBERi0xLjQKJcfs..."
    }
  ]
}

Veldbeschrijving (belangrijkste velden)

• service_item: Uniek service-itemnummer.
• technical_lifetime_years: Technische levensduur in jaren.
• customer_identification: Interne klantidentificatiecode.
• description: Omschrijving van het apparaat.
• serial_number: Serienummer van het apparaat.
• condition_status: Staat/conditie van het apparaat (bijv. “GOED”).
• manufacturing_date: Productiedatum (YYYY-MM-DD).
• object_category: Categorie van het apparaat (bijv. “SPUITPOMP”).
• location_code: Locatiecode (bijv. kamernummer of zone).
• service_item_location: Interne locatie-/assetcode.
• customer_name: Naam van de klant/organisatie.
• object_type: Type/merk/model van het apparaat.
• inspection_date: Datum van de laatste keuring.
• inspection_status: Status van de laatste keuring (bijv. “Approved”).
• resource_name: Naam van de technicus/medewerker die de keuring uitvoerde.
• comment: Eventuele opmerkingen bij het service-item of de keuring.
• age_years: Leeftijd van het apparaat in jaren (berekend op basis van manufacturing_date en de huidige datum).
• installation_status: Installatiestatus (bijv. “Installed”).
• software_version: Softwareversie.
• firmware_version: Firmwareversie.
• electrode_expiry_date, electrode_lot_number: Vervaldatum en lotnummer van elektroden (indien van toepassing).
• battery_expiry_date, battery_serial_number: Vervaldatum en serienummer van de batterij (indien van toepassing).
• inspection_reports: Lijst met keuringsrapporten.

Rate limiting

Om de onderliggende systemen te beschermen, is er rate limiting actief (100 requests per uur) op deze API. Bij teveel verzoeken binnen een korte tijd ontvangt u: HTTP‑statuscode 429 Too Many Requests. Wacht in dat geval even voordat u nieuwe verzoeken stuurt.

 

Foutafhandeling

De API gebruikt HTTP‑statuscodes en een gestructureerde foutrespons.

Mogelijke HTTP‑statuscodes
400 Bad Request
Ongeldige of onjuist geformatteerde queryparameters.

401 Unauthorized
Ontbrekende of ongeldige API‑sleutel (X-API-Key).

429 Too Many Requests
U heeft de toegestane hoeveelheid verzoeken overschreden (rate limiting).

500 Internal Server Error
Onverwachte fout in de API. Neem contact op met de klantenservice.

503 Service Unavailable
Er is een fout opgetreden bij het ophalen van data. Neem contact op met de klantenservice.