API

Binnen Mijnaansluiting hebben we de volgende API’s:

Om gebruik te kunnen maken van 1 van deze API’s, dient het volgende service request te worden gebruikt:

https://mijnaansluiting.atlassian.net/servicedesk/customer/portal/1/group/24/create/197

Let op!: voor alle API’s worden dezelfde credentials gebruikt.
Dus als de deelnemer al credentials heeft voor de DSP API, dan kunnen die credentials ook gebruikt worden voor de CAPO API, mits de deelnemer toegang heeft tot de API.

Voorbeeld:
- Deelnemer maakt al gebruik van de DSP API en wil ook gebruik maken van de CAPO API.
- Deelnemer legt een ticket in om toegang te krijgen tot de CAPO API.
- Wanneer het ticket is afgerond, kan de deelnemer van de CAPO API gebruik maken met dezelfde credentials die hij voor de DSP API gebruikt.

DSP API

API waarmee deelnemers de status van hun opdrachten kunnen ophalen op het DSP. Dit kan op losse OpdrachtID, of als gehele lijst

Zie voor de documentatie op: https://services.dsplatform.nl/api/v1/documentation/

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

BRM API

Op de volgende pagina is meer info te vinden met betrekking tot de Business Rules Manager API:

https://services.dsplatform.nl/api/brm/documentation/

CAPO API

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:

• 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

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

Creatie van een bestand op een project