Alle API’s en Connectoren

ANVA stelt API’s en connectoren beschikbaar aan klanten en derde partijen.

Een API (Application Programming Interface) is een software-interface die het mogelijk maakt dat twee applicaties met elkaar kunnen communiceren. ANVA biedt API’s aan waarmee de data van het kantoor opgevraagd en gewijzigd kan worden. Ook biedt ANVA API’s aan waarmee externe databronnen bevraagd kunnen worden.

Het Developer Portal bevat een overzicht van alle API’s die beschikbaar zijn gesteld door ANVA voor integratie in websites en apps. Deze API’s kunnen, in overleg met ANVA, gebruikt worden door partners van ANVA voor hun partneroplossing maar de API’s zijn onder voorwaarden ook beschikbaar voor klanten van ANVA om te integreren met eigen oplossingen of oplossingen van derde partijen.

Alle API’s zijn gebaseerd op een REST-architectuur. Communicatie tussen websites/apps en de API’s van ANVA verloopt via HTTP requests. Op basis van HTTP-methodes zoals GET, PUT, POST en DELETE kunnen operaties zoals lezen, overschrijven, aanmaken en verwijderen worden uitgevoerd.

Een driver is een stuk software dat het besturingssysteem in staat stelt om te communiceren met hardwareapparaten, zoals printers, geluidskaarten en grafische kaarten. Drivers fungeren als een vertaler tussen het apparaat en het besturingssysteem, waardoor het apparaat correct kan functioneren.

Een library is een verzameling van vooraf geschreven code die door een programma aangeroepen kan worden om specifieke functies of taken uit te voeren. Libraries worden gebruikt om veelvoorkomende functionaliteiten te gebruiken, zoals bestand-invoer/uitvoer of wiskundige berekeningen, zodat ontwikkelaars de code niet elke keer opnieuw hoeven te schrijven. Dit maakt het ontwikkelingsproces sneller en efficiënter.

Aan het gebruik van de API’s en connectoren zijn voorwaarden gesteld door ANVA. Op dit moment is het niet mogelijk om zonder expliciete toestemming van ANVA hiervan gebruik te maken. Voor het gebruik van sommige API’s en connectoren is ook een (aanvullende) overeenkomst benodigd. Neem voor het integreren en in gebruik nemen eerst contact op met jouw accountmanager bij ANVA.

De API’s zijn geschikt voor het opvragen en soms ook aanmaken, bewerken en verwijderen van gegevens. In alle gevallen geldt dat de API’s geschikt zijn gemaakt voor individuele en ad-hoc bevragingen. De API’s zijn niet geschikt voor het uitvoeren van bulkacties, zoals het opvragen van overzichten of meerdere records tegelijk. Voor het opvragen van gegevens in bulk biedt ANVA andere oplossingen zoals een dataplatform. Het gebruik van de API’s voor bulkbevragingen kan leiden tot het opschorten van de toegang tot de API’s door ANVA.

Gebruik maken van de API’s kan uitsluitend op basis van een HTTPS-verbinding. Voor het opzetten van een veilige HTTPS-verbinding moet gebruik worden gemaakt van de encryptiestandaard TLS 1.2 (of hoger). Het is niet mogelijk om met een lagere encryptiestandaard een verbinding op te zetten.

Voor het gebruik van de API’s is ook een bearer authenticatie token benodigd. Zo’n token kun je opvragen via onze OpenID Connect Identity provider oplossing. We raden aan om voor iedere website of app die integreert met de API’s van ANVA een OpenID client te configureren en de toegekende autorisaties te limiteren tot de strikt noodzakelijke. Ook raden we aan om regelmatig het client secret te verversen.

Zowel het access token als refresh token heeft een beperkte levensduur. Standaard is de levensduur van het access token 10 uur en van het refresh token 10 uur en 10 minuten. De beheerder van de OpenID client kan met een instelling van deze standaard levensduur afwijken. Over het algemeen zal gelden dat een kortere levensduur de security versterkt.