Kiosk Overview

​

Overview

​

Core Concepts

​

Kiosk Unit

• Camera Usage: Whether facial recognition is enabled
• Configuration Code: Temporary code for remote kiosk setup
• Compensation Time: Time offset for early/late clock-ins
• Capture Wait Time: Delay before capturing attendance image

​

Clock-in Flow

1. Employee identifies themselves at the kiosk (NIP, QR code, facial recognition)
2. System validates the employee and their schedule
3. Camera captures employee photo (if enabled)
4. Attendance record is created with timestamp and location
5. Confirmation is displayed to the employee

​

Configuration Security

• Admin generates a configuration code
• Code is displayed in the admin panel
• Kiosk uses the code to retrieve its configuration
• Code is invalidated after first use

​

Base URL

/comialex/api/integra/kioscos

​

Authentication

​

Public Endpoints (No Auth Required)

• GET /kioscos - List all kiosks
• GET /kioscos/{id} - Get kiosk configuration
• POST /kioscos/{id}/codigos/{codigo}/usar - Use configuration code
• PATCH /kioscos/{id}/requiere-codigo - Request configuration code

​

Protected Endpoints (Auth Required)

• Camera configuration
• Code generation
• Compensation settings
• All administrative operations

​

Public vs Admin Access

​

Public Access

• Retrieve their configuration (camera settings, compensation time)
• Request configuration codes when needed
• Use codes to validate setup

​

Admin Access

• Configure camera usage
• Generate configuration codes
• Update compensation times
• Manage capture wait times

​

Common Response Format

{
  "data": <response_data>,
  "message": "Success message",
  "success": true,
  "timestamp": 1709644800000
}

​

Kiosk Configuration Example

{
  "id": 3,
  "clave": "KIOSK-001",
  "nombreCompleto": "Kiosk Entrada Principal",
  "usaCamara": true,
  "compensacion": "00:05:00",
  "requiereCodigo": false,
  "tiempoEspera": 3
}

​

Next Steps