GBO Overheid Koppelvlak Digipoort
Upcoming SlideShare
Loading in...5
×
 

GBO Overheid Koppelvlak Digipoort

on

  • 1,395 views

Dit document beschrijft het aanleveren van gestructureerde elektronische berichten bij de...

Dit document beschrijft het aanleveren van gestructureerde elektronische berichten bij de
overheid via Digipoort (voorheen Overheidstransactiepoort).
Dit document is bestemd voor ontwikkelaars van programmatuur voor het aanleveren van
gestructureerde berichten aan de overheid via deze infrastructuur. Het beschrijft hoe gebruik
kan worden gemaakt van de betrokken webservice: de aanleverservice. De specificatie van
het bij Digipoort aan te leveren bericht (de zogenaamde payload) vormt geen onderdeel van dit document. De specificatie van deze payload verschilt per berichtsoort en wordt
beschikbaar gesteld door de overheidsinstantie waar de aanlevering voor is bestemd.

Statistics

Views

Total Views
1,395
Views on SlideShare
1,386
Embed Views
9

Actions

Likes
1
Downloads
17
Comments
0

3 Embeds 9

http://cms.platformelfa.nl 3
http://www.lmodules.com 3
http://platformelfa.nl 3

Accessibility

Categories

Upload Details

Uploaded via as Adobe PDF

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment

