Device Management API

Register, update, and monitor biometric devices and their status in the CLMS system.

Overview

The Device Management API allows you to register and manage biometric devices in the CLMS system. This includes device registration, status updates, and performance monitoring.

GET /api/biometric/devices

List all registered devices

POST /api/biometric/devices

Register or update a device

PUT /api/biometric/devices

Update device status

DELETE /api/biometric/devices?device_id=DEV001

Deactivate a device

List Devices

Retrieve a list of all registered devices and their current status.

Request

curl -X GET "https://your-domain.com/api/biometric/devices" \
  -H "X-API-Key: your_api_key"

Response

{
  "success": true,
  "data": [
    {
      "id": 1,
      "device_id": "DEV001",
      "device_name": "Main Gate Scanner",
      "location": "Main Entrance",
      "device_type": "hybrid",
      "is_active": true,
      "last_seen": "2024-12-01T10:30:00Z",
      "firmware_version": "1.2.3",
      "ip_address": "192.168.1.100",
      "created_at": "2024-11-01T08:00:00Z",
      "updated_at": "2024-12-01T10:30:00Z"
    }
  ],
  "count": 1
}

Register Device

Register a new biometric device or update an existing one.

Request

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.2.3",
    "ip_address": "192.168.1.100"
  }'

Parameters

Parameter Type Required Description
device_id string Yes Unique identifier for the device
device_name string Yes Human-readable name for the device
location string Yes Physical location of the device
device_type string Yes Type of biometric device (fingerprint, face_recognition, card_reader, hybrid)
is_active boolean No Whether the device is active (default: true)
firmware_version string No Device firmware version
ip_address string No Device IP address

Response

{
  "success": true,
  "message": "Device registered successfully",
  "device_id": "DEV001"
}

Update Device Status

Update device status, firmware version, or other properties.

Request

curl -X PUT "https://your-domain.com/api/biometric/devices" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "device_id": "DEV001",
    "is_active": true,
    "firmware_version": "1.3.0",
    "ip_address": "192.168.1.101"
  }'

Response

{
  "success": true,
  "message": "Device status updated successfully"
}

Deactivate Device

Deactivate a device to prevent it from processing new attendance events.

Request

curl -X DELETE "https://your-domain.com/api/biometric/devices?device_id=DEV001" \
  -H "X-API-Key: your_api_key"

Response

{
  "success": true,
  "message": "Device deactivated successfully"
}

Device Types

Supported biometric device types and their characteristics.

Fingerprint

Traditional fingerprint scanners for biometric identification.

  • High accuracy
  • Fast processing
  • Widely compatible
Face Recognition

Camera-based facial recognition systems.

  • Contactless operation
  • Good for hygiene
  • Advanced AI processing
Card Reader

RFID/NFC card-based identification systems.

  • Simple operation
  • Durable cards
  • Easy to replace
Hybrid

Multi-modal devices supporting multiple identification methods.

  • Multiple options
  • High reliability
  • Future-proof

Interactive Demo

Click "Test API" to see the response here