Sundsvalls kommun

En katalog över kommunens API:er

Sundsvalls kommun bygger sina digitala tjänster på en gemensam plattform av mikrotjänster. Här hittar du en samlad översikt över de API:er som körs i produktion på kommunens API-plattform, med interaktiv API-dokumentation via Swagger UI.

Vad innehåller katalogen?

Det här är Sundsvalls kommuns API-katalog: en samlad förteckning över de API:er som just nu körs skarpt i produktion på kommunens gemensamma API-plattform. Varje API listas under det namn och med den version som det exponeras med på plattformen.

Varje API presenteras på en egen sida med två delar: en verksamhetsnära beskrivning av vad API:et gör och vilken nytta det skapar, samt en teknisk dokumentation för dig som vill förstå hur tjänsten är byggd eller vill återanvända den i din egen organisation. Dessutom kan varje API:s samtliga resurser och datamodeller utforskas interaktivt i Swagger UI, direkt ur tjänstens OpenAPI-specifikation.

Kommunen arbetar enligt principen öppen källkod först, och många av API:erna delas därför på GitHub där de kan användas, granskas och vidareutvecklas av andra kommuner och organisationer. Katalogen omfattar dock även API:er vars lösningar inte publiceras som öppen källkod.

API:er i katalogen

Katalogen omfattar de API:er som körs i produktion på kommunens gemensamma API-plattform, grupperade per område. Välj ett API för att läsa mer och utforska dess dokumentation.

Kommunikation

Kommunikation

Digital Mail Sender

Levererar digital post och digitala fakturor till invånarnas digitala brevlådor, till exempel Kivra och Min myndighetspost.

Läs mer →
Kommunikation

DigitalRegisteredLetter

Skickar digitala rekommenderade brev till invånare via Kivra och följer upp signering, leveransstatus och kvitton.

Läs mer →
Kommunikation

EmailReader

Läser av verksamheternas e-postlådor, lagrar inkomna meddelanden och gör dem hämtbara för andra system – med möjlighet att omvandla särskilda mejl till sms.

Läs mer →
Kommunikation

EmailSender

Skickar e-post åt kommunens applikationer, via SMTP eller Microsoft Graph beroende på hur respektive kommun är konfigurerad.

Läs mer →
Kommunikation

MessageExchange

Lagringstjänst för interna konversationer – trådade meddelanden med bilagor, lässtatus och sekvensnummer som andra system kan bygga meddelandefunktioner ovanpå.

Läs mer →
Kommunikation

Messaging

Gemensamt API för att skicka meddelanden till invånare, företag och medarbetare – via sms, e-post, digital brevlåda, webbmeddelanden och fysiska brev.

Läs mer →
Kommunikation

MessagingSettings

Håller verksamheternas inställningar för meddelandeutskick – till exempel avsändaruppgifter och kanalval – per kommun och avdelning, med uppslag utifrån inloggad användare.

Läs mer →
Kommunikation

Notifier

Skickar notifieringar via sms och Microsoft Teams till kommunens medarbetare, per organisation eller manuellt skapade grupper.

Läs mer →
Kommunikation

Postportalservice

Backend för kommunens postportal – handläggare skickar brev, rekommenderade brev, sms och signeringsförfrågningar till invånare och företag, med automatiskt kanalval och uppföljning.

Läs mer →
Kommunikation

RemindAndInform

Registrerar påminnelser kopplade till ärenden och skickar ut dem automatiskt vid önskad tidpunkt via kommunens meddelandetjänst.

Läs mer →
Kommunikation

SmsSender

Skickar sms till invånare och medarbetare via externa sms-gateways, med automatisk växling mellan leverantörer om en av dem inte kan leverera.

Läs mer →
Kommunikation

SnailMailSender

Samlar ihop fysiska brevförsändelser i batchar och lämnar över dem till tryck- och kuverteringsleverantör via filöverföring.

Läs mer →
Kommunikation

WebMessageCollector

