Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

POST messages - v1

Informatie:

Voor de ontsluiting van MAGDA RESTful services en het generieke proces binnen een RESTful service, wordt verwezen naar Werking en overzicht uitzonderingen MAGDA RESTful services.

Situering

De POST messages laat een verzender toe om documenten te verzenden naar burgers, bedrijven en organisaties (inclusief overheden).

De documenten kunnen digitaal, via ebox, als per papier verzonden worden. 

De verzender kan de documenten eveneens aangetekend verzenden indien gewenst.

Verwante diensten

POST statusRequest

POST eboxPreferences/search

Achterliggende diensten

Deze dienst gaat achterliggend naar FOD BOSA (eBox burger), de Rijksdienst voor Sociale Zekerheid (eBox onderneming) en naar IPEX (papieren verzending en verzending per mail). 

Opmerking:

Agentschap Digitaal Vlaanderen is afhankelijk van deze externe partijen voor de kwaliteit en de werking van de diensten. 

Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze dienst te mogen gebruiken:

  • Toelating tot het MAGDA platform

  • scope: msg_msg_v1_P, msg_mailbox_v1_P (dit is nodig indien het kanaal “Automatisch” gebruikt wordt, zodat er kan gecontroleerd worden of de bestemmeling consent heeft gegeven voor het gebruik van ebox).

  • Toelating om de diensten te gebruiken bij de externe partijen.

  • Indien een verzender wil starten met het versturen van berichten in productie, vragen we aan de verzender om vooraf in productie een aantal testen te doen om na te gaan dat alles correct functioneert. Dit om te vermijden dat er gestart wordt met een massale verzending in productie voor er een sanity test is gebeurd.

  • Indien een verzender meer dan 1000 verzendingen op 1 dag zal doen in productie, vragen we dat de verzender een realistische loadtest uitvoert in de acceptatie omgeving, waarbij de maximaal mogelijke load op 1 dag wordt uitgetest. Voor we de opzet in productie doen, kijken we na of deze loadtest goed is verlopen.

  • Bij een eerste grote verzending in productie, vragen we dat dit gefaseerd gebeurt, dus in batches (bijvoorbeeld eerst 10, erna 100, erna 1000,…). Dit hoeft enkel bij de eerste verzending. Het is steeds mogelijk om hiervoor de nodige afspraken te maken zodat we dit mee kunnen monitoren.

Informatie:

Meer informatie over deze voorwaarden is terug te vinden op de pagina “Machtigingen en toelatingen”.

Meer informatie over het aansluitingsproces is terug te vinden op deze webpagina.

Werking

Aandachtspunten

RESTful service

Opties

De verzender bepaalt zelf op welke manier hij wil verzenden: via ebox, per papier of automatisch (= via ebox en indien de ontvanger geen toestemming heeft gegeven voor het gebruik van ebox, wordt er eveneens per papier verzonden).

Alle documenten die verzonden zijn naar de ebox burger (ook voordat deze toestemming heeft gegeven) zijn beschikbaar in de ebox (let wel: de documenten zijn pas rechtsgelding indien ze verstuurd zijn naar de ebox nadat de burger toestemming heeft gegeven). Een burger kan de toestemming voor ebox burger op elk gewenst moment terug intrekken. 

Een onderneming kan de toestemming voor ebox onderneming niet intrekken.

Opvraging

Het antwoord van deze dienst wordt gemaakt op basis van het antwoord dat we ontvangen van de achterliggende dienst (BOSA voor eBox Burger, RSZ voor eBox onderneming, IPEX voor verzending per papier en per mail).

Responsetijden & Beschikbaarheid

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

Ondersteunde talen

Documenten verstuurd via eBox voor Burgers, kunnen aangeleverd worden in 3 verschillende talen (Nederlands, Frans of Duits).

Documenten verstuurd via eBox voor Ondernemingen, kunnen aangeleverd worden in 1 taal: het Nederlands.

End-to-end testen

Berichten naar PAPER

De berichten worden in de integratietest omgeving NIET afgedrukt. Deze kunnen dus niet automatisch end to end getest worden.
In samenspraak met de printpartner kan wel afgesproken worden om bepaalde documenten wel te laten afdrukken en verzenden, dit vereist een manuele handeling langs de kant van de printpartner.

Berichten naar EBOX burgers

De test- en integratieomgeving van de documentendienst is gekoppeld met de integratieomgeving van ebox citizens.
Hiervoor stelt BOSA een aantal testgebruikers ter beschikking. Je kan dus documenten verzenden naar deze testpersonen om end-to-end te testen.

