Voor ontwikkelaars die onze API willen integreren in hun eigen systemen, zoals patiëntenportalen of telefonie-integraties, biedt de Swagger-file een helder overzicht van alle beschikbare endpoints. Deze documentatie helpt bij een efficiënte en correcte implementatie van de API.

Wat biedt de Swagger-file?

Op de Swagger-pagina vindt u:

• Een gestructureerd overzicht van alle API-endpoints.
• Per endpoint een uitleg over de vereiste en optionele parameters.
• Inzicht in de verwachte responses bij verschillende API-aanroepen.
• De mogelijkheid om API-calls direct te testen.

Daarnaast is er een handige flowchart beschikbaar die visueel weergeeft wanneer welk API-endpoint moet worden aangeroepen.

API-sleutel en testen via Swagger

Om toegang te krijgen tot onze API is een unieke API-sleutel vereist. Deze kan door de klant bij ons worden aangevraagd. Zodra u over een API-sleutel beschikt, kunt u via Swagger eenvoudig testen hoe de verschillende endpoints reageren. Dit doet u door rechtsboven op de pagina op de groene knop "Authorize" te klikken en de API-sleutel in te voeren.

Met deze tools en documentatie wordt het integreren van onze API eenvoudiger en efficiënter. Heeft u vragen of ondersteuning nodig? Neem dan contact op met ons supportteam via support@moetiknaardedokter.nl.