GBO Overheid Koppelvlak Digipoort GBO Overheid Koppelvlak Digipoort Document Transcript

  • Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren Auteur GBO.Overheid Documentnummer Versie 0.3 Status Concept Datum Den Haag, 09 november 2009 Datum Pagina 29-09-09 1/26
  • Documentbeheer Documenthistorie Datum Versie Auteur Opmerkingen 21 september 2009 0.1 (concept) GBO.Overheid Initiele versie. 06 november 0.2 (concept) GBO.Overheid Toevoegen WS Addressing en OIN 09 november 2009 0.3 (concept) GBO.Overheid Toevoegen Bijlagen 13 november 2009 0.3.1 (concept) GBO.Overheid reviewcommentaar 16 november 0.4 (concept) GBO.Overheid Verwerken review Goedkeuring Datum Versie Goedgekeurd door Opmerkingen
  • Inhoud 1. Inleiding ............................................................................................................ 5 1.1. Doel en doelgroep ............................................................................................. 5 1.2. Leeswijzer......................................................................................................... 5 1.3. Status ............................................................................................................... 5 1.4. Ondersteuning................................................................................................... 6 1.5. Referenties ....................................................................................................... 6 2. Aanleveren van berichten................................................................................. 7 2.1. Inleiding ............................................................................................................ 7 2.2. Beveiliging ........................................................................................................ 8 2.2.1. Transportniveau ................................................................................................ 8 2.2.2. Berichtniveau .................................................................................................... 9 2.2.3. Autorisatie......................................................................................................... 9 2.2.4. Berichtinhoud / Berichtbijlagen......................................................................... 10 3. Sessieverloop ................................................................................................. 11 3.1. SOAP actions.................................................................................................. 11 3.2. Controleren structuur aanleververzoek............................................................. 11 3.3. Controleren SSL certificaat .............................................................................. 12 3.3.1. Nieuw aanleverproces ..................................................................................... 12 3.3.2. Bestaand aanleverproces ................................................................................ 13 3.4. Ontvangen aanleververzoek ............................................................................ 13 3.5. Bepaal verwerkingsproces ............................................................................... 13 3.6. Versturen aanleverantwoord ............................................................................ 13 3.7. Aanleververzoek plaatsen voor verdere verwerking .......................................... 13 4. SOAP bericht................................................................................................... 15 4.1. Structuur van een SOAP bericht ...................................................................... 15 4.2. Header elementen ........................................................................................... 16 4.3. Bericht elementen ........................................................................................... 16 4.4. Ondertekening bericht ..................................................................................... 18 4.5. MTOM............................................................................................................. 19 5. WS-Security .................................................................................................... 20 5.1. Tekenen van het bericht .................................................................................. 20 5.2. Tijdstempel Aangemaakt ................................................................................. 20 6. WS-Addressing ............................................................................................... 22 7. Algemene afspraken ....................................................................................... 23 Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 3/26 View slide
  • 7.1. Communicatiestandaarden .............................................................................. 23 7.2. Prefixen .......................................................................................................... 23 7.3. Karaktercodering en karakterset ...................................................................... 23 7.4. Datum en tijd................................................................................................... 23 7.5. Namespace ..................................................................................................... 23 7.6. Gebruikte standaarden .................................................................................... 24 8. Details aanleverservice OSB 2.0 WUS ........................................................... 25 8.1. Type berichten ................................................................................................ 25 8.2. Adres aanleverservice ..................................................................................... 25 8.3. SOAP Request ................................................................................................ 25 8.4. SOAP Response ............................................................................................. 25 8.5. SOAP Fault ..................................................................................................... 25 Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 4/26 View slide
  • 1. Inleiding 1.1. Doel en doelgroep Dit document beschrijft het aanleveren van gestructureerde elektronische berichten bij de overheid via Digipoort (voorheen Overheidstransactiepoort). Dit document is bestemd voor ontwikkelaars van programmatuur voor het aanleveren van gestructureerde berichten aan de overheid via deze infrastructuur. Het beschrijft hoe gebruik kan worden gemaakt van de betrokken webservice: de aanleverservice. De specificatie van het bij Digipoort aan te leveren bericht (de zogenaamde payload) vormt geen onderdeel van dit document. De specificatie van deze payload verschilt per berichtsoort en wordt beschikbaar gesteld door de overheidsinstantie waar de aanlevering voor is bestemd. 1.2. Leeswijzer Dit document maakt onderdeel uit van een reeks documenten die inzicht geven in het gebruik van Digipoort. Deze koppelvlakbeschrijving is als volgt opgebouwd: Het eerste hoofdstuk bevat algemene informatie als versiehistorie en contactgegevens. Het tweede hoofdstuk bevat een globale beschrijving van de werking van het aanleveren WUS 2.0 en de betrokken webservices. Het derde hoofdstuk beschrijft het verloop van de aanlever sessie. Het vierde, vijfde en zesde hoofdstuk beschrijven de definities van de verschillende protocollen. Het zevende hoofdstuk geeft een overzicht van alle algemeen van toepassing zijnde standaarden en afspraken. Als losse bijlagen zijn de detailspecificatie van de webservice (de WSDL) en voorbeelden van SOAP requests en responses bijgesloten. 1.3. Status Dit document beschrijft het WUS 2.0 koppelvlak van Digipoort. De verwachting is dat de gebruikte open standaarden zich de komende jaren verder zullen ontwikkelen en dat de communicatiebehoefte ook aan verandering onderhevig zal zijn. Het gevolg hiervan is dat de komende jaren nieuwe releases van Digipoort in gebruik zullen worden genomen. Dat kan gevolgen hebben voor de koppelvlakken. GBO.Overheid streeft ernaar om nieuwe releases in nauw overleg met de markt te realiseren. Om het voor marktpartijen snel en eenvoudig mogelijk te maken om gebruik te maken van Digipoort, is er voor gekozen zoveel mogelijk open standaarden en bestaande voorzieningen te gebruiken. Voorbeelden daarvan zijn het gebruik van het SOAP protocol en de toepassing van X.509 certificaten. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 5/26
  • 1.4. Ondersteuning Informatie met betrekking tot ondersteuning bij het gebruik van de services van Digipoort is beschikbaar op de website: www.overheidstransactiepoort.nl. 1.5. Referenties # Document Versie 1 Woordenlijst 2, mei 2007 2 Trusted CA lijst 0.1, juli 2007 3 Lijst berichtsoorten 1.0, juni 2007 5 OSB 2.0 Koppelvlakstandaard WUS 25 mrt 2009 5 WSDL aanleveren “AanleverService_ WUS_2.0_v1.wsdl” 22 sep 2009 6 Voorbeeld SOAP-request 22 sep 2009 “voorbeeld_AanleverRequest_OSB_WUS_2.0_v1.xml” 7 Voorbeeld SOAP – Response 22 sep 2009 “voorbeeld_AanleverResponse_OSB_WUS_2.0_v1.xml” Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 6/26
  • 2. Aanleveren van berichten 2.1. Inleiding Alle verzoeken met betrekking tot het aanleveren van gestructureerde berichten via dit koppelvlak worden door deze aanleverservice afgehandeld. In onderstaande afbeelding is de positie van de aanleverservice in Digipoort schematisch weergegeven. De aanleverservice stelt vast of een aanleververzoek van een ondernemer of intermediair voldoet aan vastgestelde koppelvlakspecificaties WUS 2.0. Indien het aanleververzoek voldoet aan de specificaties, dan start de aanleverservice een nieuw verwerkingsproces met een uniek kenmerk (kenmerk). Ook kan er een aanlevering worden gedaan waarbij een kenmerk wordt meegegeven. De aanleverservice geeft in een synchroon proces antwoord op deze aanlevering. Dit antwoord bestaat uit de melding dat de aanlevering is gelukt en een kenmerk van deze aanlevering (SOAP response) of uit de melding dat de aanlevering is mislukt (SOAP fault). Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 7/26
  • Wanneer de aanlevering succesvol is stuurt de aanleverservice de betreffende aanlevering naar het onderliggende verwerkingsproces. De aanleverservice bestaat uit de volgende onderdelen: Ontvang aanleververzoek Controleer aanleververzoek Verzenden antwoord Aanleververzoek aan verwerkingsproces aanbieden 2.2. Beveiliging 2.2.1. Transportniveau De authenticiteit van systemen in Digipoort en van gebruikers van de aanleverservice moet door alle deelnemende partijen vastgesteld kunnen worden voordat een datacommunicatiesessie wordt gestart. De authenticiteit van systemen wordt door X.509 certificaten gecontroleerd. ! Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 8/26
  • Feitelijk wordt de authenticiteit van aanleveraars bepaald aan de hand van het X.509 (client) certificaat dat zich op het cliëntsysteem bevindt. Met behulp van dit certificaat opent de client een verbinding volgens het TLS/SSL protocol. Dit protocol biedt naast authenticatie ook encryptie op transportniveau De geldigheid van het cliëntcertificaat wordt aan de hand van de gegevens in het certificaat gecontroleerd. Tevens wordt er tegen een CRL (Certificate Revocation List) gecontroleerd of het certificaat niet is ingetrokken. 2.2.2. Berichtniveau Op berichtniveau wordt beveiliging toegepast door middel van WS-Security. Het bericht dient beveiligd te zijn met een handtekening over de SOAP body. Het certificaat dat hiervoor gebruikt wordt, moet aan dezelfde eisen voldoen als het certificaat dat gebruikt wordt op transport niveau. Het hoeft echter niet hetzelfde certificaat te zijn. Deze beveiliging verzekert de integriteit van het bericht zelf. Ook als het bericht wordt gearchiveerd, blijft de WS-Security informatie met het bericht bewaard. Controle van de WS-Security handtekening houdt in dat de handtekening is gezet met een geldig certificaat en dat er een relatie bestaat tussen het certificaat en het bedrijf waarop het bericht betrekking heeft. Deze relatie kan er uit bestaan dat het certificaat van het bedrijf zelf is, of dat het certificaat hoort bij een partij die door het bedrijf is gemachtigd om namens het bedrijf informatie uit te wisselen met overheidspartijen. De controle van de identiteit van het certificaat en de autorisatie van de betreffende aanleverende partij, vindt plaats in het latere proces. Tijdens de aanlevering wordt alleen de geldigheid van het certificaat gecontroleerd. Wel moet het bedrijfnummer en berichtsoort in het aanleververzoek aanwezig zijn voor deze latere autorisatie. 2.2.3. Autorisatie Een aantal verwerkingsprocessen vereist dat de aanleveraar geautoriseerd wordt. Als dit het geval is zal degene die een aanleververzoek doet aangeven bij welke AuSP- service hij geregistreerd staat middels het “auspEndpoint” element in het aanleververzoek bericht. De controle of er een relatie bestaat tussen het certificaat en het bedrijf waarop het bericht betrekking heeft vindt plaats door autorisatie. Een proces kan hierbij gebruik maken van de de AuSP (Autorisatie Service Provider). De AuSP houdt een register bij waarin staat vermeld welke vertegenwoordigingsrelaties er bestaan tussen bedrijven en intermediairs. Dit register vermeldt voor welke bedrijven de inzender, dus degene die de handtekening heeft gezet, gestructureerde berichten mag inzenden en de status/retour informatie mag inzien. Dit is niet Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 9/26
  • alleen nodig voor intermediairs, maar ook voor bedrijven die meerdere KvK- of Fi-nummers hebben. Om een bericht bij Digipoort aan te kunnen leveren, dient de gebruiker zich te kunnen autoriseren middels een X.509 certificaat, een berichtsoort en een bedrijfnummer. De combinatie van deze drie gegevens dient bekend te zijn in het autorisatieregister van een AuSP-service. Digipoort controleert deze autorisatie-gegevens bij de AuSP-service. 2.2.4. Berichtinhoud / Berichtbijlagen Afhankelijk van de berichtsoort kan het verplicht zijn de berichtinhoud ook te ondertekenen met behulp van een X.509 certificaat. De handtekening is bestemd voor de instantie waar het bericht afgeleverd wordt. Digipoort gebruikt deze handtekening niet. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 10/26
  • 3. Sessieverloop Bij het gebruik van de aanleverservice wordt via TLS verbinding gemaakt met Digipoort. Er wordt een SOAP request bericht verzonden over de verbinding. Als het bericht niet voldoet aan de eisen gesteld in de WSDL wordt er een SOAP fault terug gezonden. Als het bericht voldoet aan de eisen wordt het verwerkt. Als het verwerken door de aanleverservice niet mogelijk is wordt er een SOAP fault terug gezonden. Als het aanleveren goed verlopen is wordt een SOAP response terug verzonden. " #$ % &$ '$ % 3.1. SOAP actions Er zijn twee acties die met de aanleverservice uitgevoerd kunnen worden. Er kan een nieuw proces opgestart worden door het doen van een aanlevering. Het is ook mogelijk een aanlevering te doen op een bestaand proces. 3.2. Controleren structuur aanleververzoek Om gestructureerde berichten aan Digipoort aan te kunnen bieden wordt gebruik gemaakt van een aanleververzoek met een voorgedefinieerde structuur. Deze structuur is vastgelegd met de Web Service Definition Language (WSDL). De WSDL voor de aanleverservice is als apart bestand bij de koppelvlak beschrijving bijgevoegd. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 11/26
  • Nadat een aanleververzoek (in de vorm van een SOAP-bericht) door Digipoort is ontvangen, worden de volgende zaken gecontroleerd: Controle Toelichting Is een element aanwezig? Hierbij wordt gecontroleerd of alle verplichte elementen zoals beschreven in de WSDL voorkomen in het aanleververzoek. Is er geen onbekend element aanwezig? Hierbij wordt gecontroleerd of in het aanleververzoek geen elementen voorkomen, die niet in de WSDL zijn beschreven. Bevat het element een waarde? Hierbij wordt gecontroleerd of alle verplichte elementen ook daadwerkelijk een waarde bevatten. Betreft het een toegestane waarde? Hierbij wordt gecontroleerd of alle elementen toegestane waarden bevatten. Bijvoorbeeld het element “tijdstempelAangemaakt”. Hierbij wordt gecontroleerd of het element een bestaande datum en tijdstip bevat. Is de lengte van de waarde juist? Hierbij wordt gecontroleerd of de waarde van de elementen niet langer is dan de lengte zoals beschreven in de WSDL. 3.3. Controleren SSL certificaat Bij binnenkomst van het aanleververzoek in Digipoort, wordt eerst het SSL certificaat gecontroleerd op geldigheid. Hierbij wordt gecontroleerd of dit certificaat toebehoort aan de reeks bekende certificaten en of dit certificaat niet ongeldig of ingetrokken is (revoked). Indien bij deze controle wordt geconstateerd dat het SSL certificaat niet voldoet aan de gestelde eisen, stuurt Digipoort een SOAP fault terug met de betreffende mededeling. 3.3.1. Nieuw aanleverproces Het is mogelijk een aanlevering te doen waarbij er een nieuw proces opgestart wordt. Er wordt op basis van de toegezonden gegevens een proces opgestart en een nieuw kenmerk aangemaakt voor de identificatie van het proces. Dit kenmerk wordt met het antwoordbericht teruggezonden aan de gebruiker. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 12/26
  • 3.3.2. Bestaand aanleverproces Het is ook mogelijk op een bestaand kenmerk een aanlevering te doen. Bij het aanleveren van berichten met een kenmerk via de aanleverservice wordt een kenmerk opgezocht en wordt het bestaande proces overschreven met een nieuw proces. 3.4. Ontvangen aanleververzoek Elk verzoek aan de aanleverservice wordt vastgelegd in de berichtenadministratie. De berichtenadministratie fungeert binnen Digipoort als audittrail. 3.5. Bepaal verwerkingsproces Nadat het aanleververzoek tegen de koppelvlakspecificaties is getoetst en de omvang van het aanleververzoek is vastgesteld, dient het uit te voeren verwerkingsproces te worden bepaald. Dit gebeurt aan de hand van het element “berichtsoort” uit het aanleververzoek. 3.6. Versturen aanleverantwoord Wanneer het aanleververzoek voldoet aan alle gestelde eisen en het verwerkingsproces is bepaald, aanleverantwoord verstuurd. Het aanleverantwoord bestaat uit de volgende elementen: Element Toelichting kenmerk Het door Digipoort toegekend unieke kenmerk aan het verwerkingsproces aanleverkenmerk Het kenmerk dat door een gebruiker aan een verwerkingsproces is meegegeven. berichtsoort Het soort verwerkingsproces waarop het gestructureerde bericht betrekking heeft. bedrijfnummer Het nummer waarmee het bedrijf kan worden geïdentificeerd in combinatie met het type nummer. overheidsnummer Het nummer waarmee de overheid kan worden geindentificeerd in combinatie met het type nummer. auspEndpoint Het endpoint van de webservice die gebruikt wordt voor het autoriseren van de ondernemer of intermediair. berichtinhoud Het hoofdbericht dat wordt verstuurd berichtbijlagen Een lijst van bijlagen die mee kunnen worden gestuurd 3.7. Aanleververzoek plaatsen voor verdere verwerking Het betreffende aanleververzoek wordt op de juiste verwerkingsqueue geplaatst voor verder verwerking. Gedurende deze verwerking worden alle overige stappen die nodig zijn om dit aanleververzoek te verwerken, genomen. Deze zijn afhankelijk van het bij het aanleververzoek behorende business proces. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 13/26
  • Een aantal elementen in het aanleverantwoord is rechtstreeks overgenomen uit het aanleververzoek. Dit vergroot de traceerbaarheid van verzoek- en antwoordberichten die bij elkaar horen, bijvoorbeeld in archieven. Het aanleverantwoord bevat tevens een handtekening van Digipoort volgens WS-Security standaard. Deze handtekening is gezet over de body van het aanleverantwoord. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 14/26
  • 4. SOAP bericht 4.1. Structuur van een SOAP bericht In onderstaande figuur wordt de opbouw van een SOAP bericht getoond. Deze is afhankelijk van het al dan niet gebruiken van MTOM. " " " " - . ) - . ) - . - . " ( ) " ( ) % % % % % % % % * + * + * * , , * + + * + * / "/ Het SOAP bericht bestaat uit: De transportprotocol header De SOAP envelope met daarbinnen: - De SOAP header - De SOAP body de berichtInhoud kan via MTOM meegestuurd worden. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 15/26
  • De SOAP header bevat de WS-Security, WS-Addressing elementen en de tijdstempel waarop het bericht is gemaakt. 4.2. Header elementen De elementen WS-Security en WS-Addressing zijn uitgewerkt in hoofstuk 5. WS- Security en 6. WS-Addressing 4.3. Bericht elementen De SOAP body bevat de inhoudelijke gegevens. De volgende elementen zijn voor de aanleverservice van toepassing: kenmerk Het kenmerk is het nummer van een bestaande proces. Wanneer deze niet is ingevuld wordt een nieuw proces gemaakt. Element kenmerk Verplicht Nee Lengte 40 Type Tekst overheidsnummer Overheidsnummer is het unieke nummer voor de overheid in de vorm van het OIN (Overheids Identificatie Nummer). Wanneer een bericht naar een specifieke overheidsinstelling moet worden gestuurd is dit element verplicht. Element overheidsnummer Verplicht Nee Lengte 20 Type identificatienummer bedrijfnummer Het bedrijfnummer is een nummer waarmee het bedrijf, waarop de berichtinhoud van toepassing is, kan worden geïdentificeerd. Dit bedrijfnummer moet om deze match te maken ook onderdeel zijn van de werkelijke berichtinhoud. Dit bedrijfnummer hoeft niet het nummer te zijn van degene die het aanleververzoek indient. Element bedrijfnummer Verplicht Ja Lengte 20 Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 16/26
  • Type identificatienummer identificatienummer Het identificatienummer bestaat uit twee velden: een nummer dat het identificatienummer voorstelt en een type dat het soort nummer aangeeft. Element identificatienummer#nummer Verplicht Ja Lengte 20 Type Tekst Element identificatienummer#type Verplicht Nee Lengte 6 Type BSN, KvK, BTW, Fi, OIN aanleverkenmerk Het aanleverkenmerk beschrijft het kenmerk dat door de gebruiker aan het aanleververzoek is gekoppeld en is meegegeven. Dit aanleverkenmerk blijft het verdere proces onveranderd en is voor deze gebruiker de identificatie voor zijn bericht gedurende het hele proces. Element aanleverkenmerk Verplicht Ja Lengte 40 Type Tekst berichtsoort Het element berichtsoort beschrijft het soort verwerkingsproces dat met dit aanleververzoek wordt geïnitieerd. Het meegegeven element berichtsoort moet van een type zijn wat binnen Digipoort bekend is. Element berichtsoort Verplicht Ja Lengte 20 Type Tekst auspEndpoint Het element “auspEndpoint” bevat het endpoint van de webservice die gebruikt wordt voor het autoriseren van de ondernemer of intermediair. De endpoint van deze CSP / AuSP dient bij Digipoort geregistreerd te staan. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 17/26
  • Element auspEndpoint Verplicht Nee Lengte 255 Type Tekst berichtinhoud De berichtinhoud bevat de af te leveren informatie. De specificatie van deze inhoud vormt geen onderdeel van het aanleverkoppelvlak. De specificatie verschilt per berichtsoort en wordt beschikbaar gesteld door de ontvangende overheidsinstantie. De standaard maximale maat van de bericht inhoud is 20 MB base64 encoded. Dit is de totale grootte van de berichten inclusief mogelijke bijlagen. Per proces kan een kleinere maximale grootte gesteld zijn. Element berichtinhoud Verplicht Ja Lengte 20 MB Type Base64 encoded berichtbijlagen Een reeks elementen in de vorm van berichtinhoud. Hiermee kunnen bijlagen worden meegegeven aan een bericht. Of dat daadwerkelijk mogelijk is hangt af van het business proces waarin het bericht wordt verwerkt. Element berichtbijlagen Verplicht Nee Lengte n.v.t. Type berichtinhoud (zie boven) 4.4. Ondertekening bericht Een belanghebbende of intermediair dient de body van het aanleververzoek te tekenen. Dit tekenen dient te geschieden met behulp van een elektronische handtekening en aan de hand van een door een CSP uitgegeven X.509 certificaat. Het certificaat, de handtekening en de gebruikte algoritmes dienen als WS-Security element in de header opgenomen te worden. Voorbeeld : Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 18/26
  • " ( ) <soap:header> <wsse:security> … <ds:signature> … % + <ds:reference URI=“#body” + % … </ds:signature> </wsse:security> </soap:header> <soap:body Id=“body”> … </soap:body> Voor het ondertekenen van het aanleververzoek kan de gebruiker gebruik maken van een portaal of service van marktpartijen die deze dienst leveren. 4.5. MTOM Zoals in 4.3. staat aangeven kan de inhoud van het bericht in het element berichtInhoud worden opgenomen. Daarnaast biedt Digipoort de mogelijkheid om de inhoud via MTOM door te sturen. Dit is beschreven in WS-I Basic Profile 1.2 (zie http://www.w3.org/TR/soap12-mtom/) Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 19/26
  • 5. WS-Security Digipoort maakt gebruik van WS-Security. Het gebruik van WS-Security levert: • De mogelijkheid op het controleren van de integriteit van het bericht. • De garantie van de identiteit van de verzender van het bericht. • Het tijdstempel kan zorgen dat er geen aanval kan worden uitgevoerd op Digipoort. Daarnaast wordt het tijdstempel ook gebruikt om aan te geven wanneer een bericht is ontvangen bij Digipoort. Het certificaat waarmee de handtekening gezet wordt moet meegeleverd worden in de header van de SOAP envelop als binary security token. 5.1. Tekenen van het bericht De volgende onderdelen worden ondertekend: soap-env:Body het header-onderdeel timestamp het header-onderdeel ws-adressing (alle elementen) De volgende eisen gelden voor de WS-Security elementen: http://www.w3.org/2000/09/xmldsig# Stap 1: Canonicalization http://www.w3.org/2001/10/xml-exc-c14n# Stap 2: Digest http://www.w3.org/2000/09/xmldsig#sha1 Stap 3: Signature http://www.w3.org/2000/09/xmldsig#rsa-sha1 of http://www.w3.org/2000/09/xmldsig#hmac-sha1 5.2. Tijdstempel Aangemaakt Het element “TimeStamp” en “Created” beschrijft de datum en het tijdstip waarop het verzoek door een gebruiker is verzonden aan Digipoort. Het tijdstempel wordt verwacht in de UTC vorm. Daarnaast biedt het optionele “Expires” de mogelijkheid aan te geven tot wanneer het bericht afgehandeld dient te worden. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 20/26
  • Deze WS-Security header elementen horen in de web service utility namespace: http://schemas.xmlsoap.org/ws/2003/06/utility/ Hiervan is Element TimeStamp Verplicht Ja Type DateTime in UTC Element Created Verplicht Ja Type DateTime in UTC Element Expires Verplicht Nee Type DateTime in UTC Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 21/26
  • 6. WS-Addressing Digipoort maakt gebruik van WS-Addressing. Een van de volgende namespaces moet gebruikt worden: • http://www.w3.org/TR/2005/CR-wsaddr-core-20050817/ • http://www.w3.org/TR/ws-addr-core/ Verder gebruikt Digipoort de WUS sub set van mogelijke WS-Addressing standaarden: Element Toelichting Verplicht wsa:To De WSDL waarde of Ja http://www.w3.org/2005/08/addressing/none of http://www.w3.org/2005/08/addressing/anonymous wsa:Action Deze waarde wordt gebruikt om een specifieke operatie Ja aan te roepen. wsa:MessageID Uniek ID Ja wsa:RelatesTo Het bevat de waarde van de wsa:MessageID van het Alleen in aanleverbericht. response bericht wsa:ReplyTo http://www.w3.org/2005/08/addressing/anonymous Nee wsa:MessageId Het unieke id voor dit bericht als UUID. Ja Voor een uitgebreide uitleg wordt verwezen naar het document OSB 2.0 Koppelvlakstandaard WUS. Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 22/26
  • 7. Algemene afspraken 7.1. Communicatiestandaarden De communicatie tussen persoon en de aanleverservice verloopt over een aantal lagen. Per laag gelden standaarden. Samengevat gaat het om de volgende standaarden: Laag Standaard Applicatielaag XML SOAP Sessielaag HTTP Transportlaag TCP Netwerklaag IP 7.2. Prefixen Door de aanleverservice worden de onderstaande prefixen gehanteerd: Prefix Namespace URI tns http://digipoort.nl/wus/2.0/aanleverservice/1.0/ soap-env http://schemas.xmlsoap.org/soap/envelope/ Wsdl http://schemas.xmlsoap.org/wsdl ds http://www.w3.org/2000/09/xmldsig# xsd http://www.w3.org/2001/XMLSchema wsse http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity- secext-1.0.xsd osb Gereserveerd voor later gebruik 7.3. Karaktercodering en karakterset De ondersteunde karakterset is UTF-8. 7.4. Datum en tijd Voor alle datum/tijd velden wordt gebruik gemaakt van het type xsd:date en xsd:dateTime, ingevuld naar de UTC (Z) variant op de ISO 8601 (NEN28601) standaard. Het gebruik van fracties van seconden is optioneel. 7.5. Namespace De namespace van dit koppelvlak is: Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 23/26
  • http://digipoort.nl/wus/2.0/aanleverservice/1.0/ 7.6. Gebruikte standaarden De aanleverservice implementeert OSB 2.0 WUS profiel OSB2W-be-S maakt gebruik van de volgende standaarden. Overheidsstandaarden: OSB 2.0 WUS profiel OSB2W-be-S PKI overheid 1.1 WS-I standaarden: WS-I Basic Profile 1.2 WS-I Basic Security Profile 1.0 W3C standard: MTOM Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 24/26
  • 8. Details aanleverservice OSB 2.0 WUS 8.1. Type berichten De aanleverservice kent drie type berichten: Onderdeel Toelichting SOAP request het verzoekbericht aan de aanleverservice waarmee gestructureerde berichten aan Digipoort kan worden aangeleverd. SOAP response een antwoordbericht dat wordt verstuurd wanneer het gestructureerde bericht door de aanleverservice correct is verwerkt. SOAP fault een foutbericht dat wordt verstuurd wanneer door de aanleverservice een fout wordt geconstateerd. 8.2. Adres aanleverservice Het adres van de aanleverservice is: https://www.procesinfrastructuur.nl/wus/2.0/aanleverservice/1.0/ 8.3. SOAP Request Zie bijlage voorbeeld_AanleverRequest_OSB_WUS_2.0_v1.xml 8.4. SOAP Response Zie bijlage voorbeeld_AanleverResponse_OSB_WUS_2.0_v1.xml 8.5. SOAP Fault De volgende elementen zijn in dit SOAP fault opgenomen Element Toelichting Faultcode Veld dat het type fout aangeeft. Voor Digipoort zijn er twee mogelijkheden, namelijk: Client: De fout is opgetreden door toedoen van de aanleverende partij. Server: De fout is opgetreden door toedoen van Digipoort. Faultstring Geeft de aard van de fout weer in voor mensen begrijpelijke taal. Faultactor Een beschrijving van de veroorzaker van de fout. detail/ foutcode Een unieke code waarmee een fout kan worden Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 25/26
  • geïdentificeerd. detail/foutOmschrijving Een omschrijving van de fout. Als er fouten in het bericht zijn, bijvoorbeeld als de handtekening ontbreekt, gezet is met een verkeerd of ongeldig certificaat, er informatie verkeerd vermeld in het bericht of niet aanwezig is, wordt een SOAP fault gegenereerd. Als bij de aanleverservice sessie het bericht niet kan worden verwerkt wordt er een SOAP fault gegenereerd Titel Datum Pagina Koppelvlakbeschrijving Digipoort WUS 2.0 Aanleveren 09-11-09 26/26