Samlar in inkommande webbmeddelanden från kommunens e-tjänsteplattform och gör dem tillgängliga för verksamhetssystem som hanterar ärendena.

Läs mer →

Ärendehantering

Ärendehantering

BusinessRules

Regelmotor som utvärderar verksamhetsregler – i dag för parkeringstillstånd för rörelsehindrade – och ger ärendehandläggningen ett maskinellt beslutsunderlag.

Läs mer →
Ärendehantering

CareManagement

Ärendehantering för omsorgsverksamheten – lagrar ärenden med intressenter, parametrar, bilagor och beslut och driver dem framåt genom BPMN-processer i processmotorn Operaton.

Läs mer →
Ärendehantering

CaseData

Ärendehanterings-API som lagrar och förvaltar myndighetsärenden – bland annat parkeringstillstånd, färdtjänst samt mark- och exploateringsärenden – åt kommunens handläggarapplikationer.

Läs mer →
Ärendehantering

CaseStatus

Samlar ärendestatus från flera bakomliggande system och ger invånare och företag en aktuell bild av var deras ärenden befinner sig.

Läs mer →
Ärendehantering

Checklist

Hanterar introduktionschecklistor för nyanställda – checklistemallar per organisation, automatisk tilldelning när nya medarbetare anställs och uppföljning av hur långt varje introduktion kommit.

Läs mer →
Ärendehantering

Contracts

Hanterar kommunens avtal om mark och nyttjanderätter – arrenden, köpeavtal och andra upplåtelser – med parter, villkor, bilagor och automatisk förlängning.

Läs mer →
Ärendehantering

Notes

Gemensam anteckningstjänst som lagrar anteckningar kopplade till parter eller ärenden, med full revisionshistorik för varje ändring.

Läs mer →
Ärendehantering

SupportCenter

API för att skapa och uppdatera ärenden och tillgångar (assets) i IT-servicedesksystemet POB, med enhetlig statushantering ovanpå POB:s eget API.

Läs mer →
Ärendehantering

SupportManagement

Ärendehanterings-API för supportärenden – skapar, uppdaterar och följer upp ärenden med kommunikation, revisioner och notifieringar åt kommunens kontaktcenter och verksamhetssystem.

Läs mer →

Ekonomi och fakturering

Dokument och arkiv

Parts- och kunddata

Parts- och kunddata

Agreement

Uppslag av en parts avtal med kommunkoncernens leverantörsbolag – el, fjärrvärme, vatten, avfall med mera – kopplade till anläggningar.

Läs mer →
Parts- och kunddata

ContactSettings

Register över invånares och företags valda kontaktvägar – används av kommunens meddelandetjänster för att avgöra hur en mottagare vill bli nådd.

Läs mer →
Parts- och kunddata

Customer

Slår upp kundrelationer och kunduppgifter hos kommunkoncernens leverantörer – till exempel el- och fjärrvärmebolagen – utifrån en parts identitet.

Läs mer →
Parts- och kunddata

DataWarehouseReader

Läs-API mot Stadsbackenkoncernens datalager – kunder, avtal, anläggningar, fakturor och mätvärden för el, fjärrvärme, vatten och andra nyttigheter.

Läs mer →
Parts- och kunddata

Installation

Uppslag av anläggningar (installationer) hos kommunens leverantörsbolag – till exempel el- och fjärrvärmeanläggningar – ur kommunens datalager.

Läs mer →
Parts- och kunddata

InstalledBase

Visar en parts engagemang och anläggningar (installerad bas) hos kommunens leverantörsbolag, och hanterar delegering av anläggningar mellan parter.

Läs mer →
Parts- och kunddata

ManagerResponsibility

Läsande API som svarar på vilka organisationer en chef ansvarar för – och vem som är chef för en viss organisation.

Läs mer →
Parts- och kunddata

MyRepresentative

Registrerar och håller ordning på fullmakter (mandat) mellan parter, så att kommunens tjänster vet vem som får företräda vem.

Läs mer →
Parts- och kunddata

Party

Översätter mellan person-/organisationsnummer (legalId) och kommunens interna part-id (partyId) för privatpersoner och företag.

