API Devportal
Om gebruik te maken van de Voogd & Voogd API's dient u aangemeld te zijn bij Voogd & Voogd Verzekeringen. U kunt hiervoor contact opnemen met uw relatiebeheerder. Zodra u aangemeld bent, ontvangt u inloggegevens voor de API Devportal.
Applicatie aanmelden
Om de REST API binnen uw applicatie te kunnen gebruiken moet deze eerst aangemeld worden in de API Devportal. Onder het tabje Applications kunt u zelf één of meerdere applicaties aanmaken en deze vervolgens abonneren op de benodigde API's.
Let op: Wanneer u de applicatie abonneert op een API heeft u de keuze om een Tier te selecteren. Dit bepaalt hoeveel aanvragen er per minuut richting de API mogen gaan. Eenmaal over dit limiet worden verdere aanvragen naar de API geweigerd.
Consumer key / secret
Per applicatie kan er een Consumer Key / Consumer Secret worden gegenereerd. Hierbij kan een onderscheid worden gemaakt tussen Production keys en Sandbox keys, afhankelijk van de omgeving waar u op wilt werken. De Consumer Key / Consumer Secret combinatie wordt gebruikt voor het genereren van access tokens, de tokens waarmee de REST calls geautoriseerd worden.
Sandbox mode
Ontwikkeling aan de applicatie dient plaats te vinden in Sandbox mode. Middels de Sandbox mode worden API calls uitgevoerd op de acceptatie / demo omgeving van Voogd & Voogd, hiermee voorkomt u dat testinformatie wordt doorgestuurd naar een productieomgeving.
REST Documentatie
Op dit moment bevat de API Devportal de technische REST documentatie. Onder het tabje APIS vindt u de diverse API's die Voogd & Voogd aanbiedt, inclusief de bijbehorende endpoints. Elk endpoint is voorzien van een uitgebreid datamodel en de parameters die door het endpoint worden geaccepteerd.
Try it out
Bij alle API endpoints is er een mogelijkheid om deze uit te voeren via de API Devportal. Middels deze functie kunt u een voorbeeld JSON testen tegen de geselecteerde omgeving.
Let hierbij op de volgende punten
- Bovenaan de pagina dient het access token opgevoerd te worden ( Authorization: Bearer ).
- Zorg dat het access token afkomstig is van de juiste applicatie.
- Zorg dat het access token afkomstig is van de juiste modus ( productie vs sandbox ).
- Zorg dat het access token niet verlopen is.