Teknisk dokumentation för den som genomför integrationen (gränssnittsversion 12)

Servicedatalagrets gränssnittsversioner

En betaversion av sökgränssnittet för SDL:s gränssnittsversion 12 har publicerats i produktionsmiljön 03/2026.

Läs mer om arkitekturreformen och planen för byte av gränssnittsversioner

Basuppgifter om SDL:s gränssnitt

Servicedatalagret har ett öppet REST/JSON-gränssnitt. Uppgifterna ges fritt för vidare användning med CC0-licens, dvs. du kan använda uppgifterna utan begränsning.

Från och med gränssnittsversion 12 behöver du en API-nyckel för att använda både sökgränssnittet och importgränssnittet.

Du kan skapa en API-nyckel i självbetjäningen. Nyckeln är tillgänglig direkt efter att den skapats. När du tar i bruk nyckeln ska du meddela din organisations kontaktuppgifter till Myndigheten för digitalisering och befolkningsdata. Kontaktuppgifterna används för att informera om störningar i gränssnittet.

Läs bruksanvisningen för API-nyckeln för gränssnittsversion 12.

I organisationens och serviceställets lokaliseringsuppgifter används koordinatsystemet EPSG:3067.

När du genomför en ny integration ska du alltid använda den senaste tillgängliga gränssnittsversionen.

Sökgränssnitt

Med hjälp av sökgränssnittet kan du söka uppgifter i SDL. Om du genomför sökintegrationen ska du bekanta dig med följande anvisningar:

• Mer information för den som genomför sökintegrationen (gränssnittsversion 12)
• Övergång från gränssnittsversion V11 till version V12 (sök- och importgränssnitt)

Importgränssnitt

Med hjälp av importgränssnittet kan du importera uppgifter till SDL från ett annat system. För att använda importgränssnittet krävs ett separat användningstillstånd.
Om du genomför importintegrationen ska du läsa följande anvisningar:

• Mer information för den som genomför importintegrationen (gränssnittsversion 12)
• Övergång från gränssnittsversion V11 till version V12 (sök- och importgränssnitt)
• Regler för tolkning av gränssnittsdata
• Så här tar du i bruk importgränssnittet (IN-gränssnittet)

Datamodell

Servicedatalagret innehåller kundorienterade uppgifter om tjänsterna och tillhörande servicekanaler samt kopplingsuppgifter mellan dessa. I gränssnittet kan du också söka uppgifter om de organisationer som beskrivit tjänsterna.

Innan du börjar genomföra integrationen ska du noggrant bekanta dig med följande:

• Konceptet för SDL, som berättar vad Servicedatalagret är och vad det används till.
• Allmän beskrivning av datamodellen, som beskriver SDL:s centrala begrepp och sambanden mellan dem.
• SDL:s logiska datamodellÖppnas i ett nytt fönster. (på finska), som beskriver datamodellens strukturer och relationerna mellan dem närmare.

Gränssnittsdokumentation i Scalar

Gränssnittsanrop och anvisningar för hur de används finns för respektive miljö:  

• Gränssnittsdokumentation för kundtestmiljön (Scalar)Öppnas i ett nytt fönster.
• Gränssnittsdokumentation för produktionsmiljön (Scalar) Öppnas i ett nytt fönster.

Gränssnittsanropen har i gränssnittsdokumentationen grupperats i två helheter: datainnehåll och referensdata.

Datainnehållet (core) innehåller gränssnittsanrop för följande SDL-innehåll:

• tjänster
• servicekanaler
• kopplingar
• organisationer
• basbeskrivningar
• servicehelheter

Referensdata (reference data) innehåller

• kodsystem
• klassificeringar och
• övriga referensuppgifter.

Användning av gränssnittsanrop

• Sök uppgifter med GET-metoder
• Lägg till information med POST-metoder
• Uppdatera uppgifter med PUT-metoder
• Arkivera uppgifter med DELETE-metoder

Använd API-nyckeln vid alla anrop. Användningen av POST-, PUT- och DELETE-metoderna förutsätter också användningstillstånd för importgränssnittet, se anvisningen Så här tar du i bruk IN-gränssnittet.

SDL:s källkod

SDL:s källkod är för närvarande inte offentligt tillgänglig i GitHub. Om du behöver källkoden till exempel som stöd för integrationen eller det tekniska utredningsarbetet ska du be om den på adressen ptv-tuki@dvv.fi.