Rest API - Admin

Vad är API OCH REST API?

API står för “Application Programming Interface” och är ett verktyg som gör det möjligt för olika program att kommunicera med varandra på ett enkelt sätt.

Ett API består av byggstenar, så kallade endpoints, som tillsammans gör det möjligt att skapa precisa, effektiva och komplexa lösningar som möter ett specifikt behov. Ett API kan enkelt beskrivas som en bro mellan två eller flera program, system eller applikationer.

API:er dyker upp i alla möjliga sammanhang. När du exempelvis skriver ut ett dokument så är det ett API på din dator som pratar med ett API på skrivaren. Ett annat exempel är när en tidrapport hämtas in och används som löneunderlag.

REST (REpresentational State Transfer) och är ett flexibelt API som kan hantera flera typer av anrop och format. Ett av de vanligaste formaten är XML, som HR+ stödjer. REST API inte ett protokoll, det är en arkitekturstil och den mest populära arkitekturen för att utveckla API: er och de är enklare att implementera, förstå och felsöka vilket gör det möjligt att bygga lösningar som möter många olika behov. REST är statuslös, ingen data eller status lagras mellan anropen.

Via Rest API i rutinen Admin så kan externa applikationer integreras med HR+. Det kan bland annat användas i de fall det finns andra försystem än HR+ och/eller behöver läsa av viss data. 

Notera! För att komma igång med kommunikation via API krävs vissa förutsättningar i HR+. 

Det måste finnas en användare som tillåts hantera API, vilken sätts upp under Admin/Användare/Administrera användare via Rest API samt en roll med särskild behörighet under Admin/Inställningar/Roller/ samt Administrera användarroller via Rest API.
Rollen måste kompletteras varje gång en nytillkommen endpoint finns.

Vid inläsning av anställningar och ändringar måste konfiguration göras under Inställningar/Händelsetyper för hur dessa ska bete sig i systemet.

De API:er (endpoints) som HR+ stödjer är:

  • Employment
    API:et gör det möjligt att registrera, uppdatera och ta bort anställningar.
  • Course/Handle course
    API:et gör det möjligt att registrera och uppdatera genomförda utbildningar. Dessa blir tillgängliga i rutinen Utbildning. 
    Fälten IsRepeating och RepeatInterval kan användas vid insert och update Det finns även möjlighet att ändra EndDate till tomt värde.
  • Document
    API:et gör det möjligt att registrera och uppdatera dokument. Dessa blir tillgängliga under Anställningsdokument.
  • Workplace
    API:et gör det möjligt att registrera och uppdatera arbetsställen.
  • User
    API:et gör det möjligt att uppdatera användarnamn och/eller e-post.
  • UserRole
    API:et gör det möjligt att registrera, uppdatera och ta bort roller från en användare.
  • UserRoleGroup
    API:et gör det möjligt att registrera, uppdatera och ta bort behörigheten från organisationsstrukturen på en användare.

Tekniska dokument

Du hittar tekniska dokument på Communityn som innehåller en funktionell beskrivning av API. 
Hämta dokumentet via länken: Hämta dokument/hämta fil - Teknisk information / API

Swagger 

Swagger är ett API-beskrivningsformat som kan läsas av både människor och maskiner. Swagger är webbaserad, automatgenererad dokumentation. Det går även att testa API:er från swagger webbsidan. 

Swagger är den huvudsakliga detaljdokumentationen för HR+ API:er Här finns den detaljerade informationen om slutpunkter och definition av in / ut-meddelanden. Swagger är bara aktiverat i stagemiljöerna. Visma tillhandahåller swagger.json-filer om det skulle efterfrågas.

Swagger finns för varje API på url:
https://{APIurl}/swagger

För mer info om swagger se:
https://swagger.io/

API Integration - rapporteringsställe

Ett rapporteringsställe som inte är med i någon aktiv generation ligger under det virtuella rapporteringsstället [inactive] och har både start- och slutdatum satt till 1901-01-01. Detta påverkar endast kunder som har hantering av organisationsgenerationer påslaget.

Fältet Responsible på rapporteringsställen för en anställd inkluderas när publiceringen av anställningsmeddelande på gamla masterdata-exporten triggas från klienten.

Relaterad hjälp