Documentatie bouwstenen digitale loketten
✔️ Acceptatiecriteria voor nieuwe integraties
Test-en productie-omgevingen
Als nieuwe integrator bent u verplicht om de testomgeving (TNI) te gebruiken vooraleer uw aansluiting in productie te krijgen.
Als dienstverlener die een integratie opzet om meerdere partijen te bedienen, hoeft u alleen de eerste aansluiting te laten valideren. Bijkomende aansluitingen kunnen direct in productie worden opgezet, omdat de integratie al gevalideerd is.
Gebruik unieke correlation-ID
Alle API-requests moeten een unieke correlation-ID bevatten. Dit versnelt de afhandeling van supportvragen over technische fouten.
Aandachtspunten POST-messages
Gebruik idempotency keys om dubbele zendingen te vermijden. Bewaar de documentID uit de response; dit is de unieke referentie van een zending en moet gebruikt worden om later de status op te vragen.
Codevoorbeeld
POST /api/v1/messages/messages
Authorization: Bearer oPilB4*************
X-Correlation-ID: 7cb999b8-5e2a-450a-ae30-c2be9c1ba01c
idempotency-key: fc1deb23-3869-4ccd-8afc-f0e40ad2b751
Accept: */*
Content-Type: multipart/form-data; boundary=--------------------------428096211422863083321490----------------------------451703456417497490651597
{
Content-Disposition: form-data; name="messageToSend"
{
"delivery": "EBOX",
"eboxDeliveryData": {
}
----------------------------451703456417497490651597
Content-Disposition: form-data; name="upfile1"; filename="dummy.pdf"
<dummy.pdf>
----------------------------451703456417497490651597--Maximale load
De API-gateway (Apigee) handhaaft verschillende rate limits. Zorg ervoor dat de applicatie hiermee om kan gaan. Bij te veel API-calls ontvangt u een 429-respons en moet u het aantal requests verlagen. Zie ook: https://vlaamseoverheid.atlassian.net/wiki/x/rAUpyAE .