REST API-profil

För att den offentliga sektorn ska kunna bidra till utvecklingen av en förvaltningsgemensam digital infrastruktur som främjar innovation och bred samhällsnytta genom bättre förutsättningar för en effektiv datadelning och dataanvändning, är utvecklingen av API:er en central fråga. Här presenteras hur man gör detta utifrån en rekommenderad REST API-profil för offentliga aktörer. Profilen är en förvaltningsgemensam specifikation för REST API:er.

REST API-profilen är framtagen i samverkan mellan Myndigheten för digital förvaltning, Bolagsverket, Arbetsförmedlingen, Lantmäteriet och E-hälsomyndigheten som en rekommendation till offentliga organisationer. Profilen gör det möjligt att bygga REST API:er på ett effektivare sätt utifrån bästa praxis och en uppsättning identifierade SKALL/BÖR/KAN kravformuleringar. Denna gemensamma profil förenklar processen för både konsumenter och producenter av REST API:er, vilket påskyndar acceptans för och användning av API.

Om man väljer att följa den rekommenderade REST API-profilen är det viktigt att följa de SKALL/BÖR/KAN krav som specificeras för att det utvecklade API:et ska kunna anses följa profilen.

Här nedan beskrivs den första versionen av rekommendationerna för den nationella REST API-profilen. Rekommendationerna kommer att uppdateras över tid och andra profiler kan komma att tas fram för fler typer av maskinläsbara gränssnitt.