XML-gränssnitt i portalen Suomi.fi

OBS. Det har skett ändringar i REST-gränssnittet i Suomi.fi-portalen 20.4. Varje förfrågning skall innehålla en parameter ”apikey” med en identifierande kod. Parametern kan beställas på sidan (på finska) Rest_apikeyn tilaus.

Största delen av innehållet i Suomi.fi-portalen kan hämtas via det öppna REST-gränssnittet och användas i andra webbtjänster och datasystem. Normalt ger gränssnittet informationen i XML-format, men du kan också få informationen i JSON-format t.ex. för webbläsarbaserade applikationer.

Gränssnittets webbadress är www.suomi.fi/rest/, och du definierar informationen genom att lägga till termer i slutet av adressen. Som standard ges informationen på finska, men svensk- eller engelskspråkig information får du genom att lägga språkkoden "sv" eller "en" till webbadressen. Adressen för svenskspråkig information är alltså www.suomi.fi/rest/sv/.

Nedan följer några exempel på användningen av gränssnittet.

Serviceteman i Suomi.fi

Serviceteman i Suomi.fi utgörs av de teman som finns i sektionen Service enligt tema. Portalens huvudsakliga innehåll är sorterat enligt dessa teman. En förteckning över alla serviceteman får du på olika språk med förfrågan

http://www.suomi.fi/rest/services/?apikey=xxxx
http://www.suomi.fi/rest/sv/services/?apikey=xxxx (på svenska)
http://www.suomi.fi/rest/en/services/?apikey=xxxx (på engelska)

Närmare information om serviceklasserna, ämnesorden och sidans innehåll i html-format inom de enskilda servicetemana får du genom att lägga namnet på serviceklassen till ovan nämnda förfrågan. Exempelvis får du information om servicetemat Boende och byggande med förfrågan

http://www.suomi.fi/rest/services/boende_och_byggande/?apikey=xxxx

I serviceklassen ingår olika typer av innehåll. Dessa är servicelänkar (links), e-tjänster och blanketter (forms) och lagar (laws). Exempelvis får du fram innehåll som gäller hela landet inom serviceklassen Boende och byggande med förfrågan

http://www.suomi.fi/rest/services/boende_och_byggande/links/?apikey=xxxx (länkar)
http://www.suomi.fi/rest/services/boende_och_byggande/forms/?apikey=xxxx (e-tjänster och blanketter)
http://www.suomi.fi/rest/services/boende_och_byggande/laws/?apikey=xxxx (lagar)

Genom att lägga till kommunens namn får du information för en specifik kommun. Länkar för Rovaniemi får du exempelvis med förfrågan

http://www.suomi.fi/rest/services/boende_och_byggande/links/rovaniemi/?apikey=xxxx

Landskap och kommuner

I Suomi.fi hittar du aktuell information om landskap och kommuner. Informationen administreras av Kommunförbundet. En förteckning över kommunerna i ett landskap, t.ex. i Nyland, får du med förfrågan

http://www.suomi.fi/rest/counties/nyland/?apikey=xxxx

Information om t.ex. Vasa stad och service i Vasa får du med förfrågan

http://www.suomi.fi/rest/municipalities/vasa/?apikey=xxxx

Parametrar som läggs till förfrågan

Du kan definiera formen, avgränsningen och ordningen på den information som returneras genom att lägga till parametrar efter förfrågan. Du får t.ex. servicelänkarna i sektionen Boende och byggande i JSON-format med förfrågan

http://www.suomi.fi/rest/services/boende_och_byggande/links/?return=json/?apikey=xxxx

Alla servicelänkar som lagts till portalen sedan början av augusti får du med förfrågan

http://www.suomi.fi/rest/sv/links/?startDate=2010-08-01/?apikey=xxxx

På motsvarande sätt får du länkar som lagts till portalen före augusti med förfrågan

http://www.suomi.fi/rest/sv/links/?endDate=2010-07-31/?apikey=xxxx

Du kan också begära att få resultaten sorterade enligt rubrik, datum eller länkens popularitet. Du får t.ex. alla servicelänkar i alfabetisk ordning med förfrågan

