En man sitter på ett tåg och tittar drömmande ut genom fönstret. En dator står på bordet.

REST API-profil ökar kvaliteten på API:er

REST API-profilen är framtagen för att ge offentliga aktörer bättre förutsättningar att på ett effektivt sätt dela och använda data genom API:er.

API:er är centrala för att offentliga aktörer ska kunna dela och använda data. Profilen som nu tagits fram gör det möjligt för myndigheter, kommuner och regioner att ta fram API:er på ett effektivare sätt. Detta eftersom de kan utgå ifrån utifrån bästa praxis och krav som tydligt beskriver vad som ska, kan och bör göras. Ett exempel är i kategorin versionshantering där det går att läsa om hur API:erna ska designas för att bli bakåtkompatibla. Att använda profilen bidrar till en högre standard och kvalitet på API:erna, både på dokumentationen och själva API:et. Den gemensamma profilen förenklar även för både producenter och konsumenter av data.

REST API-profilen fokuserar främst på externt informationsutbyte där förmågan hos offentliga aktörers system att fungera tillsammans och kunna kommunicera med varandra behöver förbättras. Profilen kan även användas internt för att dela och använda data inom en organisation.

Bakgrund

REST API-profilen är framtagen i samverkan mellan DIGG, Bolagsverket, Arbetsförmedlingen, Lantmäteriet och E-hälsomyndigheten som en rekommendation till offentliga aktörer.

Den REST API-profil som nu lanseras har uppdaterats efter de synpunkter som kom in under en remissrunda. Sammanlagt kom det in mellan 500 och 1000 kommentarer från ett 70-tal aktörer. Detta har bidragit till att kvalitén på profilen har höjts.

Lär dig mer

REST API-profil (dev.dataportal.se)