Masterdata för beställare

Snabblänkar till API per Masterdataområde

• API-sida Avtalsområde
• API-sida Organisation
• API-sida Enhet
• API-sida Serviceplats
• Beställningsformulär

Information om Masterdata

Information är något av som en organisations viktigaste tillgångar. Detta gäller inte minst i en kunskapsintensiv organisation som Region Stockholm, där Region Stockholm håller på att införa masterdata som ett led i utveckling av en mer strategisk informationshantering och en långsiktigt hållbar digital miljö. Det ska bidra till ökade förutsättningar att styra, leda och utveckla verksamheterna, till nytta för såväl invånare som medarbetare.

Data är obearbetad fakta och siffror, medan information är data som tolkats och satts i ett sammanhang. Informationsmängd är information som är avgränsad för ett visst ändamål. En informationskälla är ett system eller register där information skapas och uppdateras.

Masterdata är en typ av data som är grundläggande och gemensam för en verksamhet. Det är data som är av strategisk betydelse för organisationen och som används för att stödja verksamhetsprocesser och beslutsfattande. Exempel på masterdata är information om kunder, leverantörer och priser.

Masterdata lagras i en central källa MDM-plattformen, och delas mellan olika system och tjänster som behöver tillgång till informationen. Detta eliminerar risken för att olika versioner av data används i olika system vilket därmed minskar risken för felaktiga beslut och ineffektivitet. Genom att ha en enda källa för masterdata kan organisationen säkerställa att alla har tillgång till samma data och korrekta data.

Inom Region Stockholm finns inledningsvis masterdata om Organisation, Avtalsområde, Serviceplats och Enhet. För att komma i gång med anslutningsprocessen och börja använda masterdata fyll i formuläret här.

Vid frågor om masterdata i stort eller anslutning av system: masterdata@regionstockholm.se

Om Masterdataprogrammet i Region Stockholm

Anslutningsprocessen i korthet

Konsumtion av data från MDM-plattformen sker alltid via integrationsplattformen. Det finns generiska tjänster tillgängliga så det går att hämta just den information som behövs till en applikation på ett standardiserat sätt. Först måste ett avtal signeras som beskriver vilken information som ska konsumerande system vill hämta, vad informationen ska användas till och vilka krav aktuell applikation har på leveransen (SLA).

Beställning

En beställning inleds med att ett formulär fylls i med fullständiga uppgifter. Observera att fält som är markerade med rött är obligatoriska. Formuläret ska sedan signeras innan det skickas in av behörig beställare.

Ladda ned formuläret (länk)

Signeringen kan göras antingen manuellt eller digitalt. Vid manuell signering scannas dokumentet in innan det skickas. Signerad beställningen mailas till masterdata@regionstockholm.se

Information om digital signering (länk)

Anslutning

När beställningen är genomförd blir beställaren kontaktad för uppsättning av konto i API-portalen. API-portalen blir sedan motorn för införandet av den nya integrationen. Där hittar man som konsument all information kring konfigurering, och det är även möjligt att genomföra tester för att se hur lösningen kommer att fungera.

När ett konto är uppsatt får beställaren stöd av förvaltningarna för MDM-plattformen och Integrationsplattformen tills en fungerande integration är på plats.

Tekniska krav för att kunna ansluta till MDM-plattformen

För att ansluta krävs alltid att applikationen som ska ansluta till ett API finns registrerat i API-portalen. Vissa API:er kräver dessutom olika typer av säkerhetslösningar. Förfarandet ser olika ut beroende på om anslutningen gäller en privat aktör eller systemägare/-förvaltare inom Region Stockholm. Se API-specifikation och dokumentation för detaljerat svar:

• API-sida avtalsområde
• API-sida organisation
• API-sida Enhet
• API-sida Serviceplats

Övergripande regelverk fastslår att alla konsumenter av MDM-plattformens tjänster behöver kunna identifieras (primärt på systemnivå). Detta görs genom användningen av "client id och client secret" som i sin tur är kopplade till en "applikation" här i plattformen. Kopplingen genomförs av serviceförvaltningen. En eller flera användare kan hantera sin applikation men ansökan måste göras för varje API som applikationen behöver access till.

När anslutningen har upprättats är det viktigt att loggning sker på ett sätt som ger möjlighet till spårning och felsökning. Varje API-instans i MDM-plattformen returnerar ett korrelations-id som identifierar det aktuella anropet, vilket är viktigt att spara för att kunna få bästa möjliga support från API-supporten.

Driftsinformation/efter anslutning

Incidenthantering

Upptäcker du ett fel kring anslutningen så rapporterar du in incidenten i ServiceFörvaltningens ServiceDesk (Hem - TellUs) Alternativt kan ärendet ringas in enligt kontaktuppgifter i Service Desk. Att störningar eller incidenter rapporteras är viktigt för att supportteamet ska kunna lösa problemet så fort som möjligt.

