What is an API?
API integration allows seamless data exchange between a client’s systems and Fingercheck. With our API, they can automate various processes such as managing employee payroll deductions, synchronizing schedules, and more.
API Key: A unique key issued to the programmer to access the API web service. API keys are like unique access passes that interact with specific parts of our services. They are used to identify their company when making requests with the 401(K) integration or any other integration.
Client Secret Key: Generated per company and per user to define distinct access levels. This key can act as a filter, preventing a programmer from accessing unauthorized information. This is a confidential key used by applications to authenticate themselves with our system. Note that if accessing two companies is required, the same API key can be used, but an additional Client Secret Key will need to be requested.
Think of these keys as a secret password that should be kept safe and never shared with anyone outside your team. The Client Secret Key is essential for securing the communication between your application and our API, ensuring that only authorized parties can access your data.
Requirements for API Integration
To set up API integration, you’ll need:
API Key: A unique identifier to access Fingercheck’s API.
Client Secret Key: A key that defines specific access per company and user, enhancing security by restricting unauthorized access.
Steps to Generate API Keys
Log in to Fingercheck as an Administrator.
Click your profile avatar and select Account & Preferences.
Scroll to the API section.
Click Generate to create an API Key.
Confirm by clicking OK in the pop-up.
6. Save the generated key.
7. Send the API Key and Client Secret Key to Fingercheck securely via email or upload them as a document.
API Documentation
Fingercheck offers a REST API that allows interaction through the following HTTP methods:
GET: Retrieve data.
POST: Send new data.
PUT: Update existing data.
DELETE: Remove data.
Base URL: https://developer.fingercheck.com/api/
All requests must use HTTPS and include the following headers:
APIKEY: Issued when generating API keys.
ClientSecretKey: Generated for each user and company.
Key API Functions
GET v1/Reports/GetLiveStatusByDate: Retrieve live employee status for a specific date.
POST v1/Employees/AddEmployee: Add a new employee.
DELETE v1/Schedule/DeleteTimeClockSchedule: Remove an employee schedule.
For the full list of available API functions, visit our API documentation portal.
Need to set up an API for a 401(k)? Learn how to set up a 401(k) integration here.