Kiosk Management

List Kiosks

Retrieve all kiosk units in the system.

Endpoint

GET /kioscos

This endpoint is public and does not require authentication. It’s used by kiosk terminals to retrieve configuration.

Response

data

array

Show Unidad (Kiosk)

integer

Kiosk unit ID

clave

string

Kiosk identifier code

nombreCompleto

string

Full kiosk name

usaCamara

boolean

Whether camera/facial recognition is enabled

compensacion

string

Time compensation offset (HH:mm:ss format)

requiereCodigo

boolean

Whether kiosk is requesting a configuration code

message

string

Success message: “Unidades Kiosco”

Example Request

cURL

curl -X GET http://localhost:8081/comialex/api/integra/kioscos

Example Response

{
  "data": [
    {
      "id": 3,
      "clave": "KIOSK-001",
      "nombreCompleto": "Kiosk Entrada Principal",
      "usaCamara": true,
      "compensacion": "00:05:00",
      "requiereCodigo": false
    },
    {
      "id": 7,
      "clave": "KIOSK-002",
      "nombreCompleto": "Kiosk Almacén",
      "usaCamara": false,
      "compensacion": "00:00:00",
      "requiereCodigo": true
    }
  ],
  "message": "Unidades Kiosco",
  "success": true
}

Get Kiosk by ID

Retrieve configuration for a specific kiosk.

Endpoint

GET /kioscos/{id}

This endpoint is public and does not require authentication.

Path Parameters

integer

required

Kiosk unit ID

Response

data

object

Kiosk unit object with configuration details

message

string

Success message: “Unidad Kiosco”

Example Request

cURL

curl -X GET http://localhost:8081/comialex/api/integra/kioscos/3

Example Response

{
  "data": {
    "id": 3,
    "clave": "KIOSK-001",
    "nombreCompleto": "Kiosk Entrada Principal",
    "usaCamara": true,
    "compensacion": "00:05:00",
    "requiereCodigo": false
  },
  "message": "Unidad Kiosco",
  "success": true
}

Update Camera Usage

Enable or disable camera/facial recognition for a kiosk.

Endpoint

PATCH /kioscos/{id}/camara

This endpoint requires ADMIN authorization.

Path Parameters

integer

required

Kiosk unit ID

Query Parameters

estatus

boolean

required

True to enable camera, false to disable

Response

data

boolean

Returns true on success

message

string

Success message: “Estatus actualizado correctamente”

Example Request

cURL

curl -X PATCH "http://localhost:8081/comialex/api/integra/kioscos/3/camara?estatus=true" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Example Response

{
  "data": true,
  "message": "Estatus actualizado correctamente",
  "success": true
}

Generate Configuration Code

Generate a single-use configuration code for remote kiosk setup.

Endpoint

PATCH /kioscos/{id}/codigo

This endpoint requires ADMIN authorization.

Path Parameters

integer

required

Kiosk unit ID

Response

data

string

The generated configuration code

message

string

Success message: “Se ha procesado la confirmación”

Example Request

cURL

curl -X PATCH http://localhost:8081/comialex/api/integra/kioscos/3/codigo \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Example Response

{
  "data": "KX7H9P2M",
  "message": "Se ha procesado la confirmación",
  "success": true
}

Display this code in the admin interface so it can be entered into the kiosk terminal for configuration.

Use Configuration Code

Validate and consume a configuration code on the kiosk.

Endpoint

POST /kioscos/{id}/codigos/{codigo}/usar

This endpoint is public and does not require authentication. It’s called by the kiosk terminal during setup.

Path Parameters

integer

required

Kiosk unit ID

codigo

string

required

Configuration code to validate

Response

data

boolean

Returns true on success

message

string

Success message: “Código autorizado”

Example Request

cURL

curl -X POST http://localhost:8081/comialex/api/integra/kioscos/3/codigos/KX7H9P2M/usar

Example Response

{
  "data": true,
  "message": "Código autorizado",
  "success": true
}

The code is invalidated after first use. If the same code is used again, the request will fail.

Request Configuration Code

Signal that a kiosk needs a configuration code (sets the requiereCodigo flag).

Endpoint

PATCH /kioscos/{id}/requiere-codigo

This endpoint is public and does not require authentication. It’s called by the kiosk when it needs configuration.

Path Parameters

integer

required

Kiosk unit ID

Response

data

boolean

Returns true on success

message

string

Success message: “Solicitud enviada”

Example Request

cURL

curl -X PATCH http://localhost:8081/comialex/api/integra/kioscos/3/requiere-codigo

Example Response

{
  "data": true,
  "message": "Solicitud enviada",
  "success": true
}

This sets a flag that administrators can see in the admin panel, alerting them that a kiosk needs attention.

Cancel Configuration Request

