Övergång från gränssnittsversion V11 till version V12 (sökgränssnitt)
Beta – innehållet utvecklas
Denna anvisning har utarbetats för organisationer som använder SDL:s sökgränssnitt (OUT-gränssnitt), som utnyttjar SDL-uppgifter via det nuvarande OUT-gränssnittet och som förbereder sig på att övergå från gränssnittsversion 11 till version 12. Anvisningen stöder bedömningen av arbetsmängden och genomförandet av ibruktagandet av den nya versionen. För kunder som använder importgränssnittet (IN-gränssnittet) utarbetas senare en separat anvisning som stöder versionsbytet.
Anvisningen är preliminär och dess innehåll kompletteras och uppdateras under våren 2026 i takt med att arbetet med att reformera SDL:s arkitektur framskrider. Anteckningen ”kommer senare” betyder att anvisningen kompletteras under våren 2026 inom ramen för SDL:s arkitekturreform.
Vad kommer att förändras jämfört med föregående version?
Detta versionsbyte avviker från tidigare i fråga om dess omfattning: ändringarna är betydande och kräver mer beredning och utvecklingsarbete av dem som genomför integrationen.
Hur gränssnittsändringen påverkar användarna
Nödvändiga åtgärder
Användningen av gränssnittsversion 12 förutsätter aktivering av en API-nyckel. Se anvisningen [om aktivering av API-nyckeln] (kommer senare).
Användaren av gränssnittet ska uppdatera logiken i gränssnittsanropen och behandlingen av information så att de motsvarar den nya versionens struktur och svarsstrukturer.
Nya gränssnittsanrop och svarsstrukturer ska testas noggrant. Testningen kan göras i kundtestmiljön. Se anvisningen [om testning av gränssnittet] (kommer senare).
Observera att två versioner av SDL:s datainnehåll fungerar parallellt i bakgrunden under övergångsperioden – det vill säga under den tid då gränssnittsversionen 11 fortfarande kan användas för att uppdatera uppgifterna i SDL: version 11 och version 12. Inmatningen och uppdateringen av uppgifterna görs fortfarande via version 11, varifrån uppgifterna överförs i bakgrunden till version 12 med en fördröjning på cirka 1–1,5 timmar.
Den första gränssnittsversionen som publiceras i mars 2026 är en betaversion som kan ändras och preciseras före den slutliga versionen.
När SDL:s importgränssnitt för uppgifter tas i testbruk hösten 2026 strävar man efter att befästa innehållet i sökgränssnitten. Målet är att inga betydande ändringar ska göras i dem.
Ändringar i sökgränssnitten
Det finns två olika söksätt i gränssnittsversion 12
sökning av ett enskilt innehåll med identifikatorer
sökning av uppgifter med sökvillkor, varvid man använder /Search-metoden och dess sökparametrar.
Search-metoden erbjuder mångsidiga sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Sökningen kan avgränsas bland annat utifrån organisation, organisationstyp, servicegrupp, ämnesord, målgrupp och områdesuppgifter.
Innehåll som sökgränssnittet returnerar
För uppgifter som kompletterar eller klassificerar det sökta innehållet, såsom tjänstens målgrupper, livssituationer eller ämnesord, returneras endast koder (ID), inte hela innehållet
Sökgränssnittet returnerar endast publicerade uppgifter. Arkiverat innehåll (servicekanal, organisation, tjänst) kan sökas med separata anrop. Dessa anrop returnerar endast identifikatorer (ID:n), inte hela innehållet.
Information på olika språk med samma innehåll returneras i en egen samling i languageVersions-strukturen. I exemplet nedan visas en del av de fält i tjänsten som finns på olika språk. Exemplet innehåller inte alla uppgifter som gränssnittet returnerar.
"languageVersions": { "fi": { "name":"Osallistuva budjetointi", "alternativeName": "Osbu", "summary": "Tee ehdotuksia ja äänestä – ole mukana kunnan päätöksenteossa koskien taloutta ja resursseja.", "description": "Mitä palvelua tai asiaa kaipaat porvoolaisten iloksi ja hyödyksi? Ehdota ideaa ja äänestä suosikkiasi Porvoon kaupungin toteutettavaksi.", }, "sv": { "name": "Deltagande budgetering", "alternativeName": "Osbu", "summary": "Lämna förslag och rösta – delta i stadens beslutsfattande om ekonomi och resurser.", "description": "Vilken tjänst eller sak längtar du efter som kan vara till glädje och nytta för invånare i Borgå? Föreslå en idé och rösta din favorit att förverkligas i Borgå stad.", }, ...
Search-sökningen erbjuder mångsidiga sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Sökfilter är service (identifikator) och servicekanal (identifikator).
Search-sökningen erbjuder mångsidiga sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Sökfilter är till exempel basbeskrivningstyp, organisation och servicegrupp.
V12 gränssnitt (GET) -arkiverat innehåll
/api/v12/general-description/archived
V11-gränssnitt som slopas (GET) (för dessa finns inget motsvarande gränssnitt i version V12)
Search-sökningen erbjuder mångsidiga sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Sökfilter är till exempel områdesinformation och organisationstyp.
V12 gränssnitt (GET) -arkiverat innehåll
/api/v12/organization/archived
V11-gränssnitt som slopas (GET) (för dessa finns inget motsvarande gränssnitt i version V12)
Search-sökningen erbjuder mångsidiga sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Sökfilter är till exempel näringsgrensklass, servicegrupp, ämnesord, målgrupp och organisation.
Observera att informationen i tjänstens basbeskrivning inte ingår i returneringen av tjänstens uppgifter. I tjänstens uppgifter returneras endast koden för den använda basbeskrivningen (id), inte dess innehåll.
V12 gränssnitt (GET) -arkiverat innehåll
/api/v12/service/archived
V11-gränssnitt som slopas (GET) (för dessa finns inget motsvarande gränssnitt i version V12)
/api/v11/Service/serviceWithGD/{id}
/api/v11/Service/list
/api/v11/Service/archived/list
/api/v11/Service/serviceWithGD/list
/api/v11/Service/active
/api/v11/Service/active/{id}
/api/v11/Service/serviceChannel/{serviceChannelId} (använd i fortsättningen sökgränssnittet Service Channel i stället för detta)
Observera att V12-gränssnittsanropen som anges nedan är vägledande. Uppdaterad och detaljerad information finns i SDL API Specifikationen i kundtestmiljön(utbildningsmiljön), se avsnitt Service channel. (länk kommer senare)
I V12-versionen genomförs följande sökningar
V12 gränssnitt (GET)
/api/v12/service-channel/content-id/{contentId}
/api/v12/service-channel/external-id/{externalId}
/api/v12/service-channel/search
Search-sökningen erbjuder mångsidiga sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Sökfilter är till exempel områdesinformation, organisation och typ av servicekanal.
V12 gränssnitt (GET) -arkiverat innehåll
/api/v12/service-channel/archived
V11-gränssnitt som slopas (GET) (för dessa finns inget motsvarande gränssnitt i version V12)
Search-sökningen erbjuder sökfilter som kan användas för att söka information från olika synvinklar i gränssnittet. Som sökfilter till exempel avgränsning enligt organisation.