CAPO API: verschil tussen versies
(→Toegang krijgen tot de CAPO API) |
|||
Regel 6: | Regel 6: | ||
==Toegang krijgen tot de CAPO API== | ==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 service request worden aangemaak | + | 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 service request worden aangemaak [Servicedesk|https://mijnaansluiting.atlassian.net/servicedesk/customer/portal/1/group/31/create/146]. 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. | 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. |
Versie van 1 dec 2021 om 13:43
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: https://services.dsplatform.nl/api/capo/documentation/#/
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 service request worden aangemaak [Servicedesk|https://mijnaansluiting.atlassian.net/servicedesk/customer/portal/1/group/31/create/146]. 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.
- Ophalen activiteit: de activiteiten van een project zijn op te halen.
- Toevoegen activiteit: er kan een activiteit aan een project worden toegevoegd.
Limiet aantal verzoeken
configuratie | waarde | beschrijving |
---|---|---|
rate limit | 1 | aantal verzoeken per seconde |
burst | 3 | aantal verzoeken dat tegelijk mag binnen komen |
inflight requests | 3 | aantal verzoeken dat tegelijk actief mag zijn |