Quick Start Guide

Get up and running with the CLMS Biometric API in minutes. Follow this step-by-step guide to integrate your biometric system.

Overview

The CLMS Biometric API allows you to integrate external biometric systems with the CLMS workforce management platform. This guide will walk you through the essential steps to start recording attendance data.

5 Minutes

To get started

Secure

API key authentication

Real-time

Live data processing

Prerequisites

Before you begin, ensure you have the following:

API Credentials

API key and client ID from your system administrator

Biometric Device

Compatible biometric device with network connectivity

Development Environment

HTTP client library (cURL, requests, fetch, etc.)

Network Access

Access to the CLMS API endpoints

Step 1: Get API Credentials

1

Contact Your Administrator

Contact your CLMS system administrator to obtain:

  • API Key: Unique identifier for your system
  • Client ID: Your organization identifier
  • Base URL: API endpoint URL
Note: Keep your API credentials secure and never share them publicly.

Step 2: Register Your Device

2

Device Registration

Register your biometric device with the system:

Register Device
curl -X POST "https://your-domain.com/api/biometric/devices" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "device_id": "DEV001",
    "device_name": "Main Gate Scanner",
    "location": "Main Entrance",
    "device_type": "hybrid",
    "is_active": true,
    "firmware_version": "1.0.0",
    "ip_address": "192.168.1.100"
  }'
Success Response
{
  "success": true,
  "message": "Device registered successfully",
  "device_id": "DEV001"
}

Step 3: Record Attendance

3

Send Attendance Events

Send worker check-in/check-out events to the API:

Record Check-in
curl -X POST "https://your-domain.com/api/biometric/attendance" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "device_info": {
      "device_id": "DEV001",
      "device_name": "Main Gate Scanner",
      "location": "Main Entrance"
    },
    "events": [{
      "scanId": "SCAN_001_20241201_001",
      "employeeId": "EMP001",
      "eventType": "check_in",
      "timestamp": "2024-12-01T08:30:00Z",
      "temperature": 36.5,
      "maskDetected": true
    }]
  }'
Success Response
{
  "success": true,
  "message": "Attendance data processed successfully",
  "processed": 1,
  "successful": 1,
  "failed": 0,
  "results": [{
    "success": true,
    "message": "Attendance recorded successfully",
    "worker_id": "W001",
    "worker_name": "John Doe",
    "assignment_id": 123,
    "event_type": "check_in"
  }]
}
Success! The worker's attendance has been recorded and their assignment status updated.

Step 4: Generate Reports

4

View Attendance Data

Generate reports to view attendance data and analytics:

Daily Attendance Report
curl -X GET "https://your-domain.com/api/biometric/reports?type=daily&from=2024-12-01&to=2024-12-07" \
  -H "X-API-Key: your_api_key"
Device Performance Report
curl -X GET "https://your-domain.com/api/biometric/reports?type=device&from=2024-12-01&to=2024-12-07" \
  -H "X-API-Key: your_api_key"
Tip: Use different report types (daily, worker, device, errors) to get comprehensive insights into your attendance data.

Test Your Integration

Try the API Live

Use the interactive demo below to test your API integration:

Click a test button to see the response here

Next Steps

Read the Full Documentation

Explore detailed API reference documentation for all endpoints and parameters.

View API Reference
Explore Code Examples

Check out comprehensive code examples in multiple programming languages.

View Examples
Test Your Integration

Use our testing tools to verify your integration works correctly.

Testing Guide
Get Support

Need help? Check our troubleshooting guide or contact support.

Get Help

Frequently Asked Questions

Contact your CLMS system administrator to obtain your API key and client ID. They will provide you with the necessary credentials and any additional configuration details.

If a worker is not found for the provided employee ID, the event will be logged as an error and returned in the response. The worker will need to be registered in the CLMS system before their attendance can be recorded.

Yes, you can send multiple events in a single request by including them in the "events" array. This is more efficient than sending individual requests for each event.

The API has a rate limit of 1000 requests per hour and 10,000 requests per day per API key. Bulk operations are limited to 100 events per request.