Lær hvordan du får tilgang til, autentiserer deg mot og henter data fra Simployer Classic HRConnect API.

HRConnect API er et REST-API som gjør det mulig å hente ut kjernedata fra Simployer HRM. Du kan bruke API-et med tredjepartsverktøy som Excel og Power BI eller konsumere det direkte fra egne systemer.

For veiledning om autentisering, se artikkelen om SimplAuth.

Kom i gang med Simployer Classic HRConnect API

1. Bli autorisert med et SimplAuth-token. Dette gjør du ved å opprette din egen klient i Simployer Admin Center. Se artikkelen om SimplAuth for fremgangsmåten.
2. Hvis du vil koble HRConnect API til et tredjepartsverktøy som Excel eller Power BI, kan du se artikkelen «How to connect to HRConnect API through Power Query».
3. Du finner HRConnect API på https://hrconnect.simployer.com/index.html.

Autentiser deg mot Simployer Classic HRConnect API i Swagger

I Swagger klikker du på Authorize og limer inn JWT-tokenet ditt.

Bruk endepunktene i Simployer Classic HRConnect API

Den nåværende versjonen av HRConnect API støtter eksport av data gjennom GET-operasjoner. De fleste entiteter har følgende endepunktstruktur:

• Hent alle entiteter, for eksempel alle e-postadresser
• Hent entiteter som er knyttet til en angitt entitet, for eksempel alle e-postadresser som er knyttet til person B
• Hent én entitet ved hjelp av en angitt identifikator
• Hent alle entiteter av en angitt type, for eksempel alle primære e-postadresser

Bruk paginering i Simployer Classic HRConnect API

HRConnect API har paginering for endepunkter som henter alle entiteter. Med paginering kan du hente data i separate sider. Send pagineringsparametrene som query-parametre.

Standardverdiene er side 1 og en sidestørrelse på 100 poster. Endepunkter som støtter paginering, returnerer responsheadere med informasjon som totalt antall poster og om det finnes en neste side.

Eksempel på pagineringsheadere i responsen:

x-has-next-page: True x-page: 1 x-page-size: 100 x-total-count: 1034 x-total-pages: 11