API-calls DOSIS

1 API-call bij een standaard DOSIS-integratie met een vereenvoudigde interface
- 1.1 POST /api/v1/dosis/dossiers
2 API-calls bij een standaard DOSIS-integratie
3 (Optioneel) API-calls voor asynchrone manier van werken

Meer info en configuratie na aanmelden (met de juiste rol) via:

TNI: https://tni.notificatie.dev-vlaanderen.be/Dosis
Productie: https://prod.notificaties.vlaanderen.be/Dosis

API-call bij een standaard DOSIS-integratie met een vereenvoudigde interface

POST /api/v1/dosis/dossiers

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.

Dit is een asynchrone verwerking met synchrone validatie. Het kan - afhankelijk van de drukte - even duren vooraleer het dossier beschikbaar is. Gebruik de /api/v1/dosis/resultaten?bron={bronUri}&dossierNummer={dossierNummer}methode om na te kijken of het dossier verwerkt werd.

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 contenttype (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.

Zie /api/v1/dosis/resultaten

Payload-voorbeeld: Minimale json-code DOSIS voor burgers, geen actie nodig

{
  "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

{
  "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

Zie de documentatie via https://prod.notificaties.vlaanderen.be/Dosis voor alle mogelijke velden in de body van de oproep.

GET /api/v2/dosis/bronnen/uris

Endpoint die een lijst teruggeeft van alle bronnen, met 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 dossierstatussen mag beheren. Het is dus een goede test om na te gaan of het gebruikte token correct is en of 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 het recht heeft om de bron-Uri voor een specifiek product te gebruiken. Het is dus een goede tweede test om te zien of de 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 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

StatusVlaamsCode
StatusVlaamsFase
StatusEDRL
TypeDossier
TypeSubsidie
UpdateFrequentieType

Documentatie voor partners en klanten van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers

Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers