CLMS Biometric API

Comprehensive API for integrating external biometric systems with CLMS for real-time attendance tracking and workforce management.

Get Started View API Reference Test API

Key Features

Real-time Processing

Process attendance events in real-time with automatic worker matching and status updates.

Secure Integration

API key authentication with comprehensive error handling and data validation.

Advanced Reporting

Generate detailed attendance reports, device statistics, and performance analytics.

Device Management

Register and monitor biometric devices with status tracking and performance metrics.

API Endpoints

POST /api/biometric/attendance
Record Attendance

Submit worker check-in/check-out events with device information and health data.

View Details
GET /api/biometric/devices
Device Management

Register, update, and monitor biometric devices and their status.

View Details
GET /api/biometric/reports
Generate Reports

Create attendance reports, device statistics, and error analysis.

View Details
POST /api/biometric/auth.php
Authentication

Authenticate with the API using your credentials and receive access tokens.

View Details

Quick Example

curl -X POST "https://your-domain.com/api/biometric/attendance" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "events": [{
      "scanId": "SCAN_001_20241201_001",
      "employeeId": "EMP001",
      "eventType": "check_in",
      "timestamp": "2024-12-01T08:30:00Z",
      "temperature": 36.5,
      "maskDetected": true
    }]
  }'
const response = await fetch('/api/biometric/attendance', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-API-Key': 'your_api_key'
  },
  body: JSON.stringify({
    events: [{
      scanId: 'SCAN_001_20241201_001',
      employeeId: 'EMP001',
      eventType: 'check_in',
      timestamp: new Date().toISOString(),
      temperature: 36.5,
      maskDetected: true
    }]
  })
});

const result = await response.json();
console.log(result);
import requests
import json

url = "https://your-domain.com/api/biometric/attendance"
headers = {
    "Content-Type": "application/json",
    "X-API-Key": "your_api_key"
}

data = {
    "events": [{
        "scanId": "SCAN_001_20241201_001",
        "employeeId": "EMP001",
        "eventType": "check_in",
        "timestamp": "2024-12-01T08:30:00Z",
        "temperature": 36.5,
        "maskDetected": True
    }]
}

response = requests.post(url, headers=headers, json=data)
result = response.json()
print(result)

Getting Started

1
Get API Credentials

Contact your system administrator to obtain your API key and client ID.

2
Register Your Device

Register your biometric device using the Device Management API.

3
Start Recording Attendance

Send attendance events to the Simple Attendance API endpoint.

4
Monitor and Report

Use the Reports API to generate attendance summaries and analytics.

Need Help?

Check out our comprehensive guides and examples to get started quickly.

View Quick Start Guide