Läs mer →
Parts- och kunddata

PartyAssets

Register över tillstånd och andra tillgångar som en part – invånare eller företag – har hos kommunen, till exempel parkeringstillstånd.

Läs mer →

AI-tjänster

Integration

Integration

AccessMapper

Översätter en medarbetares Active Directory-grupper till behörigheter i kommunens interna system, utifrån konfigurerbara åtkomstgrupper.

Läs mer →
Integration

ByggrIntegrator

Hämtar byggärenden, grannhöranden och ärendehandlingar ur bygglovssystemet ByggR och gör dem tillgängliga för e-tjänster och andra applikationer.

Läs mer →
Integration

CaseManagement

Integrationslager som tar emot ärenden från e-tjänster och skickar dem vidare till rätt verksamhetssystem – ByggR, Ecos, Alk-T, EDP Future eller CaseData – och ger en samlad statusbild tillbaka.

Läs mer →
Integration

CsvFileReader

Schemalagd tjänst som hämtar CSV-filer med organisations- och medarbetardata via SFTP och läser in dem i en databas som andra tjänster kan använda.

Läs mer →
Integration

DataCatalog

Aggregerar kommunens öppna data-metadata till en samlad DCAT-AP-SE-katalog som skördas av Sveriges Dataportal.

Läs mer →
Integration

Eventlog

Gemensam händelselogg där kommunens applikationer registrerar och läser händelser kopplade till en resurs, till exempel historiken för ett ärende.

Läs mer →
Integration

Financial Aid

Hämtar beslutsunderlag för ekonomiskt bistånd från Försäkringskassans sammansatta bastjänst SSBTEK och levererar det som JSON till socialtjänstens handläggningssystem.

Läs mer →
Integration

IncidentMapper

Synkroniserar supportärenden dubbelriktat mellan servicedesksystemet POB och utvecklingsteamens Jira, så att status och kommentarer hålls i takt i båda systemen.

Läs mer →
Integration

JsonSchema

Central lagring av versionshanterade JSON-scheman med validering av JSON-data mot schemana – för applikationer som behöver enhetliga datakontrakt.

Läs mer →
Integration

LifecareIntegrator

Läser och skapar socialtjänstinformation i verksamhetssystemet Lifecare – beslut, utredningar, verkställigheter, aktualiseringar och beräkningar – för kommunens applikationer.

Läs mer →
Integration

OepIntegrator

Gemensam ingång till kommunens e-tjänsteplattform Open ePlatform – för att hämta ärenden, sätta status och skicka webbmeddelanden till invånarnas sidor.

Läs mer →
Integration

Operaton

Kommunens gemensamma BPMN-processmotor – kör verksamhetsprocesser modellerade i BPMN och DMN och erbjuder en självdokumenterande katalog av färdiga processbyggstenar som skicka e-post, skicka sms och skapa ärende.

Läs mer →
Integration

PermitLoader

Läser in färdtjänst- och riksfärdtjänsttillstånd från en rådataexport ur Procapita och registrerar dem som tillgångar i PartyAssets.

Läs mer →
Integration

QuotationRequest

Skapar offertförfrågningar som helpdeskärenden i Sundsvall Energis Lime CRM och exponerar tillhörande metadata om kategorier och kontor.

Läs mer →
Integration

Relations

Håller reda på relationer mellan objekt i olika verksamhetssystem, till exempel kopplingar mellan ärenden, så att applikationer kan länka samman resurser utan egna kopplingstabeller.

Läs mer →
Integration

SmLoader

Bakgrundstjänst som hämtar inskickade ärenden från e-tjänsteplattformen Open ePlatform och skapar dem som supportärenden i SupportManagement.

Läs mer →

Samhällsservice

Utbildning

Utvecklingsverktyg

Katalogen visar de API:er, och de versioner, som körs skarpt i produktion vid ögonblicket. Avvecklade API:er och prototyper ingår inte. Nya API:er läggs till efter hand som de driftsätts.