Siirry sisältöön

Enkänt om API-riktlinjer för den offentliga förvaltningen

Kysymysmerkki 0
Kysely | Valtiovarainministeriö
Kysely on päättynyt

I regeringsprogrammet för statsminister Marins regering har det ställts som mål att bland annat främja en primär öppen källkod i offentliga informationssystem och vid upphandlingen av dem samt att genom lag reglera skyldigheten att förutsätta öppna gränssnitt när offentliga informationssystem skaffas, om inte något annat följer av vägande skäl. Utgångspunkten är att offentliga aktörer ska ha öppna offentliga gränssnitt, om det inte finns en särskild orsak att ha dem stängda. Finansministeriets projekt för nyttjande och öppnande av information verkställer de mål som finns i rege-ringsprogrammet för Sanna Marins regering. Målet för projektet är bland annat att främja ett enhetligt nyttjande av information och funktioner, primärt via programme-ringsgränssnitt (API). API-riktlinjerna är gemensamma principer för den offentliga för-valtningens API-utveckling och för främjandet av digitalisering.

API-riktlinjerna är av tre olika slag: strategiska, taktiska och operativa. Intressegrupperna kommer att få kommentera målen och de preliminära API-riktlinjerna under januari 2021. Målen och riktlinjerna uppdateras och preciseras utifrån kommentarerna ges under år 2021 och övrigt källmaterial. De slutliga API-riktlinjerna slås fast på samma gång som handlingsdirektiven i slutet av år 2021. Handlingsdirektiven är praktiskt hållet stödmaterial som gör det lättare att ta i bruk riktlinjerna. Handlingsdi-rektiven börjar beredas i slutet av våren 2021.

Enkäten svaras i fri form och anonymt. Som bakgrundsinformation ber vi dig att ange den organisation som du representerar eller om du svarar som en privatperson. Alla frågor behöver man inte besvara men vi önskar att du kommenterar så många frågor som möjligt.

Perustiedot

Päättynyt: 31.1.2021

Liitteet

Ilmianna

Kyselyn pakolliset kysymykset on merkitty (*) tähtimerkillä.

