CAPO API: verschil tussen versies

Versie van 11 jan 2022 om 15:28

De API van CAPO moet het uiteindelijk mogelijk maken om alle informatie uit CAPO ook via een API te raadplegen. Ook wordt het mogelijk om informatie toe te voegen via een API.

De API wordt stapsgewijs uitgebreid.

Documentatie over de CAPO API is hier terug te vinden:

• Productie: https://services.dsplatform.nl/api/capo/documentation/#/
• Acceptatie: https://qas-services.dsplatform.nl/api/capo/documentation/#/

De documentatie is ook kals .JSON te downloaden op: https://services.dsplatform.nl/api/capo/documentation.json

Toegang krijgen tot de CAPO API

De CAPO API is beschikbaar voor netbeheerders en aannemers in de contractgebieden die CAPO ondersteunt. Zie hiervoor de lijst van ondersteunde contractgebieden op de CAPO wiki. Om als organisatie toegang te krijgen tot de API kan een Informatieverzoek service request worden aangemaakt op onze Servicedesk. Er wordt dan een token voor je organisatie aangemaakt en verstuurd naar de primaire contactpersoon van die organisatie. Met deze token kan de API vervolgens gebruikt worden.

Indien je organisatie toegang heeft gekregen tot de API en er later incidenten optreden dan kunnen deze gemeld worden via de servicedesk van Mijn Aansluiting. Voeg hier een verwijzing aan toe van de eerdere toekenning van toegang voor jouw organisatie aan de CAPO API.

Huidige functionaliteiten

• Status project: de status van een project is op te halen.
• Status projectdossier: de status van een projectdossier is op te halen.
• Ophalen activiteit: de activiteiten van een project zijn op te halen.
• Toevoegen activiteit: er kan een activiteit aan een project worden toegevoegd.
• Ophalen klantgegevens: zoals, aanvrager, contactpersoon, bijlagen en additionele vragen
• MiC: Mee in Combi melden door de netbeheerder (of evt uit de combi stappen)

Limiet aantal verzoeken

Rate limiting is per client op het geheel van services, niet per API endpoint.