Overview

This step-by-step guide will walk you through creating a schedule enforcement integration with 7shifts through the 7shifts REST API.

📘

MAPPING NOTE

This section requires an understanding of how to map locations, departments, and roles.

Upon completion of this guide, you will have created an integration that can interact with the 7shifts platform as follows:

• Establish entity mapping between your system & 7shifts.
• Check whether user is scheduled for a shift or not.

You will be interacting with the following 7shifts API endpoints for building this integration:

• GET Scheduled Shift
• GET Locations
• GET Departments
• GET Roles
• GET Users

What’s in it for the client?

• Ability to only allow employees to clock in that are actually scheduled to work.
• Ability to specify a grace period within which an employee should be allowed to clock in before the start of a scheduled shift.

Requirements

• An API Key or OAuth client and company grant for a test/sandbox 7shifts account
• cURL or Postman to make test requests

Restrictions

• You may only make 10 requests per second per access token across all API endpoints.
• You must make these requests in real-time at the time a user tries to clock-in.

Functionality Overview

The schedule enforcement integration involves checking whether a user is scheduled for a shift in 7shifts when they try to clock in through your time clock software. The returned response can be used to determine whether a user should be allowed to clock in or not.

The general clock in flow with a schedule enforcement integration looks as follows: