Authentication

» You'll need to register for an application key first.

Virtually all modules in our API require authentication for access. Authentication exchanges a username & password in exchange for a token to be used on all subsequent requests. Your first call for Authentication MUST include the following details:

• key
• username
• password

On success the API will return status=1 as well as the token, and the employee profile and business details in the data field so you can use those immediately in your application. Here is an example of this exchange:

{
  "key": "YOUR_API_KEY",
  "request": {
    "module": "staff.login",
    "method": "GET",
    "username": "ryan@shiftplanning.com",
    "password": "nicetry"
  }
}

{
  "success": "1",
  "data": {
    "employee": {
      "name": "Ryan Fyfe",
      "email": "ryan@shiftplanning.com",
      "etc": "..."
    },
    "business": {
      "name": "ShiftPlanning Inc.",
      "etc": "..."
    }
  },
  "token": "xxxxxxx"
}

Upon completion of succesful login subsequent calls to the API require only the token for authentication; There is no need to pass the key, etc every time - Just the token.