Deze Quick guide beschrijft alle stappen die nodig zijn voor het succesvol implementeren van de Vragenlijstdienst (API voor Vragenlijsten en Wachttijden). De Vragenlijstdienst vereist een aanpassing in de eigen software. Om aan de slag te gaan met de Vragenlijstdienst is het noodzakelijk om, naast kennis over REST API, goede kennis te hebben van de software waar je mee werkt.
1. Lees de Generieke afspraken Vektis-services door
Dit document geeft een overzicht van de algemene afspraken en principes binnen alle Vektis services. Hier vind je alle informatie over onze Fair-use policy en authenticatie.
2. Lees de Vektis Vragenlijstdienst REST API door
Dit document geeft een instructie van hoe je de Vragenlijstdienst in je lopende processen kunt implementeren en welke informatie benaderd kan worden via de beschikbare calls.
3. Vraag bij ons een test-token en test-certificaat aan
Dit kan via referentieproducten@vektis.nl. Met dit test-token heb je toegang tot de testomgeving.
Met het token ontvang je ook enkele codevoorbeelden om te helpen bij de aansluiting, en de overeenkomsten voor de productieomgeving.
4. Gebruik de testomgeving om de functies van de REST API’s te ontdekken
Gebruik hiervoor de test cases in het Vektis Vragenlijstdienst Testcases document en de Swagger UI. Wij hebben hiernaast ook extra mockdata beschikbaar voor de Vragenlijst Wijkverpleging en de Vragenlijst Geboortezorg.
5. Onderteken de overeenkomsten
De getekende overeenkomsten die nodig zijn om deze diensten te gebruiken stuur je naar referentieproducten@vektis.nl. Na ontvangst van de getekende overeenkomsten sturen we je een token voor de productie-omgeving van de Vragenlijstdienst toe.
6. Vraag een certificaat aan voor de productie-omgeving
Als je al een Vecozo certificaat hebt, hoef je geen ander certificaat aan te schaffen.
Zo niet, schaf er dan één aan via Xolphin. Met elk van deze certificaten heb je, in combinatie met het productietoken, toegang tot de productieomgeving.
7. Implementeer de Vragenlijstdienst in je software
Gebruik hiervoor de Swagger UI en de beschikbare gebruikersdocumentatie.
8. Je bent klaar om Vragenlijstdienst te gebruiken!
Vragen?
Vragen over de werking van de vragenlijsten binnen de services of ander inhoudelijke vragen? Mail je vraag via referentieproducten@vektis.nl.