Gebruik deze endpoints:
TNI: https://dosis.api.tni-vlaanderen.be/
Productie: https://dosis.api.vlaanderen.be
API-call bij een standaard DOSIS-integratie met een vereenvoudigde interface
POST /api/v1/dosis/dossiers
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.
Dit is een asynchrone verwerking met synchrone validatie. Het kan - afhankelijk van de drukte - even duren vooraleer het dossier beschikbaar is. Gebruik de <a href="/api/help/methode/GET-api-v1-dosis-resultaten_bron_dossierNummer">resultaten?bron={bron}&dossiernummer={dossiernummer}</a>
-methode om na te kijken of het dossier verwerkt werd.
Deze methode is beveiligd door Geosecure; geef de access token mee in de Request header of in de querystring.
Zie ook: https://vlaamseoverheid.atlassian.net/l/c/ApYBWnzd
API-calls bij een standaard DOSIS-integratie
Voor een standaardintegratie volstaan de volgende calls:
POST /api/v2/dosis/dossiers
Must-have call om een nieuwe dossierstatus op te laden .
Geef een dossier door in de body van de request met payload in JSON.
Zet het content type (application/json) in de Content-Type request header.
Als deze call een 200 OK teruggeeft, is dat de bevestiging dat alles correct bij DOSIS verwerkt zal worden (= asynchrone verwerking). De resultaten van de verwerking opvragen kan, maar is niet noodzakelijk.
Payload-voorbeeld: Minimale json-code DOSIS voor burgers, geen actie nodig
Maximaal 1 product is verplicht mee te geven voor een dossier van het type DossierStatus.
{ "Identificatie": { "Bron": "urn://eniteit.be/applicatie", "DossierNummer": "test_20210318_2" }, "UploadId": "62ebf665-eb35-43a1-a213-8ab04cdc4160", "Naam": "test 2 dossiernaam x", "WijzigingsDatum": "2021-03-25T14:47:15.682Z", "Status": { "VlaamsCode": "Aangevraagd", "VlaamsFase": "Samenstelling", "Detail1": "dit is de detailstatus", "WijzigingsDatum": "2021-03-25T14:47:15.682Z" }, "TypeDossierCode": "DossierStatus", "Producten": [ { "Id": "xxx" } ], "DossierBeheerder": { "Dienst": "test dienst dossierbeheerder", "Telefoon": "025537202", "Email": "digitaal.vlaanderen@vlaanderen.be", "Website": "https://www.vlaanderen.be/digitaal-vlaanderen", }, "Doorverwijzing": "https://mijn.gent.be/dossier/test_20210318", "Agenten": [ { "Identificatie": "80102529724", "Toegangsrechten": [ { "Code": "Raadpleger" } ] } ] }
Payload-voorbeeld: Minimale json-code DOSIS voor burgers, actie nodig
Maximaal 1 product is verplicht mee te geven voor een dossier van het type DossierStatus.
{ "Identificatie": { "Bron": "urn://entiteit.be/applicatie", "DossierNummer": "test_20210318_2" }, "UploadId": "62ebf665-eb35-43a1-a213-8ab04cdc4160", "Naam": "test 2 dossiernaam x", "WijzigingsDatum": "2021-03-25T14:47:15.682Z", "Status": { "VlaamsFase": "Samenstelling", "VlaamsCode": "Aangevraagd", "Detail1": "dit is de detailstatus", "WijzigingsDatum": "2021-03-25T14:47:15.682Z", "Actie": { "ActieNodig": true, "Actie": "U dient nog documenten aan te leveren." }, }, "TypeDossierCode": "DossierStatus", "Producten": [ { "Id": "1710" } ], "DossierBeheerder": { "Dienst": "test dienst dossierbeheerder", "Telefoon": "025537202", "Email": "digitaal.vlaanderen@vlaanderen.be", "Website": "https://www.vlaanderen.be/digitaal-vlaanderen", }, "Doorverwijzing": "https://mijn.loket.be/dossier/test_20210318_2", "Agenten": [ { "Identificatie": "71090999892", "Toegangsrechten": [ { "Code": "Raadpleger" } ] } ] }
Body parameters
Voor TNI zie https://tni.dosis.dev-vlaanderen.be/api/bron/swagger/index#!/Dossier/Dossier_RegistreerDossierV2
Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/bron/swagger/index#!/Dossier/Dossier_RegistreerDossierV2
GET /api/v2/dosis/bronnen/uris
Endpoint die een lijst teruggeeft van alle bronnen, met bronUri, bronId en organisatie gegevens die geconfigureerd zijn voor de gebruiker door het Aansluitingen team.
Deze methode geeft alle bronnen terug waarvoor de oproeper dossier statussen mag beheren. Het is dus een goede test om te zien of de gebruikte token correct is en alle verwachte bronnen beschikbaar zijn op deze omgeving.
{ "TotalItems": 0, "PageSize": 0, "Items": [ { "BronId": 0, "BronUri": "string", "OrganisatieId": 0, "Omschrijving": "string", "Afzender": { "OrganisatieCode": "string", "OrganisatieNaam": "string" } } ] }
GET /api/v1/dosis/instellingen/validatie
Endpoint om te valideren of de configuratie (bron-URI + product-ID + authenticatie) in orde is vooraleer er effectief dossiers worden doorgestuurd.
Deze methode controleert of de oproeper recht heeft om de bronUri te gebruiken. Het is dus een goede test om te zien of de gebruikte token correct is.
GET /api/v1/dosis/resultaten/fouten?bron={bronUri}
De resultaten/fouten-methode om alle dossiers die naar DOSIS werden doorgestuurd, maar niet konden verwerkt worden, op te vragen
GET /api/v1/dosis/resultaten?bron={bronUri}&dossierNummer={dossierNummer}
De dossiernummer-methode om het laatste verwerkingsresultaat van 1 specifiek dossier op te vragen.
DELETE /api/v1/dosis/dossiers?bron={bronUri}&dossierNummer={dossierNummer}
Call om een dossier te verwijderen. Het is aangeraden om oude dossiers te verwijderen zodat ze niet eeuwig zichtbaar blijven voor de burger. Als afnemer gaat u zelf na of er wettelijke bewaartermijnen bestaan en stemt u de implementatie af op uw businesslogica.
(Optioneel) API-calls voor asynchrone manier van werken
De onderstaande calls zijn minder belangrijk omdat DOSIS synchroon werkt. Deze informatie is alleen relevant voor integratoren die er bewust voor kiezen om asynchroon te werken.
GET /api/v1/dosis/resultaten/perUploadId?uploadId={uploadId}
Om het resultaat van een POST-call op te vragen.
GET /api/v2/dosis/resultaten/fouten?bron={bronUri}&limit={max}&offset={start}
Alternatieve call om op niveau van de bron alleen de fouten op te vragen i.p.v het ok/nok-resultaat specifiek per uploadID.
GET /api/v1/dosis/codelijsten/{naam}
Om statische data op te vragen: de lijst van Vlaamse Fasen en Codes met hun technische key
bijv. geïnitieerd is geinitieerd, zonder trema, in de call
De namen van de lijsten zijn:
StatusVlaamsCode
StatusVlaamsFase
StatusEDRL
TypeDossier
TypeSubsidie
UpdateFrequentieType
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
De Swagger is alleen relevant voor de documentatie. Gebruik niet de endpoints vermeld in de Swagger.