User API

Uppdaterad 3/4/20 av Johannes Nordman

User API

Vi har öppnat upp delar av vårt användar API för externa partners och kunder att integrera med, följande data finns nu tillgänglig:

Öppen data:

  • Skift data, den anställdes 20 kommande skift. Dom kommande 20 öppna skiften. Period: inget utöver den publicerade tidsperioden. Info: Anställdes namn, från och till tid, datum, skifttypens namn, enhetsnamn, rast från och till tid.
  • Frånvaroansökningar - alla historiska frånvaroansökningar och kommande. Info: Frånvaroorsakens namn, anställdes namn, från tid och datum - till tid och datum.

Tidszon: ingen utveckling gällande tidszoner. Data om tidszon kan ges via enhetens tidszon.

Teknisk beskrivning:

Användar APIet kommer att exponeras på följande URLer: user-api-rc.quinyx.com och user-api.quinyx.com Den ena speglar testmiljön RC och den andra vår produktionsmiljö.

Vår nuvarande API verison är v2 så alla routes kommer ha v2 prefix framför dem. Swagger dokumentationen är tillgänglig och kan nås här: user-api-rc.quinyx.com/v2/docs och user-api.quinyx.com/v2/docs.We currently have 3 endpoints in the User API:

POST /oauth/token

This will be used to get access token (which is used to access other endpoints that are secured) and refresh token (which is used to generate new access tokens). Default life time for the access token is 15 minutes, and for the refresh token is 30 days.

To get tokens using employee login credentials grantType needs to be set to password and sent together with the username and password. Content-Type header should be set to application/json and request body can look like this:

{"grantType": "password","username": "empployeeEmailInTheQuinyxApp","password": "empployeePasswordInTheQuinyxApp"}

To get new tokens using existing refresh token grantType needs to be set to refresh_token and sent together with the refreshToken. Refresh token can be used only once so it must be replaced by newly received refresh token. Content-Type header should be set to application/json and request body can look like this:

{"grantType": "refresh_token","refreshToken": "receivedRefreshToken"}

Received access token obtained above should be passed with each call - this should be done in the form of request header, such as: header 'Authorization: Bearer <token>'.

GET /users/leave-applications

This endpoint will return all upcoming leave applications, starting from today, or historical applications, ending today or earlier. To show upcoming leave applications filter parameter in query string should be set to upcoming (?filter=upcoming), and to show historical leave applications filter parameter in query string should be set to historical (?filter=historical).

GET /users/shifts

This endpoint will return employee upcoming or unassigned shifts. Number of shifts in the response is limited to 20 shifts, and search will be performed only in published period, up to 90 days in the future. To show upcoming shifts filter parameter in query string should be set to upcoming (?filter=upcoming), and to show unassigned shifts filter parameter in query string should be set to unassigned (?


Fick du hjälp?