DSP API's

DSP Aansluiting en DSP Hoofdnet hebben allebei een eigen Swagger-pagina, waar de specificatie van de berichten beschreven staat. Er is een Productie (PRD) en een Acceptatie (QAS) versie. Dit is met name relevant voor een nadere release die veel eerder op QAS dan op PRD beschikbaar komt.

Verder zijn er:

• Status API: mogelijkheid om een opdrachtenlijst en/of opdrachtdetails op te halen. Het doel is om het eigen systeem te kunnen vergelijken met het DSP om te controleren of er verschillen zijn ontstaan. Te gebruiken voor zowel Hoofdnet als Aansluiting.

• Business Rules Manager (BRM): Mogelijkheid om de business rules op te halen. De business rules zijn een aanvulling op de specificatie van DSP Aansluiting, waarin wordt aangegeven hoe optionele velden gevuld moeten worden, afhankelijk van de werkzaamheden voor de opdracht.

Toegang aanvragen tot API’s

DSP Hoofdnet en Aansluiting gebruiken dezelfde credentials, met unieke sets voor PRD en QAS. Credentials worden verstrekt tijdens het onboarding proces.
De BRM API gebruikt dezelfde credentials als DSP (met ook unieke sets voor PRD en QAS), maar mogelijk moet er een scope uitbreiding aangevraagd worden bij de servicedesk om er gebruik van te kunnen maken.
De Status API maakt gebruik van dezelfde credentials als de CAPO API, met unieke sets voor PRD en QAS. Toegang kan aangevraagd worden bij de servicedesk.

Versiebeheer Swagger

Het kan voor komen dat een versie een bugfix of minor update krijgt, wat resulteert in een nieuwe versie van de Swagger-documentatie, terwijl de berichtversie niet veranderd. Een voorbeeld: In DSP Aansluiting versie 3.0 is op een later moment de Laadpunt-specificatie toegevoegd. Dit wordt beschouwd als documentatie-versie 3.1, terwijl de berichtversie onveranderd 3.0 is gebleven. Dit is te herkennen aan de URL en de versie-badge bij de titel op de Swagger-pagina.

Open