Webservicebesked (WSB) Tjekliste forudsætninger for ekstern modtagelse af STARs webservicebeskeder

Alle som ønsker at modtage STARs webservicebeskeder bedes efterleve aktiviteterne på nedenstående tjekliste

Formelt

Databehandleraftale

Aftageren skal sikre at denne har en formel dataudvekslingsaftale med STAR

Teknisk

Krav til processering og returkoder

STARs krav til processering og returkoder er beskrevet her, og skal følges: Den gode WSB/webservicebesked | Returkoder og fejlhåndtering (link til permanent forretningsside)

Følgende skal gennemføres, og hvert punkt (1, 2, 4 og 6) bedes bestilt i separate topdesk sager:

1. Rekvirer STARs klientcertifikat og evt. IP adresser til whitelist

Opret topdesk sag og bestil

STAR klientcertifikat

• Test: sys-org-star-test.cer

• Prod: sys-org-star.cer

Certifikatet er nødvendigt for for at kunne understøtte MTLS. STAR benytter samme klientcertifikat imod alle WSB-aftagere

STARs IP adresser

hvis der kræves whitelist for at STAR kan kalde baseurls/endpoints, rekvireres også STARs IP adresser til test og prod miljø.

2. SPOC/Kontaktpunkt skal meldes til STAR Systemforvaltning

Der skal etableres et kontaktpunkt (SPOC - f.eks. funktionspostkasse) hos Aftagere af Webservicebeskeder – eller driftsleverandører for samme.

Denne skal anvendes i tilfælde af, at STAR har behov for at oplyse jer om tekniske problemer (I jeres eller STARs ende af WSB-kommunikationen).

I bedes derfor oprette en Topdesk sag til STAR, med angivelse af et kontaktpunkt (e-mailadresse) som altid er overvåget inden for normal arbejdstid.

I feltet ’Kort Beskrivelse’, bedes i skrive: SPOC til tekniske henvendelser

3. Opret baseurls/endpoints

• Opret et eller flere https endpoint (port 443 eller port 8889) som kan kaldes af STAR (der er behov for endpoints til både et produktionsmiljø samt et passende antal test-miljøer). Det er fra 2024-3 ikke muligt at anvende andre porte end port 443 eller port 8889.
  Der skal oprettes minimum et endpoint pr. myndighed pr system

  • Eksempel:
    https://test.akassenavn.dk/webhooknavn
    https://test.kssnavn.dk/aftagersystem1 // https://prod.kssnavn.dk/aftagersystem2
    https://test.aftagersystem.dk/akassenavn

• SSL certifikater kan ikke være self-signed, men skal være udstedt af trusted CA

• Endpointet skal kunne modtage http requests med JSON payload. Se eksempel herunder:

4. Bestil konfigurering af Baseurls

Opret Topdesk sag, og bestil konfiguration af de oprettede endpoints / Baseurls.

Følgende formular kan anvendes hvis det ønskes (er ikke et krav):

Systemforvalter konfigurerer disse i Subscribersystem hvor vi yderligere indsætter hvilket klientsystem baseurlen tilhører.

E-mail:
Konfigureringen skal også bindes til en E-mail hos aftager som Systemforvaltningen kan sætte som rekvirent på topdesksager i tilfælde af fejl ved aftagelse af beskeder.

5. Opsæt ønskede abonnementer (WebApi)

Der skal anvendes systemcertifikat ved kald med WebAPI.

WebApi EksternKommunikation Services

Webservicebesked (WSB) abonnementsoprettelser frem til 2024-3archived

6. Opsæt ønskede abonnementer (LSS brugergrænseflade)

Adgang Test

Hvis man ønsker at bruge LSS brugergrænsefladen, kræver det:

• At den IP adresse du skal tilgå systemt fra er whitelistet hos STAR (gælder kun testmiljø). Whitelist af IP adresse skal bestilles i Topdesk sag.

• personligt certifikat, som skal tildeles adgang. Dette bestilles ved at oprette en topdesk sag. Systemforvaltning udsteder certifikatet til Testmiljøerne (eller tildeler adgang på eksisterende certifikat).

Adgang Produktion

Til Produktion skal aftager selv komme med personligt OCES3 certifikat udstedt af den danske stat, og banke på amportal.bm.dk med certifikatet. Herefter oprettes en sag i topdesk for at få tildelt adgang.

Vejledning - Banke på med certifikat i produktionsmiljøet

Opsætning

LSS: Webservicebesked (WSB) administration i LSS for eksterne

7. Fjern WSB abonnement ved skift af miljø der anvender Endpoints i testmiljøerne

WSB Abonnementer skal fjernes i de perioder et STAR testmiljø ikke anvendes, da der ellers opstår fejl og ophobning i køer. WSB køer bliver automatisk slettet, når abonnementer fjernes.

Proces for overgang fra WSRM til WSB

Tdispunkt for overgang fra WSRM til WSB kommer an på, om Ekstern aftager er robust ift. at modtage besked om samme hændelse både via WSRM og WSB.

Hvis Ekstern aftager er robust kan WSB tages i brug i prod, når det passer jer bedst.

Hvis Ekstern aftager ikke er robust anbefales det at ibrugtage en given WSB i produktion ifm. en release. Dette vil sikre, at alle WSRM'er, som er genereret før idriftsættelsen, bliver aftaget og eventuelt behandlet, inden systemet lukkes ned ifm. releasen. Efter releasen kan der begynde at blive genereret WSB'er, som planlægges til at starte efter kl. 15 på releasedatoen. På den måde modtager aftager kun WSB'er for registreringer, der sker efter idriftsættelsen af den nye release. Og dermed ikke både WSRM og WSB for samme hændelse.

Til release lukker STAR lukker systemerne ned kl. 15, og ekstern aftager tømmer wsrm kø jf. den udmeldte aktivitetsliste. For 2024-3 er det denne: https://starwiki.atlassian.net/wiki/spaces/SRI/pages/4597350401
Når STAR åbner systemerne igen efter release, er man live med WSB modtagelse - dette kræver at ovennævnte forudsætninger er opfyldt.