Endpoints / Configuración

GET

Obtener configuración por clave

Obtiene una configuración específica por su clave, dentro de una empresa indicada, desde administración central.

GET/configs/:configKey

Caso de Uso

Se usa cuando un administrador necesita consultar el valor de una clave de configuración puntual para una empresa específica. Al usarlo, el usuario obtiene los datos completos de la configuración, incluyendo su identificador único, empresa, clave y valor.

Autenticación

Requiere token JWT en el header `Authorization: Bearer <token>`. Solo permite acceso a usuarios con rol administrador. La empresa del usuario autenticado debe estar activa y ser empresa padre.

Parámetros de ruta

configKeystringobligatorio

Clave de configuración.

Query params

companyIdstringobligatorio

Identificador de la empresa donde se buscará la clave.

Body

No aplica.

Reglas de negocio

1

Solo un usuario con rol administrador puede consultar configuraciones.

2

La empresa del usuario autenticado debe ser empresa padre.

3

La empresa del usuario autenticado debe estar activa.

4

El usuario autenticado debe estar activo.

5

configKey y companyId son obligatorios.

6

La búsqueda se realiza por la combinación de companyId y configKey.

Errores esperados

401No autorizado

No se envió un token JWT válido o el token no contiene información válida del usuario.

400La clave de configuración es requerida

No se envió el parámetro configKey en la ruta.

400El id de empresa es requerido

No se envió el query param companyId.

500La empresa no existe

La empresa asociada al usuario autenticado no fue encontrada.

500La empresa no está activa

La empresa asociada al usuario autenticado está inactiva.

500El usuario no existe

El usuario autenticado no fue encontrado dentro de su empresa.

500El usuario no pertenece a la empresa

El usuario autenticado no pertenece a la empresa indicada por su sesión.

500El usuario no es administrador

El usuario autenticado no tiene el rol requerido para consultar configuraciones.

500El usuario no está activo

El usuario autenticado está inactivo y no puede usar el sistema.

500La empresa no es empresa padre

La empresa del usuario autenticado no es empresa padre.

500Configuración no encontrada

No existe una configuración con la combinación de companyId y configKey indicada.

Notas de uso

1

Este endpoint no recibe body.

2

companyId se envía como query param en la URL.

3

La búsqueda es exacta por la combinación de empresa y clave; no se realizan búsquedas parciales.