API-calls DOSIS

Gebruik deze endpoints:

Beta: https://dosis.api.beta-vlaanderen.be.
Productie: https://dosis.api.vlaanderen.be

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

POST https://dosis.api.beta-vlaanderen.be/v1/basis-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 https://dosis.api.beta-vlaanderen.be/v2/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.

<a href="/api/help/methode/GET-api-v1-dosis-resultaten_bron_dossierNummer">resultaten?bron={bron}&dossiernummer={dossiernummer}</a>

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

Voor bèta zie https://beta.dosis.dev-vlaanderen.be/api/swagger/index#/

Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/swagger/index

GET https://beta.dosis.dev-vlaanderen.be/api/v1/dosis/resultaten/fouten?bron={bron}

De resultaten/fouten-methode om alle dossiers die naar DOSIS werden doorgestuurd, maar niet konden verwerkt worden, op te vragen

GET https://beta.dosis.dev-vlaanderen.be/api/v1/dosis/resultaten?bron={bron}&dossiernummer={dossiernummer}

De dossiernummer-methode om het laatste verwerkingsresultaat van 1 specifiek dossier op te vragen.

DELETE https://dosis.api.beta-vlaanderen.be/v1/dossiers?bron={bron}&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.

De technische codes bevatten vaak geen spaties of trema's.

Nuttige links

API-calls

Meer informatie over de API-calls op:

Swagger

Swagger-documentatie bij de DOSIS API:

Voor bèta zie https://beta.dosis.dev-vlaanderen.be/api/swagger/index#/
Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/swagger/index

De Swagger is alleen relevant voor de documentatie. Gebruik niet de endpoints vermeld in de Swagger.

Documentatie voor klanten en partners 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