Se eksempel på udfyldelse på DDS: DDS - Guide til anvendere - NSP services - Global Site
Denne guide har som formål at give et overblik over Digital Post Adapter (DPA). Formålet med dokumentet er at give anvendere et overblik over løsningen, samt en oversigt over, hvilke User Stories der er understøttet af DPA og hvordan disse er implementeret (flows).
Digital Post Adapter står for at videresende breve til Digital Post Komponent. Dette gøres asynkront via en kø, således at brevene vil blive sendt før eller senere, selv hvis DPK er utilgængelig.
Dokumentatione for DPK kan findes her: https://github.com/trifork/dpk-docs/wiki
Det er kaldet SendPDF der bliver brugt af DPA.
DPA modtager breve fra andre services og sender dem videre til DPK, som omdanner dem til PDF og sender dem videre.
<Angiv use cases såfremt det er relevant>
Dette dokument er henvendt til udviklere og arkitekter, der skal anvende Digital Post Adapter .
Det forventes at læseren har kendskab til SOAP WebService, Den Gode WebService (DGWS) og Sercurity Token Service (STS).
<Forudsætninger for anvendelse og krævede adgange, whitelistinger etc., Sikkerhedsniveau. Angiv krav til authentication for at kunne bruge servicen/komponenten.>
| Service udstil type | DGWS |
| Krævede adgange | <Angiv adgange som er nødvendige for anvendere for at kunne benytte servicen/komponenten> |
| Whitelisting | Whitelisting af certifikat og system-navn for hver brev-type |
| Krævet sikkerhedsniveau | VOCES eller FOCES certifikat |
| Forudsætninger for anvendelse | <Angiv forudsæntninger som er nødvendige for at kunne bruge servicen/komponenten, eventuelle nødvendige kald til andre services, etc.> |
| Logning | <Angiv om og hvad der logges> |
| <evt. yderligere krav eller forhold> |
<Eventuel yderligere beskrivelse af området / domænet som servicen/komponenten servicerer>.
<Samt yderligere information som er vigtigt for anvendelsen eller forståelsen>
| Reference | Beskrivelse |
|---|---|
| DPA | Digital Post Adapter. Denne komponent |
| DPK | Digital Post Komponent. Komponent som leverer digital post til Digital Post og Strålfors |
<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>
| Tilgængelig | <Angiv på hvilke(n) NSP-installation(er) servicen/komponenten er tilgængelig> |
| Endpoint(s) | <Angiv udstillede endpoint(s), og hvad de hedder.> |
| WSDL | <Angiv henvisning til WSDL(er). For ekstern anvendbare services typisk på https://wsdl.nspop.dk/> |
| Beskrivelse af services | Afsendelse af brev til Digital Post, både digitalt og (hvis relevant) fysisk. |
| Namespaces etc | <Angiv eventuelt Namespaces, eksterne typer, ..> |
SendDigitalPost kaldet sætter et Digital Post brev på en kø, som afvikles med jævne mellemrum. Hvis et brev succesfuldt sendes til DPK fjernes det fra køen, men hvis kaldet mod DPK fejler beholdes brevet i køen og forsøges afsendt igen senere og supporten får vha. is-alive kald besked om at der er et brev som er fejlet.
| SendDigitalPostRequest | ||
|---|---|---|
| Element | Beskrivelse | Påkrævet |
| message-id | UUID version 4 som unikt udpeger genne beske | X |
| recipient-id | ID-nummer for modtager af brevet. På nuværende tidspunkt understøttes kun CPR-numre | X |
| recipient-id-source | OID for ID-nummeret. På nuværende tidspunkt understøttes kun 1.2.208.176.1.2 | X |
| template | ID for den skabelon der skal udfyldes. Gyldige værdier kan findes i afsnittet Generelle koder, værdier, etc. | X |
| recipient-details | Key-value liste over modtager-specifikke detaljer der skal erstattes ind i skabelonen | |
| template-details | Key-value liste over skabelon-specifikke detaljer der skal erstattes ind i skabelonen | |
| SendDigitalPostResponse | ||
|---|---|---|
| Element | Beskrivelse | Påkrævet |
| message-id | Samme message-id som blev sendt ind vil blive returneret. Dette betyder ikke at brevet er sendt succesfuldt afsted, men at det er blevet sat i køen og vil blive forsøgt afsendt snarest | X |
Disse Identifiers kan angives som template i requestet, og sender de tilsvarende Identifiers til DPK.
| Identifier | Identifiers hos DPK | Obligatoriske substitutions-nøgler | Valgfri substitutions-nøgler |
|---|---|---|---|
| fgvhr/20241218/BekraeftelseRegistreringFravalg | fgvhr/20241218/digital/BekraeftelseRegistreringFravalg fgvhr/20241218/physical/BekraeftelseRegistreringFravalg |
|
|
| fgvhr/20241218/BekraeftelseFortrydelseFravalg | fgvhr/20241218/digital/BekraeftelseFortrydelseFravalg fgvhr/20241218/physical/BekraeftelseFortrydelseFravalg |
| |
| fgvhr/20241218/PaamindelseRegistreringFravalg | fgvhr/20241218/digital/PaamindelseRegistreringFravalg fgvhr/20241218/physical/PaamindelseRegistreringFravalg |
|
I fejl-scenarier vises disse fejlkoder:
| Fejlkode | Scenarie |
|---|---|
| system-validation-error | Fejl i sikkerheds-billet valideringen |
| invalid-oid-error | Hvis der angives en anden recipient-id-source end understøttet. På nuværende tidspunkt understøttes kun 1.2.208.176.1.2 |
| invalid-uuid-error | Hvis message-id ikke er en UUID version 4 |
Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres udfra WSDL'en.
<SendDigitalPostRequest>
<message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id>
<recipient-id>1111111118</recipient-id>
<recipient-id-source>1.2.208.176.1.2</recipient-id-source>
<template>fgvhr/20241218/BekraeftelseRegistreringFravalg</template>
<recipient-details>
<key>ikrafttraedelsesdato</key>
<value>2025-05-01</value>
</recipient-details>
<template-details>
<key>date</key>
<value>2025-04-25</value>
</template-details>
</SendDigitalPostRequest>
<SendDigitalPostResponse>
<message-id>7edac017-97a1-4cdc-aa7c-ff2298514aff</message-id>
</SendDigitalPostResponse> |
<beskriv Test muligheder, test-systemer og eventuelle testdata>
<Eksempel kode. Det er meget lettere at lave sin egen implementering, hvis man kan kigge efter en anden ....>
<eksempel her, eller reference andet steds> |
<og hvor det giver mening angiv eventuel eksempel klient, samt hvordan og hvor det eventuelt kan eksekveres>
| 3/4 2025 | Martin Henriksen/SDS | Etablering af dokumentation |