CAPO API: verschil tussen versies

Uit DSP
Ga naar: navigatie, zoeken
(Toegang krijgen tot de CAPO API)
 
(22 tussenliggende versies door 6 gebruikers niet weergegeven)
Regel 1: Regel 1:
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 van CAPO zorgt ervoor dat vrijwel alle functionaliteit in CAPO ook via een API is te gebruiken vanuit de eigen systemen.  
  
De API wordt stapsgewijs uitgebreid.
+
Documentatie over de CAPO API is hier terug te vinden:
  
Documentatie over de CAPO API is hier terug te vinden: https://services.dsplatform.nl/api/capo/documentation/#/  
+
*'''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
  
 
==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 mail gestuurd worden naar Guido Gottenbos (guido.gottenbos@mijnaansluiting.org). 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.
+
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 [https://mijnaansluiting.atlassian.net/servicedesk/customer/portal/1/group/31/create/146 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.
 
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==
+
==Limiet aantal verzoeken==
 +
{| class="wikitable sortable"
 +
! 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===
 +
[[Bestand:Lijst_met_bijlages_voor_een_project.jpg|image|800px]]
 +
 
 +
 
 +
===Download file===
 +
[[Bestand:Download_file.jpg|image|800px]]
 +
 
  
*'''Status project''': de status van een project is op te halen.
+
===Creatie van een bestand op een project===
*'''Ophalen activiteit''': de activiteiten van een project zijn op te halen.
+
[[Bestand:Creatie_van_een_bestand_op_een_project.jpg|image|800px]]
*'''Toevoegen activiteit''': er kan een activiteit aan een project worden toegevoegd.
 

Huidige versie van 3 nov 2022 om 15:53

De API van CAPO zorgt ervoor dat vrijwel alle functionaliteit in CAPO ook via een API is te gebruiken vanuit de eigen systemen.

Documentatie over de CAPO API is hier terug te vinden:

De documentatie is ook als .JSON te downloaden: 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.

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

image


Download file

image


Creatie van een bestand op een project

image