Cancel a pending configuration code request (clears the requiereCodigo flag).

Endpoint

DELETE /kioscos/{id}/requiere-codigo

This endpoint requires ADMIN authorization.

Path Parameters

integer

required

Kiosk unit ID

Response

data

boolean

Returns true on success

message

string

Success message: “Solicitud enviada”

Example Request

cURL

curl -X DELETE http://localhost:8081/comialex/api/integra/kioscos/3/requiere-codigo \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Update Compensation Time

Set the time compensation offset for a kiosk.

Endpoint

PATCH /kioscos/{id}/compensacion

Path Parameters

integer

required

Kiosk unit ID

Query Parameters

compensacion

string

required

Time offset in LocalTime format (HH:mm:ss)

Response

data

boolean

Returns true on success

message

string

Success message: “Tiempo de compensación actualizado correctamente”

Example Request

cURL

curl -X PATCH "http://localhost:8081/comialex/api/integra/kioscos/3/compensacion?compensacion=00:05:00" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Compensation time allows for clock-in tolerance. For example, a 5-minute compensation means employees can clock in up to 5 minutes early or late without being marked as tardy.

Update Capture Wait Time

Set the global capture wait time for all kiosks.

Endpoint

PATCH /kioscos/tiempo-captura

Query Parameters

tiempoEspera

integer

required

Wait time in seconds before capturing attendance photo

Response

data

boolean

Returns true on success

message

string

Success message: “Tiempo de espera actualizado correctamente”

Example Request

cURL

curl -X PATCH "http://localhost:8081/comialex/api/integra/kioscos/tiempo-captura?tiempoEspera=3" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Get Capture Wait Time

Retrieve the current global capture wait time.

Endpoint

GET /kioscos/tiempo-captura

Response

data

integer

Wait time in seconds

message

string

Success message: “Tiempo de espera”

Example Request

cURL

curl -X GET http://localhost:8081/comialex/api/integra/kioscos/tiempo-captura \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Example Response

{
  "data": 3,
  "message": "Tiempo de espera",
  "success": true
}

Kiosk Setup Workflow

Kiosk requests code

The kiosk terminal calls PATCH /kioscos/{id}/requiere-codigo to signal it needs configuration.

Admin generates code

Administrator sees the request in the admin panel and calls PATCH /kioscos/{id}/codigo to generate a code.

Admin provides code

Administrator displays or communicates the code to the person at the kiosk terminal.

Kiosk uses code

The person enters the code into the kiosk, which calls POST /kioscos/{id}/codigos/{codigo}/usar to validate.

Configuration complete

If successful, the kiosk is configured and the requiereCodigo flag is cleared.

Security Note: Configuration codes are single-use and should be transmitted securely. Never log or store codes in plain text.

Authentication

Attendance

Employees

Organization

Credentials

Access Control

Kiosk

Reports

Observations

​List Kiosks

​Endpoint

​Response

​Example Request

​Example Response

​Get Kiosk by ID

​Endpoint

​Path Parameters

​Response

​Example Request

​Example Response

​Update Camera Usage

​Endpoint

​Path Parameters

​Query Parameters

​Response

​Example Request

​Example Response

​Generate Configuration Code

​Endpoint

​Path Parameters

​Response

​Example Request

​Example Response

​Use Configuration Code

​Endpoint

​Path Parameters

​Response

​Example Request

​Example Response

​Request Configuration Code

​Endpoint

​Path Parameters

​Response

​Example Request

​Example Response

​Cancel Configuration Request

​Endpoint

​Path Parameters

​Response

​Example Request

​Update Compensation Time

​Endpoint

​Path Parameters

​Query Parameters

​Response

​Example Request

​Update Capture Wait Time

​Endpoint

​Query Parameters

​Response

​Example Request

​Get Capture Wait Time

​Endpoint

​Response

​Example Request

​Example Response

​Kiosk Setup Workflow

Build docs developers (and LLMs) love

List Kiosks

Endpoint

Response

Example Request

Example Response

Get Kiosk by ID

Endpoint

Path Parameters

Response

Example Request

Example Response

Update Camera Usage

Endpoint

Path Parameters

Query Parameters

Response

Example Request

Example Response

Generate Configuration Code

Endpoint

Path Parameters

Response

Example Request

Example Response

Use Configuration Code

Endpoint

Path Parameters

Response

Example Request

Example Response

Request Configuration Code

Endpoint

Path Parameters

Response

Example Request

Example Response

Cancel Configuration Request

Endpoint

Path Parameters

Response

Example Request

Update Compensation Time

Endpoint

Path Parameters

Query Parameters

Response

Example Request

Update Capture Wait Time

Endpoint

Query Parameters

Response

Example Request

Get Capture Wait Time

Endpoint

Response

Example Request

Example Response

Kiosk Setup Workflow