| Table of Contents |
|---|
| Noteinfo |
|---|
Gebruik deze endpoints: TNI: https://dosis.api.tni-vlaanderen.be/ |
Swagger-documentatie
Voor TNI zie https://tni.dosis.dev-vlaanderen.be/api/bron/swagger/index
Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/bron/swagger/index
| Note |
|---|
De Swagger is alleen relevant voor de documentatie. Gebruik niet de endpoints vermeld in de Swagger. |
API-call bij een standaard DOSIS-integratie met een vereenvoudigde interface
POST /api/v1/dosis/dossiers
Om Call om een nieuwe dossierstatus op te laden.
Geef een dossier door in de body van de request met payload in JSON .
Zet het juiste contenttype (application/json) in de Content-Type request header.
...
Geef een dossier door in de body van de request met payload in JSON.
Zet het content type contenttype (application/json) in de Content-Type request header.
...
Endpoint die een lijst teruggeeft van alle bronnen, met bronUri, bronId en organisatie gegevens bron-Uri, bron-Id en organisatiegegevens die geconfigureerd zijn voor de gebruiker door het Aansluitingen-team.
Deze methode geeft alle bronnen terug waarvoor de oproeper dossier statussen dossierstatussen mag beheren. Het is dus een goede test om na te zien gaan of de het gebruikte token correct is en of alle verwachte bronnen beschikbaar zijn op deze omgeving.
...
Endpoint om te valideren of de configuratie (bron-URI + product-ID Id + authenticatie) in orde is vooraleer er effectief dossiers worden doorgestuurd.
Deze methode controleert of de oproeper het recht heeft om de bronUri bron-Uri voor een specifiek product te gebruiken. Het is dus een goede tweede test om te zien of de product configuratie productconfiguratie van een bron correct is, nadat de lijst van bronnen gecontroleerd is met GET /api/v2/dosis/bronnen/uris
...
GET /api/v1/dosis/resultaten/fouten?bron={bronUri}
...
De dossiernummer-methode om het laatste verwerkingsresultaat van 1 specifiek dossier op te vragen.
DELETE DELETE /api/v1/dosis/dossiers?bron={bronUri}&dossierNummer={dossierNummer}
...
GET /api/v1/dosis/resultaten/perUploadId?uploadId={uploadId}
Om Call om het resultaat van een POST-call op te vragen.
GET GET /api/v2/dosis/resultaten/fouten?bron={bronUri}&limit={max}&offset={start}
...
| Info |
|---|
De technische codes bevatten vaak geen spaties of trema's. |
Swagger
Swagger-documentatie bij de DOSIS API:
Voor TNI zie https://tni.dosis.dev-vlaanderen.be/api/bron/swagger/index
Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/bron/swagger/index
| Note |
|---|
De Swagger is alleen relevant voor de documentatie. Gebruik niet de endpoints vermeld in de Swagger. |