Dessa API:er används av externa system för att hämta data från plattformen. De flesta av dessa är REST-baserade och kräver normalt åtkomst via VPN-tunnel.

• API för ärendelistor, ärenden och händelser

Används för att hämta listor på ärenden, enskilda ärenden i XML- eller PDF-format, samt för att följa händelseförlopp (events) i ett ärende.

• Statistik-API

Hämtar anonymiserad statistik om användningen av e-tjänster (t.ex. ålder, kön, påbörjade/avbrutna steg). Detta API kräver som undantag inte VPN-anslutning.

• API för generell information om e-tjänster

Används för att hämta listor på publicerade e-tjänster, kategorier och för att söka efter tjänster. Det är ofta publikt och kräver ingen autentisering.

• API för meddelanden och interna noteringar

Hämtar konversationer mellan handläggare och sökande, samt handläggarens interna anteckningar och tillhörande bilagor.

• API för bokningsfunktionen

Gör det möjligt att hämta information om kalendrar, lediga bokningstillfällen och befintliga bokningar. Det kan även användas för att visa bokningar i externa system som Outlook.

• API för köer och köplatser

Hämtar information om tillgängliga köer och aktiva eller arkiverade köplatser.

• API för användarundersökning

Hämtar resultat och kommentarer från de enkäter som medborgare fyller i efter att ha skickat in ett ärende.

• API för aktivitetsgrupper

Används specifikt för att hämta ut PDF-kvittenser för avklarade aktivitetsrundor i ärenden som använder aktivitetsgrupper.

• API för driftmeddelanden

Tillåter externa system att skapa, uppdatera eller ta bort driftmeddelanden som visas i plattformen.

• API för färgmarkeringar

Används för att läsa av eller sätta färgmarkeringar på ärenden för att underlätta sortering.

• API för gallrade ärenden

Ger information om vilka ärenden som har tagits bort från plattformen.

Vårt API för återkoppling (Integration Callback API) låter externa system skriva data tillbaka till plattformen. Det används ofta när handläggningen sker i ett annat verksamhetssystem. Funktioner inkluderar:

• Byte av status på ärenden
• Skicka meddelanden till sökande
• Lägga till händelser i historiken
• Tilldela handläggare
• Sätta attribut på ärenden.

Dessa "API-källor" som vi kallar dem kan används under tiden en användare fyller i en e-tjänst för att hämta data "just-in-time" från externa källor:

• Förifyllnad
  Hämta uppgifter till textfält eller hämta listor till rullistor/radioknappar (t.ex. en lista på skolor).

• Kartgeometrier
  Lägga ut specifika områden eller symboler i en kartfråga baserat på extern data.

• Val av barn
  Hämta utökad information om barn (utöver data som hämtas från Skatteverkets Navet).

• Viktning
  Dynamiskt hämta värden som påverkar e-tjänstens logik och vilka följdfrågor som visas.

För att hantera användare och vissa systematiska delar i plattformen finns dessa API:er:

• API för interna användare

Används för att hämta information om personalkonton, exempelvis baserat på personnummer eller användarnamn.

• API för grupper

Hanterar användargrupper; man kan skapa grupper, ta bort dem eller hantera medlemskap.

• API för användarimport

Gör det möjligt för organisationen att skicka XML-filer för att automatiskt skapa och uppdatera personalkonton i plattformen (provisionering).

• API för reservationer

Hanterar tillfälliga reservationer av objekt, vilket i nuläget främst används i koppling till kartfrågor.

Detta API är inte standard utan måste beställas separat. Det används för att administrera handläggarbehörigheter på e-tjänstenivå (inte enskilda ärenden) samt för att hämta ändringsloggar för själva e-tjänstbygget.