CAPO API: verschil tussen versies
(→Omgang met bijlagen) |
|||
Regel 29: | Regel 29: | ||
− | ==Omgang met bijlagen== | + | ==Omgang met bijlagen: flowdiagrammen t.b.v. API implementatie== |
+ | |||
+ | |||
+ | ===Lijst met bijlages voor een project=== | ||
+ | [[Bestand:Lijst_met_bijlages_voor_een_project.jpg|image|800px]] | ||
+ | |||
+ | |||
+ | ===Download file=== | ||
+ | [[Bestand:Download_file.jpg|image|800px]] | ||
+ | |||
+ | |||
+ | ===Creatie van een bestand op een project=== | ||
+ | [[Bestand:Creatie_van_een_bestand_op_een_project.jpg|image|800px]] |
Versie van 10 aug 2022 om 10:23
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 als .JSON te downloaden: https://services.dsplatform.nl/api/capo/documentation.json
Inhoud
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.
Limiet aantal verzoeken
configuratie | waarde | beschrijving |
---|---|---|
rate limit | 20 | aantal verzoeken per seconde |
burst | 30 | aantal verzoeken dat tegelijk mag binnen komen |
inflight requests | 3 | aantal verzoeken dat tegelijk actief mag zijn |
Rate limiting is per client op het geheel van services, niet per API endpoint.
Omgang met bijlagen: flowdiagrammen t.b.v. API implementatie
Lijst met bijlages voor een project
Download file