Api doc


SDK's


Api Modules

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 - From application Admin tab >> Data API
  • username - Shitfplanning username
  • password - Shiftplanning 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:

Request:
  1. {
  2. "key": "YOUR_API_KEY",
  3. "request": {
  4. "module": "staff.login",
  5. "method": "GET",
  6. "username": "ryan@shiftplanning.com",
  7. "password": "nicetry"
  8. }
  9. }
Response: (assuming succesful login)
  1. {
  2. "success": "1",
  3. "data": {
  4. "employee": {
  5. "name": "Ryan Fyfe",
  6. "email": "ryan@shiftplanning.com",
  7. "etc": "..."
  8. },
  9. "business": {
  10. "name": "ShiftPlanning Inc.",
  11. "etc": "..."
  12. }
  13. },
  14. "token": "xxxxxxx"
  15. }

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.

GET STARTED NOW

Free Trial. No Credit Card Required.

close
(e.g.+14158675309 or +1415-8675-309)

By clicking "Create my ShiftPlanning Account" you agree to the Terms of Service and Privacy Policy.

Have a promotional code?Click Here


LIVE CHAT DEMO REQUEST!

Please provide information below.

close
INSTANT DEMOSCHEDULED DEMO
Connect with a ShiftPlanning Team Member for a live demo right now!
 

RESELLER REQUEST!

Please provide information below.

close