Förändringsbegäran

Förändringar i MDM-plattformen eller tillgänglig data kan begäras genom att lägga ett ärende i TellUs med tilldelningsgrupp MDM-plattform.

Vilken data kan hämtas?

Avtalsområde

En koppling mot API:et för Avtalsområde ger tillgång till följande attribut:

Läs mer masterdatastandard för Avtalsområde

Länkar

• API-sida avtalsområde

Organisation

En koppling mot API:et för Organisation ger tillgång till följande attribut:

Läs om masterdatastandard för Organisation

Länkar

API-sida organisation

Enhet

En koppling mot API:et för Enhet ger tillgång till följande attribut:

Läs om masterdatastandard för Enhet

Länkar

Informationsmängd för Enhet

API-sida Enhet

Serviceplats

En koppling mot API:et för Serviceplats ger tillgång till följande attribut:

Läs om masterdatastandard för Serviceplats

Länkar

API-sida Serviceplats

Övergripande informationsmodell

Teknisk information APIer

Tekniska API-specifikationer för masterdata finns i respektive sida per integration:

• API-sida avtalsområde
• API-sida organisation
• API-sida Enhet
• API-sida Serviceplats

Masterdata till applikationskonsumenterna tillhandahålls genom synkrona realtidstjänster (RESTful).

Konsumenten anropar REST-tjänst i Service Förvaltningens integrationsplattorm. Integrationslösningen anropar i sin tur RESTful tjänsterna i MDM-plattformen och förmedlar svaret till konsumenten.

REST-tjänsterna är inspirerade av HATOS och följer i stort DIGGS API- profil ( REST API-profil - Utvecklarportalen (dataportal.se) )

Dataformatet är JSON och teckenkodningen UTF-8.

API-säkerhet

För att förhindra obehöriga från att använda MD-tjänster eller störa tjänsterna genom ”attacker” är lastbalanseraren (Netscaler/ADC) och integrationsplattformen (MuleSoft API-gateway) konfigurerade med API-säkerhetsfunktioner.

Tekniska krav på konsumerande system

• SITHS-funktionscert (Autentisering i integrationsplattformen sker dels med hjälp av Mutual TLS).

• ClientID/ClientSecret tillhandahållas av SF och skickas med i http-headern.

• Slutanvändarens identitet.

Informationssäkerhetsklassning

K1R2T3 (ej verksamhetskritisk, ej sekretess)

Notifieringsmeddelanden

Notifieringsmeddelanden används för att informera konsumenterna om att en förändring har inträffat. Alternativet hade varit att samtliga konsumenter hela tiden anropar APIerna och frågat ”har det hänt något” - ett antimönster.

Notifieringsmeddelandet skapas av MDM-plattformen när en förändring sker i en masterdataresurs. Notifieringssmeddelanden distribueras till mottagare som är intresserande av förändring i utpekat masterdataområde.

I notifieringsmeddelandet anges vilken resurs som har modifierats, vilket typ av händelse (förändrad, skapad, borttagen) samt en länk för att anropa den aktuella resursen.

För att kunna garanterad leverans av meddelandet behöver mottagaren bekräfta att meddelandet är mottaget.

AMQP rekommenderas som protokoll eftersom den är implementationsoberoende. Andra teknologier kan införas vid behov.

Versionshantering

Versionshantering av API:er är en teknik för att hantera förändringar i ett API över tid. Genom att använda versioner av API:et kan man säkerställa att befintliga applikationer och tjänster som använder API:et inte påverkas negativt av förändringar eller uppdateringar.

Versionshantering av API:er innebär att varje uppdatering av API:et får en ny version, där varje ny version av APIer kan hanteras på två olika sätt beroende på kompabilitet. Förändringar som är bakåtkompatibla kallas för minor upgrade medan förändringar som inte är bakåtkompatibla kallas för major upgrade.

Låt oss säga att vi har ett API i version 1.0.0, där en förändring behöver göras i API:et som inte är bakåtkompatibel. Den nya versionen får då versionsnummer 2.0.0. Nu kan konsumerande system välja att antingen använda sig av version 1.0.0 eller 2.0.0 av API:et, beroende på om de är intresserade av den nya eller gamla informationsmängden.

Efter det så behöver vi göra en bakåtkompatibel förändring på version 1.0.0, den nya versionen får då betäckning 1.1.0. De applikationer eller tjänster som sedan tidigare använde sig av 1.0.0 behöver inte göra någon förändring, utan den nya versionen (1.1.0) blir automatiskt kompatibel.

Den här versionshanteringen gör det möjligt för utvecklare att fortsätta använda den tidigare versionen om de så önskar. Varje version är unik och specificerar vilka förändringar som har gjorts jämfört med den föregående versionen. Detta innebär att om en utvecklare behöver använda en tidigare version av API:et, kan de enkelt hänvisa till den specifika versionen för att säkerställa att deras applikation fungerar korrekt.