De ebox integratieomgeving kan je hier vinden: https://mycitizenebox.int.belgium.be/myebox

Inloggen kan met onderstaande gebruikers. Je kiest op CSAM voor inloggen met token. De benodigde tokens kan je in de zip als bijlage terugvinden.

eID Tokens of the test users: 

 

 

Activation code

Username/password

RRN

Email address

Account language

Account activated

Refresh token used by

User 1

QM1HX N6844 EBLK5 C7TNT

bosaeboxtest1

47040242545

bosaeboxtest101@gmail.com

Dutch

NO

 

User 2

SFURD 2K3PF P13YA Q577K

bosaeboxtest2

60070753282

bosaeboxtest102@gmail.com

Dutch

Yes

 

User 4

QE43A CSV23 8AZDD F97FB

bosaeboxtest4

76121827193

bosaeboxtest104@gmail.com

Dutch

Yes

 

User 5

RGXZZ BQCIE 65UWA 4UIRV

bosaeboxtest5

71111317533

bosaeboxtest105@gmail.com

Dutch

Yes

 

User 6

XIJU8 343GV I9RRM WQ2FE

bosaeboxtest6

47071447049

bosaeboxtest106@gmail.com

French

Yes

 

User 7

D7N2B TTKV9 EYEMI DSYZH

bosaeboxtest7

85080540327

bosaeboxtest107@gmail.com

French

Yes

 

User 9

UGE3R 5GIBA MXFKH 6VBHU

bosaeboxtest9

75120136503

bosaeboxtest109@gmail.com

French

Yes

 

User 10

1FEEI PLJYI X29JM WX256

bosaeboxtest10

91040526866

bosaeboxtest110@gmail.com

French

Yes

 

User 11

I97I4 Y22AE 4F2G4 X5UYV

bosaeboxtest11

84031815028

bosaeboxtest111@gmail.com

German

Yes

Automated test

User 12

4IW9C 323J4 1QII1 AWAMF

bosaeboxtest12

84051013011

bosaeboxtest112@gmail.com

German

Yes

David

User 13

YLNQC JJ2PG AL9MH 4B2KR

bosaeboxtest13

87100729039

bosaeboxtest113@gmail.com

German

Yes

Yuvaraj

User 14

MYIIR UYIXB BBAS7 6VZMD

bosaeboxtest14

92042816483

bosaeboxtest114@gmail.com

German

Yes

Philipp

User 15

VNLDK 9W1FE L7M2W SLLD3

bosaeboxtest15

83123005202

bosaeboxtest115@gmail.com

German

Yes

Joaquin

Berichten naar EBOX ondernemingen


De acceptatieomgeving van EBOX voor ondernemingen is terug te vinden op https://wwwacc.eboxenterprise.be/
Indien uw onderneming nog niet actief is op de acceptatieomgeving dient u eerst toegang aan te vragen. Zelfregistratie is op dit moment nog niet mogelijk.

U mailt hiervoor naar eBoxIntegration@smals.be en geeft het KBO-nummer van uw organisatie door samen met de de rijksregisternummers van de personen die toegang mogen krijgen tot de ebox enterprise in de acceptatieomgeving.

 

Belangrijk: Standaard toont de RSZ ebox HIP op TNI enkel de berichten die ze zelf als document provider aanbieden. Berichten van andere document providers (zoals MAGDA) worden dus standaard niet getoond in de RSZ ebox HIP. Indien u de berichten die bij de MAGDA document provider zitten, wenst te zien in de RSZ ebox HIP, dient u de instructies te volgen die ze vanuit RSZ publiceerden op:

https://dev.eboxenterprise.be/docs/dp/consultation_profile#introspect-of-an-e-box-enterprise-oauth-token onder de titel: “TESTING ON EBOXENTERPRISE.BE

Om MAGDA toe te voegen als doc provider moet je dus dit uitvoeren in de console:

app.addDocumentProviders({'url':'https://iv.api.tni-vlaanderen.be/api/v2/ebox-enterprise', name:'MAGDA', version:'1.0.0', id:'test_MAGDA'})

Om de providers te resetten (via dezelfde console):

app.resetDocumentProviders()

 

Voor PROD is deze actie NIET nodig. Daar worden de berichten uit alle document providers wel automatisch opgehaald en getoond aan de ontvanger.

Op deze pagina


Binnen deze handleiding


Omgevingsinformatie

Domein

POST

Classificatie

Persoonsgegevens


Verwante diensten


 




Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid

uitgegeven door Digitaal Vlaanderen