http://www.suomi.fi/rest/sv/links/?sort=title/?apikey=xxxx

På motsvarande sätt får du länkarna sorterade enligt datum med början från den äldsta med förfrågan

http://www.suomi.fi/rest/sv/links/?sort=date/?apikey=xxxx

Parametern sort kan också definieras med parametern reverse, som ger resultaten i omvänd ordning. Exempelvis får du länkarna sorterade i omvänd ordning enligt datum med början från den nyaste med förfrågan

http://www.suomi.fi/rest/sv/links/? sort=date&reverse=true/?apikey=xxxx

Du kan också begränsa antalet sökresultat med parametern limit, så att du får t.ex. de tio nyaste länkarna med förfrågan

http://www.suomi.fi/rest/sv/links/? sort=date&reverse=true&limit=10/?apikey=xxxx

Sammandrag av alla typer av förfrågan

Serviceteman

www.suomi.fi/rest/services/?apikey=xxxx
www.suomi.fi/rest/services/{palveluluokka|oid}/?apikey=xxxx
www.suomi.fi/rest/services/{palveluluokka|oid}/forms/?apikey=xxxx
www.suomi.fi/rest/services/{palveluluokka|oid}/forms/{kunta|oid}/?apikey=xxxx
www.suomi.fi/rest/services/{palveluluokka|oid}/links/?apikey=xxxx
www.suomi.fi/rest/services/{palveluluokka|oid}/links/{kunta|oid}/?apikey=xxxx
www.suomi.fi/rest/services/{palveluluokka|oid}/laws/?apikey=xxxx

Landskap

www.suomi.fi/rest/counties/?apikey=xxxx
www.suomi.fi/rest/counties/{maakunta|oid}/?apikey=xxxx

Kommuner

www.suomi.fi/rest/municipalities/?apikey=xxxx
www.suomi.fi/rest/municipalities/{kunta|oid}/?apikey=xxxx
www.suomi.fi/rest/municipalities/{kunta|oid}/forms/?apikey=xxxx
www.suomi.fi/rest/municipalities/{kunta|oid}/links/?apikey=xxxx

Organisationer

www.suomi.fi/rest/organizations/?apikey=xxxx
www.suomi.fi/rest/organizations/{organisaatio|oid}/?apikey=xxxx
www.suomi.fi/rest/organizations/{organisaatio|oid}/links/?apikey=xxxx

Länkar med serviceinformation

www.suomi.fi/rest/links/?apikey=xxxx
www.suomi.fi/rest/links/{kunta|oid}/?apikey=xxxx
www.suomi.fi/rest/links/{palveluluokka|oid}/?apikey=xxxx
www.suomi.fi/rest/links/{oid}/?apikey=xxxx

Blanketter

www.suomi.fi/rest/forms/?apikey=xxxx
www.suomi.fi/rest/forms/{kunta|oid}/?apikey=xxxx
www.suomi.fi/rest/forms/{palveluluokka|oid}/?apikey=xxxx
www.suomi.fi/rest/forms/{oid|lomaketunniste}/?apikey=xxxx

Lagar

www.suomi.fi/rest/laws/?apikey=xxxx
www.suomi.fi/rest/laws/{palveluluokka|oid}/?apikey=xxxx
www.suomi.fi/rest/laws/{finlex-tunniste|oid}/?apikey=xxxx

Ämnesord

www.suomi.fi/rest/keywords/?apikey=xxxx
www.suomi.fi/rest/keywords/{keywordid|langversionid}/?apikey=xxxx

Nyheter

www.suomi.fi/rest/news/?apikey=xxxx
www.suomi.fi/rest/news/{oid}/?apikey=xxxx

Den som tar Suomi.fi:s innehåll via gränssnittet skall förse innehållet med följande anmärkning: Informationen har hämtats ur portalen Suomi.fi utgiven av Statskontoret. Sänd gärna e-post till Suomi.fi-redaktionen om ni har utnyttjat gränssnittet.