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
Digital Mail Sender
Levererar digital post och digitala fakturor till invånarnas digitala brevlådor, till exempel Kivra och Min myndighetspost.
KommunikationDigitalRegisteredLetter
Skickar digitala rekommenderade brev till invånare via Kivra och följer upp signering, leveransstatus och kvitton.
KommunikationEmailReader
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.
KommunikationEmailSender
Skickar e-post åt kommunens applikationer, via SMTP eller Microsoft Graph beroende på hur respektive kommun är konfigurerad.
KommunikationMessageExchange
Lagringstjänst för interna konversationer – trådade meddelanden med bilagor, lässtatus och sekvensnummer som andra system kan bygga meddelandefunktioner ovanpå.
KommunikationMessaging
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.
KommunikationMessagingSettings
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.
KommunikationNotifier
Skickar notifieringar via sms och Microsoft Teams till kommunens medarbetare, per organisation eller manuellt skapade grupper.
KommunikationPostportalservice
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.
KommunikationRemindAndInform
Registrerar påminnelser kopplade till ärenden och skickar ut dem automatiskt vid önskad tidpunkt via kommunens meddelandetjänst.
KommunikationSmsSender
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.
KommunikationSnailMailSender
Samlar ihop fysiska brevförsändelser i batchar och lämnar över dem till tryck- och kuverteringsleverantör via filöverföring.
KommunikationWebMessageCollector
Samlar in inkommande webbmeddelanden från kommunens e-tjänsteplattform och gör dem tillgängliga för verksamhetssystem som hanterar ärendena.
Ärendehantering
BusinessRules
Regelmotor som utvärderar verksamhetsregler – i dag för parkeringstillstånd för rörelsehindrade – och ger ärendehandläggningen ett maskinellt beslutsunderlag.
ÄrendehanteringCareManagement
Ärendehantering för omsorgsverksamheten – lagrar ärenden med intressenter, parametrar, bilagor och beslut och driver dem framåt genom BPMN-processer i processmotorn Operaton.
ÄrendehanteringCaseData
Ä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.
ÄrendehanteringCaseStatus
Samlar ärendestatus från flera bakomliggande system och ger invånare och företag en aktuell bild av var deras ärenden befinner sig.
ÄrendehanteringChecklist
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.
ÄrendehanteringContracts
Hanterar kommunens avtal om mark och nyttjanderätter – arrenden, köpeavtal och andra upplåtelser – med parter, villkor, bilagor och automatisk förlängning.
ÄrendehanteringNotes
Gemensam anteckningstjänst som lagrar anteckningar kopplade till parter eller ärenden, med full revisionshistorik för varje ändring.
ÄrendehanteringSupportCenter
API för att skapa och uppdatera ärenden och tillgångar (assets) i IT-servicedesksystemet POB, med enhetlig statushantering ovanpå POB:s eget API.
ÄrendehanteringSupportManagement
Ärendehanterings-API för supportärenden – skapar, uppdaterar och följer upp ärenden med kommunikation, revisioner och notifieringar åt kommunens kontaktcenter och verksamhetssystem.
Ekonomi och fakturering
Billing Data Collector
Samlar in faktureringsunderlag från e-tjänsteformulär och avtal, omvandlar dem till fakturaposter och skickar dem vidare till Billing Preprocessor.
Ekonomi och faktureringBilling Preprocessor
Samlar in och lagrar fakturaunderlag från kommunens verksamhetssystem och genererar fakturafiler som förs över till ekonomisystemet Raindance.
Ekonomi och faktureringInvoiceCache
Cachar fakturainformation från ekonomisystemet Raindance i en lokal databas och tillhandahåller sökbara fakturauppgifter och faktura-PDF:er för kommunens applikationer.
Ekonomi och faktureringInvoices
Samlad ingång för fakturauppgifter – hämtar kommersiella fakturor och offentliga förvaltningsfakturor från underliggande källor och levererar dem i ett gemensamt format.
Ekonomi och faktureringInvoiceSender
Hämtar fakturabatchar från ekonomisystemet Raindance och levererar fakturorna digitalt till invånarnas digitala brevlådor via Kivra.
Ekonomi och faktureringSeabLoader
Tar emot fakturor från Sundsvall Energi (SEAB) i XML-format, sätter ihop faktura-PDF:er och läser in dem i InvoiceCache.
Dokument och arkiv
Archive
Tar emot arkivförfrågningar från bygglovssystemet ByggR och lämnar över handlingarna till kommunens långtidsarkiv Formpipe LTA.
Dokument och arkivByggR Archiver
Batchtjänst som hämtar avslutade bygglovsärenden ur ByggR och arkiverar deras handlingar i kommunens långtidsarkiv.
Dokument och arkivDocument
Central dokumenttjänst där kommunens applikationer lagrar, versionerar och söker dokument med tillhörande filer och metadata.
Dokument och arkivESigning
Gemensam ingång för elektronisk signering av dokument – startar, följer upp och avbryter signeringsärenden hos den signeringsleverantör som är konfigurerad för kommunen.
Dokument och arkivMemories
Sök- och hämttjänst för Sundsvallsminnens digitala arkiv – filmer, fotografier, ljudinspelningar, texter och publikationer.
Dokument och arkivTemplating
Mallbaserad dokumentgenerering – lagrar versionshanterade mallar och renderar dem till HTML eller PDF åt kommunens applikationer.
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.
Parts- och kunddataContactSettings
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.
Parts- och kunddataCustomer
Slår upp kundrelationer och kunduppgifter hos kommunkoncernens leverantörer – till exempel el- och fjärrvärmebolagen – utifrån en parts identitet.
Parts- och kunddataDataWarehouseReader
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.
Parts- och kunddataInstallation
Uppslag av anläggningar (installationer) hos kommunens leverantörsbolag – till exempel el- och fjärrvärmeanläggningar – ur kommunens datalager.
Parts- och kunddataInstalledBase
Visar en parts engagemang och anläggningar (installerad bas) hos kommunens leverantörsbolag, och hanterar delegering av anläggningar mellan parter.
Parts- och kunddataManagerResponsibility
Läsande API som svarar på vilka organisationer en chef ansvarar för – och vem som är chef för en viss organisation.
Parts- och kunddataMyRepresentative
Registrerar och håller ordning på fullmakter (mandat) mellan parter, så att kommunens tjänster vet vem som får företräda vem.
Parts- och kunddataParty
Översätter mellan person-/organisationsnummer (legalId) och kommunens interna part-id (partyId) för privatpersoner och företag.
Parts- och kunddataPartyAssets
Register över tillstånd och andra tillgångar som en part – invånare eller företag – har hos kommunen, till exempel parkeringstillstånd.
AI-tjänster
AI Data Collector
Samlar in innehåll från Confluence och håller det synkroniserat som kunskapsunderlag i AI-plattformen Eneo, så att kommunens AI-assistenter alltid svarar utifrån aktuell dokumentation.
AI-tjänsterAiFlow
Kör konfigurerbara AI-flöden i flera steg – till exempel tjänsteskrivelser, bildtolkning och transkribering – där varje steg utförs av en assistent på AI-plattformen Eneo.
AI-tjänsterSelfServiceAi
Driver en AI-assistent för kundservice i självbetjäningskanaler – assistenten laddas med kundens avtal, fakturor och mätvärden och kan sedan svara på frågor om kundens engagemang.
Integration
AccessMapper
Översätter en medarbetares Active Directory-grupper till behörigheter i kommunens interna system, utifrån konfigurerbara åtkomstgrupper.
IntegrationByggrIntegrator
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.
IntegrationCaseManagement
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.
IntegrationCsvFileReader
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.
IntegrationDataCatalog
Aggregerar kommunens öppna data-metadata till en samlad DCAT-AP-SE-katalog som skördas av Sveriges Dataportal.
IntegrationEventlog
Gemensam händelselogg där kommunens applikationer registrerar och läser händelser kopplade till en resurs, till exempel historiken för ett ärende.
IntegrationFinancial 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.
IntegrationIncidentMapper
Synkroniserar supportärenden dubbelriktat mellan servicedesksystemet POB och utvecklingsteamens Jira, så att status och kommentarer hålls i takt i båda systemen.
IntegrationJsonSchema
Central lagring av versionshanterade JSON-scheman med validering av JSON-data mot schemana – för applikationer som behöver enhetliga datakontrakt.
IntegrationLifecareIntegrator
Läser och skapar socialtjänstinformation i verksamhetssystemet Lifecare – beslut, utredningar, verkställigheter, aktualiseringar och beräkningar – för kommunens applikationer.
IntegrationOepIntegrator
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.
IntegrationOperaton
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.
IntegrationPermitLoader
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.
IntegrationQuotationRequest
Skapar offertförfrågningar som helpdeskärenden i Sundsvall Energis Lime CRM och exponerar tillhörande metadata om kategorier och kontor.
IntegrationRelations
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.
IntegrationSmLoader
Bakgrundstjänst som hämtar inskickade ärenden från e-tjänsteplattformen Open ePlatform och skapar dem som supportärenden i SupportManagement.
Samhällsservice
Alkt
Läs-API mot verksamhetssystemet AlkT som ger tillståndshavare, deras serveringsställen och pågående ärenden om alkoholtillstånd.
SamhällsserviceBusinessInformation
Uppgifter om livsmedelsanläggningar – anläggningsdetaljer, livsmedelsverksamhet och faktureringsuppgifter – hämtade direkt ur miljösystemet Ecos.
SamhällsserviceDisturbance
Hanterar driftstörningar i kommunal infrastruktur – el, fjärrvärme, vatten, fibernät med mera – och notifierar automatiskt berörda kunder via sms och e-post.
SamhällsserviceGarbage
Tillhandahåller uppgifter om när avfallshämtning sker på en viss adress eller inom ett område – för e-tjänster och applikationer som vill visa hämtschema för invånare.
SamhällsserviceIncident
Tar emot felanmälningar från invånare, lagrar dem och skickar dem vidare till rätt mottagare – ett externt system för livbojsärenden eller e-post till kundtjänst och MSVA.
SamhällsserviceMeasurementData
Hämtar förbrukningsmätvärden – fjärrvärme, fjärrkyla, el, bredband och avfall – per kund och anläggning ur Stadsbackens datalager.
SamhällsservicePrivatePreCheck
Förkontroll för privatpersoner: svarar på om en person är folkbokförd i kommunen och vilka tillstånd personen redan har – till exempel innan en ansökan om parkeringstillstånd påbörjas.
Utbildning
CitizenChanges
Batchtjänst som bevakar flyttar och skickar påminnelser kopplade till ansökningar om skolskjuts, elevresor och förskoleplats.
UtbildningEducationData
Samlar in nationell utbildningsdata från Skolverkets SUSA-navet och Planned Educations-API och lagrar den lokalt som grund för kommunens utbildningstjänster.
UtbildningEducationFinder
Sök- och statistik-API för kommunens vuxenutbildningsutbud – kurser kan filtreras på kategori, nivå, studieort med mera och sammanställas till statistik.
Utvecklingsverktyg
Configuration
Enkel lagringstjänst för applikationskonfiguration – ger kommunens webbapplikationer ett standardiserat sätt att spara och hämta inställningar som nyckel-värdepar.
Utvecklingsverktyg VerktygSimulatorServer
Testverktyg som simulerar API-svar med valfri statuskod, svarskropp och fördröjning – för att testa hur anropande system hanterar fel och långsamma svar.
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.