Indholdsfortegnelse


Introduktion

Formål

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).

Beskrivelse

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.

Links til mere information

Dokumentatione for DPK kan findes her: https://github.com/trifork/dpk-docs/wiki

Det er kaldet SendPDF der bliver brugt af DPA.

Grafisk fremstilling og sammenhængen

DPA modtager breve fra andre services og sender dem videre til DPK, som omdanner dem til PDF og sender dem videre.

Læsevejledning og forudsætninger

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).

Sikkerhed

Service udstil typeDGWS
WhitelistingWhitelisting af certifikat og system-navn for hver brev-type
Krævet sikkerhedsniveau VOCES eller FOCES certifikat
LogningDer logges svar fra DPK, i de tilfælde hvor DPK melder fejl

Definitioner og referencer

ReferenceBeskrivelse
DPADigital Post Adapter
DPKDigital Post Komponent. Komponent som leverer digital post til Digital Post og Strålfors


Adgang, brug og snitflader

Adgang

<Beskrivelse af hvordan service/komponent bruges, snitflade(r), endpoints, og andet relevant>

Endpoint(s)

På <serverurl>/digitalpost/2024/05/29/send findes endpointet http://nspop.dk/digitalpost/2024/05/29/#send

WSDL

http://test1-cnsp.ekstern-test.nspop.dk:8080/digitalpost/2024/05/29/send?wsdl

http://test2-cnsp.ekstern-test.nspop.dk:8080/digitalpost/2024/05/29/send?wsdl

Beskrivelse af servicesAfsendelse af brev til Digital Post, både digitalt og (hvis relevant) fysisk.
Namespaces etchttp://nspop.dk/digitalpost/2024/05/29/

Snitfladebeskrivelse og brug

SendDigitalPost

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

SendDigitalPostRequest
ElementBeskrivelsePåkrævet
message-idUUID version 4 som unikt udpeger genne beskeX
recipient-idID-nummer for modtager af brevet. På nuværende tidspunkt understøttes kun CPR-numreX
recipient-id-sourceOID for ID-nummeret. På nuværende tidspunkt understøttes kun 1.2.208.176.1.2X
templateID for den skabelon der skal udfyldes. Gyldige værdier kan findes i afsnittet Generelle koder, værdier, etc.X
recipient-detailsKey-value liste over modtager-specifikke detaljer der skal erstattes ind i skabelonen
template-detailsKey-value liste over skabelon-specifikke detaljer der skal erstattes ind i skabelonen

SendDigitalPostResponse

SendDigitalPostResponse
ElementBeskrivelsePåkrævet
message-idSamme 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 snarestX

Generelle koder, værdier, etc.

Disse Identifiers kan angives som template i requestet, og sender de tilsvarende Identifiers til DPK.

IdentifierIdentifiers hos DPKObligatoriske substitutions-nøglerValgfri substitutions-nøgler
fgvhr/20241218/BekraeftelseRegistreringFravalg

fgvhr/20241218/digital/BekraeftelseRegistreringFravalg

fgvhr/20241218/physical/BekraeftelseRegistreringFravalg

  • ikrafttraedelsesdato
  • date
fgvhr/20241218/BekraeftelseFortrydelseFravalg

fgvhr/20241218/digital/BekraeftelseFortrydelseFravalg

fgvhr/20241218/physical/BekraeftelseFortrydelseFravalg


  • date 
fgvhr/20241218/PaamindelseRegistreringFravalg

fgvhr/20241218/digital/PaamindelseRegistreringFravalg

fgvhr/20241218/physical/PaamindelseRegistreringFravalg


  • date

Fejlbeskeder

I fejl-scenarier vises disse fejlkoder:

FejlkodeScenarie
system-validation-errorFejl 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-errorHvis message-id ikke er en UUID version 4

Eksempler på request/response

Eksempler på request og response til de operationer der udstilles. De enkelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres udfra WSDL'en.

Eksempel på SendDigitalPostRequest/Response

<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>

Eksempel kode

Eksempel kode

Denne eksempel-kode gør brug af nsp-test-idp biblioteket til håndtering af SOAP og SEAL.

        URI endpoint = URI.create("http://localhost:8080/digitalpost/2024/05/29/send");
        String action = "http://nspop.dk/digitalpost/2024/05/29/#send";
        Identity identity = sundhedsdatastyrelsen();



        String request = """
                <ns1:sendDigitalPostRequest xmlns:ns1="http://nspop.dk/digitalpost/2024/05/29/" >
                  <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>
                </ns1:sendDigitalPostRequest>
                """;
        try (NspSoapClient nspSoapClient = new NspSoapClient(System.out::println)) {
            try (NspSoapClient.NspSoapResponse soapResponse = nspSoapClient.request(endpoint, action).as(identity).execute(request)) {
                assertEquals(200, soapResponse.getStatus());
                String response = IOUtils.toString(soapResponse.getResponse(), StandardCharsets.UTF_8);
                assertTrue("Actual response: " + response, response.contains("7edac017-97a1-4cdc-aa7c-ff2298514aff"));
            }
        }



Dokument Historik

3/4 2025Martin Henriksen/SDSEtablering af dokumentation
4/6 2025Markus Andreassen/TriforkUdfyldelse af dokumentation