Overview

This guide provides an overview of how to integrate your platform's backend and frontend with Easyteam.

When using the Easyteam white-label UI components, most interactions with the backend are handled automatically.

With an Easyteam Embedded partner key, you can interact with the Easyteam API to build custom integrations tailored to your platform’s workforce management needs.

Installation

To integrate EasyTeam front-end components, start by installing from our private npm registry:

Create a .npmrc file with the following://registry.npmjs.org/:_authToken=${NPM_TOKEN}

Our team will provide a value for the NPM_TOKEN environment variable

Install the required libraries:

React Native SDK

iframe Launcher

React

Core services

For React Native apps: In the root of your app, import the EasyTeamProvider and wrap the app contents with it.

Authentication & Security

Easyteam employs a robust two-layer security system to protect your integration:

Partner Authentication: Your platform is identified using a unique partner key provided by our team.

Cryptographic Verification: All data exchanged between your platform and Easyteam servers is cryptographically signed to ensure security and integrity.

WARNING

Never expose your partner key in client-side code. Always handle API authentication through your backend services.

For detailed implementation of the authentication system, see our Authentication Guide.

Event Handling & Webhooks

Easyteam provides real-time updates through webhooks for events such as:

Clock-in/out activities

Break starts and ends

Timesheet modifications

Settings changes

Timesheets exports

Implementing Webhook Handlers

To start using webhooks:

Verify and respond to webhook signatures.

Process incoming events according to your platform's business logic.

💡

Webhooks are the recommended way to respond to events in Easyteam and communicate with your users in real-time.

For implementation details and event types, see our Webhooks Documentation.

Direct API Access

For advanced custom integrations, you can interact directly with the Easyteam API to:

Trigger workforce management actions programmatically:

Clock employees in/out

Start/end breaks

Modify settings

Access workforce data:

Retrieve timesheet records

Access employee schedules

View attendance logs

For complete API capabilities, see our API Reference.

Overview

Overview#

Installation#

Authentication & Security#

Event Handling & Webhooks#

Implementing Webhook Handlers#

Direct API Access#

Overview

Installation

Authentication & Security

Event Handling & Webhooks

Implementing Webhook Handlers

Direct API Access