/
FAQ: Beschikbaarheid van API-documentatie en OpenAPI-specificatie

FAQ: Beschikbaarheid van API-documentatie en OpenAPI-specificatie

Owned by Caspar Kleijne
Last updated: 17,03,25

Beschikbaarheid van API-documentatie en OpenAPI-specificatie

Vraag:

Is de API-documentatie beschikbaar, idealiter in de vorm van een OpenAPI-specificatie, en wordt deze bij gunning gedeeld?

Antwoord:

Ja, de API-documentatie van Infraplannen is volledig beschikbaar en wordt in overleg gedeeld. De documentatie volgt de OpenAPI (Swagger) specificatie, waardoor ontwikkelaars eenvoudig inzicht krijgen in de functionaliteiten, toegangsvereisten en structuur van de API’s.

Technische Implementatie:

  • OpenAPI 3.0 specificatie (Swagger) wordt gebruikt om API-endpoints, request/response-modellen en authenticatievereisten te documenteren.

  • API-documentatie wordt gehost in een ontwikkelaarsportaal, zodat integrators en partners eenvoudig toegang hebben.

  • JSON-schema’s zijn beschikbaar voor flexibele dataquery’s en validaties.

Beveiliging en Toegangscontrole:

  • Toegang tot de API-documentatie is beperkt via Entra ID en RBAC om ongeautoriseerde toegang te voorkomen.

  • OAuth 2.0 authenticatie worden vereist om API’s te benaderen.

  • Logging en monitoring via Azure Monitor en Defender for Cloud houden API-verzoeken en documentatie-aanvragen bij.

Ontwikkelagenda en Updates:

  • API-documentatie wordt regelmatig geüpdatet en versiebeheer wordt toegepast.

  • Feedback vanuit ontwikkelaars en gebruikers wordt verwerkt in verbeteringen van de documentatie.

  • Nieuwe functionaliteiten en uitbreidingen worden tijdig aangekondigd in het ontwikkelaarsportaal.

De API’s van Infraplannen zijn volledig gedocumenteerd volgens de OpenAPI 3.0 standaard en worden bij gunning gedeeld. Dit zorgt voor een transparante, goed gedocumenteerde en eenvoudig integreerbare oplossing voor externe partijen.