Technische tips & tricks DOSIS

1 Overzicht foutmeldingen
- 1.1 HTTP 401
- 1.2 HTTP 403
- 1.3 HTTP 400
- 1.4 HTTP 429
2 Performantietips
- 2.1 ACM-Token
- 2.2 Performantie van dossiers of toelatingsupdates versturen

Overzicht foutmeldingen

HTTP 401

Er is geen of geen geldig token in de Authorization Header, zie Beveiliging DOSIS via ACM/IDM. Vraag een token aan met

scope dv_dosis_import
de juiste audience voor de omgeving, zieAanvraag API Access Token

Deze fout komt soms voor omdat eenzelfde token te lang gebruikt wordt. Zie ook: Performantietips.

HTTP 403

De ACM-client heeft niet de nodige rechten om het dossier of de toelating aan te passen. Deze rechten worden toegekend door het Aansluitingen-team tijdens het aansluitingsproces.

De dossierbron (met Bron-URI en Bron-ID) moet aangemaakt zijn voor de Afzender (= inhoudelijk verantwoordelijke) van de dossier- en toelatingsupdates
De ACM-client van de Aanbieder (= technisch verantwoordelijke) v(an de updates moet de juiste rechten hebben en gekend zijn als Aanbieder voor de bron

De foutboodschap ziet er als volgt uit:

{
  "code": "string",
  "message": "string",
  "description": "string"
}

Zodra de aansluitingsgegevens aangepast zijn, kan deze update onveranderd opnieuw worden aangeboden.

HTTP 400

De inhoud van de notificatie voldoet niet aan de vormvoorschriften. De respons ziet er als volgt uit:

{
  "code": "string",
  "message": "string",
  "description": "string",
  "errors": [
    {
      "code": "string",
      "message": "string",
      "description": "string",
      "field": "string"
    }
  ]
}

De message- en description-velden geven aan wat er fout was. De dossier- of toelatingsupdate wordt niet aanvaard met de huidige inhoud.

Errors is optioneel en enkel aanwezig als er meer gedetailleerde validatieboodschappen zijn.

HTTP 429

De DOSIS-API wordt beschermd door een application firewall. Zodra er te veel calls tegelijk komen, geeft dit de foutboodschap HTTP 429 - Too many requests. Open uw Circuitbreaker en probeer het later opnieuw.

De huidige limiet is 1800 oproepen per minuut, voor alle gebruikers van de API. Het is dus ook mogelijk dat u deze fout ziet omdat andere gebruiker(s) een groot aantal oproepen doen.

Krijgt u deze fout frequent, neem contact op met de Servicedesk of kom langs op het technisch spreekuur, wekelijks op dinsdag van 13:00 tot 14:00 uur. De limiet moet misschien verhoogd worden of er bestaat een betere aanpak om grote aantallen statusupdates te versturen. Zie ook de Performantietips hieronder.

Performantietips

ACM-Token

Wanneer u meerdere updates verstuurt, hergebruik zoveel mogelijk één ACM-token.

Een ACM-token aanmaken en valideren is vaak het traagste deel van een update versturen/verwerken. DOSIS valideert een ACM-token slechts één keer, bij de eerste oproep met dat token. Daarna wordt de validatie gecachet en zijn alle volgende oproepen met datzelfde token een stuk sneller.

Wanneer u een token ontvangt van ACM, bevat de respons een expires_in-veld dat aangeeft hoelang het token nog geldig is.

Gebruik het token niet tot het laatste moment omdat het ongeldig wordt tussen het moment dat het wordt opgestuurd en gevalideerd wordt. Dat leidt af en toe tot onverwachte HTTP 401 responses.
Een nieuw token is meestal een uur geldig. Vraag een nieuw token aan wanneer de resterende geldigheidsduur minder dan 1 minuut is. Zo bent u zeker dat het token geldig blijft voor de hele duurtijd van de volgende oproep.

Performantie van dossiers of toelatingsupdates versturen

Stuur updates bij voorkeur sequentieel wanneer:

de API trager is door hoge belasting, dan stuurt u ook trager updates door
een token gevalideerd moet worden, dan zijn alle andere oproepen met hetzelfde token geblokkeerd tot het resultaat van de validatie gekend is
u de bandbreedte en de verwerkingskracht deelt met alle andere aanbieders van DOSIS. Zie ook HTTP 429 respons

Een update aanbieden kost meestal minder dan 1 of 2 seconden. Uitzonderlijk duurt het langer door factoren buiten de DOSIS-bouwsteen om, zoals de belasting en de responstijden van andere systemen die worden opgeroepen door DOSIS. Gebruik een communicatietime-out die voldoende lang is om met dergelijke schommelingen om te kunnen. Dit is typisch een time-out van 15 tot 30 seconden.

Stuur een update opnieuw als het de eerste keer niet lukt omdat er een fout, time-out of HTTP 429 respons komt. Dit kan bijv. door de gefaalde updates in een queue te plaatsen en later opnieuw te proberen.

Bij een HTTP 400 validatiefout heeft het geen zin om opnieuw te proberen verzenden zonder eerst de inhoud van de update aan te passen.

POST /api/v1/dosis/dossiers doet de validatie asynchroon. Gebruik GET /api/v2/dosis/resultaten/fouten om eventuele validatiefouten later op te vragen.
Gebruik liever POST /api/v2/dosis/dossiers want deze API geeft meteen alle validatiefouten terug vooraleer het dossier in de achtergrond verwerkt wordt.

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