Let's build something together!

-1.2.Authentication techniques

Authentication can be achieved in one of two ways.

1. By passing an API key with each request, or;
2. By passing a OAuth 2.0 token.

-1.3.HTTP methods

Findmyshift's API accepts either GET or POST requests for all methods. You don't need to choose one or the other, you can mix and match as you like. When using GET requests you'll naturally need to encode all of your parameters in the query string. When using POST requests you can send your parameters as form values, or you can post a JSON object with each of the parameters as properties.

-1.4.Rate limiting

We do enforce rate limiting, so be prepared to handle response codes of 429 appropriately. If requests continue to abuse the limits imposed we may temporarily disable the application/API key being used. Please be aware that some requests take longer than others, so you should always wait for requests to finish before starting another. Our API will only allow one concurrent request at a time per application/API key.

-2.2.Set up your applications

If you're using OAuth 2.0, you'll need to tell us a bit about your application so we can allocate your Client ID and Client Secret (both of which are required to authenticate with OAuth 2.0).

-2.3.Add some test data

If you've registered an account you can add in a pre-populated test team for testing purposes.

-3.2.Using OAuth 2.0

If you're using OAuth 2.0 as your authentication method, you're going to need to that Client ID and Client Secret you set up earlier. If you haven't done it already, you'll need to set up an account and define your application. Once you've done that we'll give you a Client ID and Client Secret you'll need for authenticating users via OAuth 2.0.
Assuming you've got your Client ID and Client Secret stored safely, let's take a look at the URI's you'll need to plug in to your application:

-4.2.Facilities: Get

-4.3.Staff: List

-4.4.Staff: Get

-4.5.Staff: Update

-4.6.Teams: List

-4.7.Teams: Get

-4.8.Teams: Last modified

-4.9.Time clock: Clock in

-4.10.Time clock: Clock out

-4.11.Time clock: Clock out all

-4.12.Time clock: Import

-4.13.Time clock: Status

-4.14.Time off: List

-4.15.Time off: Get

-4.16.Time off: Approve

-4.17.Time off: Delete

-4.18.Time off: Unapprove

-4.19.Reports: Budget

-4.20.Reports: Hours

-4.21.Reports: Schedule vs. timesheets

-4.22.Reports: Sent messages

-4.23.Reports: Shifts

-4.24.Reports: Time clock

-4.25.Reports: Time off