Vilken organisation representerar du? (Du kan välja flera alternativer)
Målen med API-riktlinjerna
KUNDFOKUS OCH SAMARBETE. Målet med API-riktlinjerna är att främja en kundorienterad utveckling av programmeringsgränssnitten samt för bättra samarbetet mellan aktörerna. Kundfokus innebär att behoven hos potentiella användare av programvarugränssnittet beaktas i gränssnittets hela livscykel ända från kartläggningsfasen till underhållsfasen. Samarbete är både organisationsinternt samarbete eller samarbete med externa parter. Samarbete inom en organisation är samarbete på organisationens olika nivåer, mellan team och enheter. Samarbete med externa parter är samarbete mellan aktörer inom offentliga sektorn eller samarbete mellan aktörer inom den privata och den offentliga sektorn.
SÖKBARHET. Målet med API-riktlinjerna är att främja sökbarheten i programmeringsgränssnitten samt sökbarheten av information och funktioner i dem. Sökbarhet betyder att de publicerade programmeringsgränssnitten samt informationen och funktionerna i dem är sökbara, så att de kan nyttjas.
KOMPATIBILITET OCH ÅTERANVÄNDBARHET. Målet med API-riktlinjerna är att främja kompatibiliteten och återanvändbarheten i programmeringsgränssnitten och i informationen och funktionerna i dem. Kompatibilitet betyder teknisk och semantisk kompatibilitet i de publicerade programmeringsgränssnitten. Återanvändbarhet innebär att återanvända publicerade programmeringsgränssnitt samt information och funktioner i dem.
DATASÄKERHET OCH DATASKYDD. Målet med API-riktlinjerna är att främja datasäkerhet och dataskydd i programmeringsgränssnitten. Datasäkerhet innebär att uppgifterna är sekretessbelagda, fullständiga och tillgängliga under programmeringsgränssnittets hela livscykel. Dataskydd innebär att personuppgifter behandlas i enlighet med skydd för privatlivet och i enlighet med dataskyddsförordningen.
KRAVENLIGHET. Målet med API-riktlinjerna är att främja kravenligheten i programmeringsgränssnitten. Kravenlighet betyder att känna igen, följa upp och verifiera de krav som ställs på programmeringsgränssnittet.
BÄSTÄ PRAXIS. Målet med API-riktlinjerna är att främja nyttjande av bästa praxis i programmeringsgränssnitten. Bästa praxis betyder att nyttja praxis, rekommendationer, ramverk eller övrigt som konstaterats fungera.
API-riktlinjer
Strategiska riktlinjer
API NYTTJAS I UPPNÅENDE AV STRATEGISKA MÅL OCH SOM STÖD FÖR BESLUTSFATTANDE. Riktlinje för hur API:n ska beaktas som ett verktyg för att uppnå de strategiska målen för en organisation inom offentlig förvaltning och hur uppgifter som insamlas och behandlas med API kan nyttjas för ledning med hjälp av business intelligence och som stöd för organisationens beslut. Informationsbehandling med programmeringsgränssnitt förbättrar förståelsen för informationskapitalet och informationens kvalitet, eftersom tillhandahållande av information via programmeringsgränssnitt tvingar till att känna igen och klassificera information, att fästa uppmärksamhet vid informationens riktighet och beskriva informationens struktur.
API:N NYTTJAS I VERKSAMHETSUTVECKILNGEN. Riktlinje om hur API:n ska beaktas i verksamhetsutvecklingen inom den offentliga förvaltningen. Med hjälp av API:n kan man bland annat effektivera digitaliseringen och automatiseringen eller ta fram nya tjänster och lösningar, såsom användargränssnitt och mobiltjänster samt lösningar med artificiell intelligent och IoT.
MED API:N FRÄMJAS DEN NATIONELLA OCH INTERNATIONELLA FÖRENLIGHETEN OCH ÅTERANVÄNDBARHETEN. Riktlinje om API:s betydelse när det gäller att främja den nationella och internationella förenligheten ska beaktas i organisationer inom den offentliga förvaltningen. Med API:n möjliggörs återanvändbarhet för information och funktioner, vilket stadgas i Europeiska unionens direktiv om öppen data. Dessutom främjar API:n verkställandet av dataförvaltningsakten (DGA) som är under beredning i kommissionen.
API:N ÄR DET PRIMÄRA SÄTTET ATT TILLHANDAHÅLLA OCH NYTTJA INFORMATION. Riktlinje om hur API:n ska nyttjas som det primära sättet att tillhandahålla och nyttja information och funktioner både inom en organisation och externt. Värdefulla dataset som fastställs direktivet för öppen data14 ska tillhandahållas via API:n. För att säkra att API:n fungerar och kan återanvändas är det viktigt att organisationen själv nyttjar de API:n som tillhandahålls. Dessutom tar riktlinjen ställning till vad som ska beaktas i den offentliga förvaltningens anskaffning av informationssystem gällande tillhandahållande och nyttjande av uppgifter med API:n.
MÄTBARA MÅL UPPSTÄLLS FÖR FRAMTAGANDE AV API:N. Riktlinje om hur organisationer inom den offentliga förvaltningen ska fastställa mål för API-utvecklingen. Målen kan gälla byggande av funktioner för tillhandahållande och nyttjande av API eller för bredare tillhandahållande av API till intressegrupper utanför organisationen. Målen ska dimensioneras enligt organisationens status för tillfället och övriga mål. Målen ska vara mätbara, så att man kan följa upp om de uppnås eller ej.
FÖR TILLHANDAHÅLLANDE OCH NYTTJANDE AV API:N TILLDELAS DE RESURSER SOM BEHÖVS. Riktlinje om hur organisationer inom den offentliga förvaltningen ska känna igen och tilldela de resurser som krävs för tillhandahållande och nyttjande av API:n. För tillhandahållande och nyttjande av API:n krävs pengar (budgetmedel), kunskaper och tillräckliga personal- och teknikresurser. API-kunskaper behövs såväl inom it-administrationen som i verksamhetsenheterna. API:n är inte bara en teknisk metod, utan en möjliggörare av verksamhet, varvid kunskaper behövs även i verksamheterna.
SAMARBETE PÅ ORGANISATIONENS OLIKA NIVÅER OCH MED EXTERNA INTRESSEGRUPPER GÄLLANDE UTVECKLINGEN AV API:N. Riktlinje om hur organisationer inom den offentliga förvaltningen ska samarbeta inom organisationen och med externa parter gällande tillhandahållande och nyttjande av API:n. Internt samarbete behövs på organisationens olika nivåer, mellan enheter och team. Särskilt samarbete mellan funktionerna och it-administrationen är viktigt. Externt samarbete behövs med olika intressegrupper, med användare eller potentiella användare av API, men även på bredare front. Ett gott samarbete ger möjlighet att utöver planera utföranden även dela kunskaper och erfarenheter samt känna igen nya behov och möjligheter. Samarbetsmetoder är till exempel olika samarbetsforum eller utvecklingscommunityn.
IDENTIFIERING OCH HANTERING AV RISKER MED API:N FÖR UPPNÅENDE AV STRATEGISKA MÅL, CYBERSÄKERHETEN OCH ORGANISATIONERNAS SÄKERHET. Riktlinje för hur organisationer inom den offentliga förvaltningen ska beakta olika ris-ker som gäller API:n. Riskerna kan gälla uppnående av strategiska mål, organisationen, omvärlden eller intressegrupper eller så kan de vara cybersäkerhetsrisker. Riskerna bör identifieras och förutseende åtgärder vidtas.
Taktiska riktlinjer
API:N BEAKTAS SOM EN DEL AV HELHETSARKITEKTUREN FÖR ORGANISATIONER INOM DEN OFFENTLIGA FÖRVALTNINGEN. Riktlinje för hur API-utvecklingen ska beaktas inom helhetsarkitekturen för den offent-liga förvaltningen. API:n behandlas som en del av organisationens helhetsarkitektur och beskrivs i tillämpliga delar i organisationens mall för informationshantering. Teknik och standarder som används i utvecklingen och administrationen av API ska utgå från helhetsarkitekturen. Rekommendationen är att nyttja allmänna, öppna och teknikoberoende standarder för att möjliggöra en bredare kompatibilitet.
OM SKAPANDE AV EN ADMINISTRATIONSMALL FÖR UTVECKLIN OCH HANTERING AV API:N. Riktlinje om hur en organisation inom den offentliga förvaltningen ska skapa en administrationsmall för roller, uppgifter och ansvar beträffande API-utveckling, underhåll och hantering. I administrationsmallen ska fastställas bland annat vem som äger API, hur en vägkarta och portfolio för API-utvecklingen ska administreras och hur API-utvecklingen, underhållet och administrationen ska organiseras. För administrationsmallen skaffas de resurser och kunskaper som behövs och de organisationsstrukturer som behövs bildas.
API SKAPAS ENDAST FÖR EXISTERANDE BEHOV. Riktlinje om hur API-användare, potentiella användare och övriga intressegrupper samt det värde som API genererar ska kännas igen före API-utveckling inleds. API:n skapas behovsorienterat; API:n ska generera värde för leverantören, användaren eller en potentiell användare, annars används den inte och det finns ingen grund för att ta fram API. Vid behovsanalysen identifieras funktionella och icke-funktionella krav, inklusiv och intressegruppernas processer och verksamhet med beaktande av kostnadspåföljderna.
API:N ÄR SÖKBARA OCH ÅTERANVÄNDBARA. Riktlinje om sökbarheten och återanvändbarheten gällande publicerade API:n. Sökbarheten säkerställs genom att publicera API i en publiceringskanal i enlighet med användningsändamålet och informationsinnehållet. Återanvändbarheten ska beaktas under hela API:s livscykel, från behovsanalysen till underhållsfasen. Samma API ska kunna nyttjas inom organisationen och externt i enlighet med eventuella behov och informationsklassificeringar. Primärt ska befintliga API:n nyttjas innan nya skapas.
RISKERNA MED API:N IDENTIFIERAS OCH HANTERAS. Riktlinje om hur hot som gäller API ska kännas igen och bedömas samt fastställas hanteringsmetoder för risker redan i den första planeringsfasen för API. I riskhanteringsmetoden bestäms grunderna för hur användare får tillgång till information eller funktioner som tillhandahålls via API. Riskerna med API ska bedömas och följas upp under hela API:s livscykel. Informationsadministrationsenheten inom en organisation för offentlig förvaltning ansvarar för hanteringen av risker i informationsmaterial som behandlas av API.
FÖR MÄTNING AV API:N FASTSTÄLLS MÄTARE SOM FÖLJS. Riktlinje om hur mätare för API ska fastställas, med vilka till exempel API:s användning, nyttighet och servicenivå kan mätas och följas upp. Mätarna ska beakta även nöjdheten hos API-användare. Bland användare kan regelbundet eller kontinuerligt insamlas respons som nyttjas i utvecklingen av API.
Operativa riktlinjer
API UTVECKLAS I ENLIGHET MED DE UPPSTÄLLDA MÅLEN OCH KRAVEN OCH UTVECKLINGEN ADMINISTRERAS. Riktlinje om hur planeringsfasen av API ska beakta de mål och krav som ställs på API och hur utvecklingen ska prioriteras och administreras. Målen dokumenteras och i dem beaktas intressegruppernas behov. Kraven inkluderar krav som gäller funktionerna och krav som inte gäller funktionerna såsom lagstadgade krav. API-utvecklingen fortsätter och prioriteras till exempel med en arbetskö (backlog).
API:N TESTAS FÖRE PUBLICERING. Riktlinje om hur de API:n som publiceras av organisationer inom den offentliga förvaltningen ska testas och konstateras fungera innan de publiceras. I testningen ska beaktas testningen av krav som gäller funktionerna och krav som inte gäller funktionerna samt regressionstestning. Testning utförs under hela API.s livscykel. Testning av API:s användare ska möjliggöras. API:s användare ska testa API innan beslut fattas om att använda API. För testningen ska tillhandahållas testdata och testningen ska vara gratis, fastän API annars kostar att använda.
API:N SKA DOKUMENTERAS OCH PUBLICERAS PÅ ETT ENHETLIGT SÄTT. Riktlinje om hur de API:n som utvecklas i en organisation inom den offentliga förvaltningen ska dokumenteras och publiceras i enlighet med gemensamma principer. Dokumentationen ska innehålla bland annat en beskrivning av API:s funktioner och teknik, licensmodeller för information och gränssnitt, testningsmöjligheter, versionspraxis, servicenivå samt kontaktuppgifter till den organisation som är administratör och anvisningar för driftsättning av API. Metadata fastställs enligt en gemensamma metadatamall. För publiceringen av API specificeras gemensamma handlingssätt, där publiceringen och kommunikationen gällande olika slags API beaktas (intern API, partner-API, offentlig API) beaktas. För att säkerställa sökbarheten oavsett typ av API, rekommenderas att publicera en API-katalog med dokumentation om API och eventuell källkod med beaktande av informationsklassificeringen.
INFORMATION SOM BEHANDLAS I API ÄR KLASSIFICERAD, SÄKRAD OCH BESKRIVEN. Riktlinje om hur information som behandlas i API ska kännas igen och beskrivas med betraktande av den semantiska förenligheten. I datamodelleringen nyttjas Interoperatibilitetsplattformens gemensamma och allmänna datamodeller. Informationen och funktionerna har klassificerats och ska behandlas i enlighet med klassificeringen. Kontroller i enlighet med klassificeringen genomförs. Kontrollerna täcker kryptering av informationen och informationsöverföringen samt API-användarnas autentisering, auktorisering samt spårbarheten i verksamheten.
ANVÄNDNINGEN AV API FÖLJS UPP. Riktlinje om hur loggdata insamlas för API-användning och hur API-användningen följs upp, i enlighet med uppställda mätare. API-användningen ska kunna följas åtminstone till antalet kallelser till API per avsändare, behandlingstider samt antalet behandlingar som lyckats eller misslyckats.