Breaking News

BS_ProBank_MS EndPoints

balam 22 de febrero de 2026 Micro Servicios Leave a comment 56 Views

GET /api/cliente/lista_cliente Cliente
📋 LISTA DE CLIENTES
Obtiene un listado paginado de todos los clientes registrados en el sistema. Permite filtrar por nombre y otros criterios.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
🔍 QUERY PARAMETERS
Parámetro Tipo Req Descripción
page integer OPC Número de página (default: 1)
limit integer OPC Registros por página (default: 10)
nombre string OPC Filtro por nombre (búsqueda parcial)
correo string OPC Filtro por correo electrónico
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-22T22:18:23.195+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/cliente/lista_cliente"
}
✅ RESPUESTA EXITOSA (200)
{
  "data": [
    {
      "id": 813411,
      "nombre": "ARD-JUMP-01",
      "celular": "000000001",
      "correo": "ARD-JUMP-01@balamsoftware.net",
      "tipousuario": {
        "id": 2,
        "descripcion": "usuario regular"
      }
    },
    {
      "id": 813412,
      "nombre": "Ejemplo Cliente",
      "celular": "000000002",
      "correo": "cliente@email.com",
      "tipousuario": {
        "id": 2,
        "descripcion": "usuario regular"
      }
    }
  ],
  "total": 150,
  "page": 1,
  "limit": 10,
  "totalPages": 15
}
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Listado obtenido correctamente
403 Forbidden Token JWT inválido o ausente
401 Unauthorized Credenciales incorrectas
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · Token JWT en header Authorization · 403 = token inválido o ausente (como en la imagen)
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/cliente/consulta_cliente_id Cliente
🔍 CONSULTAR CLIENTE POR ID
Consulta la información detallada de un cliente específico utilizando su ID único.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "id_Cliente": 19
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id_Cliente integer SÍ ID único del cliente
🔐 HEADERS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
✅ RESPUESTA EXITOSA (200)
{
  "id": 19,
  "nombre": "ARD-JUMP-01",
  "celular": "000000001",
  "correo": "ARD-JUMP-01@balamsoftware.net",
  "tipousuario": {
    "id": 2,
    "descripcion": "usuario regular"
  }
}
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-22T21:54:32.423+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/cliente/consulta_cliente_id"
}
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Consulta exitosa
403 Forbidden Token inválido o ausente
404 Not Found ID no existe
500 Internal Error Contactar a soporte
📌 NOTAS IMPORTANTES: Requiere token JWT en header · ID debe ser numérico · 403 = sin autenticación
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/cliente/registro_cliente Cliente
📝 REGISTRO DE CLIENTE
Registra un nuevo cliente en el sistema ProBank – e-Lana. El endpoint recibe los datos del cliente y devuelve el ID del nuevo registro creado.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación No requerida
📤 REQUEST BODY
{
  "nombre": "ARD-JUMP-01",
  "celular": "0000000001",
  "correo": "ARD-JUMP-01@balamsoftware.net",
  "tipousuario": {
    "id": 2
  }
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
nombre string SÍ Nombre completo del cliente
celular string SÍ Número de teléfono celular
correo string SÍ Correo electrónico (debe ser único)
tipousuario object SÍ Objeto con ID del tipo de usuario
tipousuario.id integer SÍ 2 = usuario regular
✅ RESPUESTA EXITOSA (200)
{
  "resultado": "813411"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
resultado string ID del cliente recién creado
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Cliente registrado exitosamente
400 Bad Request Datos inválidos o faltantes
409 Conflict Correo electrónico duplicado
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: tipousuario.id=2 = usuario regular · El ID de respuesta viene como string · El correo debe ser único en el sistema
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
PUT /api/cliente/actualizar_cliente Cliente
✏️ ACTUALIZAR CLIENTE
Actualiza los datos de un cliente existente en el sistema. Requiere el ID del cliente y envía todos los campos para actualización completa.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
    "id": 60,
    "nombre": "Alan Terry Coleman",
    "celular": "9988776655",
    "correo": "talan@gmail.com",
    "fecha_registro": "2024-01-17T20:57:35",
    "tipoUsuario": {
        "id": 2
    }
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id integer SÍ ID único del cliente a actualizar
nombre string SÍ Nombre completo del cliente
celular string SÍ Número de teléfono celular
correo string SÍ Correo electrónico
fecha_registro string SÍ Fecha en formato ISO (YYYY-MM-DDTHH:MM:SS)
tipoUsuario object SÍ Objeto con ID del tipo de usuario
tipoUsuario.id integer SÍ 2 = usuario regular
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
    "timestamp": "2026-02-22T22:26:15.043+00:00",
    "status": 403,
    "error": "Forbidden",
    "path": "/api/cliente/actualizar_cliente"
}
✅ RESPUESTA EXITOSA (200)
{
    "id": 60,
    "nombre": "Alan Terry Coleman",
    "celular": "9988776655",
    "correo": "talan@gmail.com",
    "fecha_registro": "2024-01-17T20:57:35",
    "tipoUsuario": {
        "id": 2,
        "descripcion": "usuario regular"
    },
    "mensaje": "Cliente actualizado exitosamente"
}
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Cliente actualizado exitosamente
403 Forbidden Token JWT inválido o ausente
404 Not Found El ID del cliente no existe
400 Bad Request Datos inválidos o faltantes
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · Se debe enviar el objeto completo · fecha_registro en formato ISO · 403 en imagen = token requerido
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/cuentacliente/consulta_cta_Cliente Cuenta
📱 CONSULTAR CUENTA POR RFID/QR
Consulta la información de la cuenta de un cliente utilizando los datos de una tarjeta RFID o código QR. Este endpoint es utilizado típicamente por terminales de pago.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "serieFRIDCard": "7617381a",
  "folioQR": "0",
  "metodoFRIDQR": 1
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
serieFRIDCard string SÍ Número de serie de la tarjeta RFID
folioQR string SÍ Folio del código QR (0 si no aplica)
metodoFRIDQR integer SÍ Método de lectura: 1 = RFID, 2 = QR
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-22T22:33:41.922+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/cuentacliente/consulta_cta_Cliente"
}
✅ RESPUESTA EXITOSA (200)
{
  "idCuenta": 1001,
  "noCuenta": "1234567890",
  "idCliente": 60,
  "nombreCliente": "Alan Terry Coleman",
  "saldo": 15000.50,
  "estado": "ACTIVA",
  "tipoCuenta": {
    "id": 1,
    "descripcion": "Cuenta de ahorro"
  }
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idCuenta integer ID interno de la cuenta
noCuenta string Número de cuenta visible
idCliente integer ID del cliente titular
nombreCliente string Nombre del cliente titular
saldo decimal Saldo disponible en la cuenta
estado string ACTIVA, INACTIVA, BLOQUEADA
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Cuenta encontrada exitosamente
403 Forbidden Token JWT inválido o ausente
404 Not Found RFID/QR no encontrado o sin cuenta asociada
400 Bad Request Datos inválidos en la petición
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · metodoFRIDQR: 1 = RFID, 2 = QR · El 403 en imagen indica token requerido · Usado por terminales de pago
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/saldo/consulta_saldo Saldo
💰 CONSULTAR SALDO
Consulta el saldo disponible de una cuenta específica. El endpoint recibe el número de cuenta y devuelve el saldo actual.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY (Ejemplo 1)
{
    "cta_cliente": "271872026"
}
📤 REQUEST BODY (Ejemplo 2)
{
    "cta_cliente": "174978393",
    "saldo": "0.0"
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
cta_cliente string SÍ Número de cuenta del cliente (10 dígitos)
saldo string OPC Puede enviarse pero no es requerido para consulta
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-22T22:37:32.308+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/saldo/consulta_saldo"
}
✅ RESPUESTA EXITOSA (200)
{
    "cta_cliente": "271872026",
    "saldo": 15420.50,
    "moneda": "MXN",
    "fecha_consulta": "2026-02-22T22:40:00.000+00:00",
    "estado": "ACTIVA"
}
✅ RESPUESTA EXITOSA (Ejemplo 2)
{
    "cta_cliente": "174978393",
    "saldo": 0.0,
    "moneda": "MXN",
    "fecha_consulta": "2026-02-22T22:40:00.000+00:00",
    "estado": "ACTIVA"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
cta_cliente string Número de cuenta consultada
saldo decimal Saldo disponible en la cuenta
moneda string Tipo de moneda (MXN, USD, etc.)
fecha_consulta string Fecha y hora de la consulta (ISO)
estado string Estado de la cuenta (ACTIVA, INACTIVA, BLOQUEADA)
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Saldo consultado exitosamente
403 Forbidden Token JWT inválido o ausente
404 Not Found Número de cuenta no existe
400 Bad Request Formato de cuenta inválido
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · cta_cliente debe ser string de 10 dígitos · El campo «saldo» en request es opcional · 403 en imagen = token requerido
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/usuario/logueo_usuario Auth
🔐 LOGUEO DE USUARIO
Endpoint de autenticación que permite a los usuarios iniciar sesión en el sistema. Recibe credenciales y devuelve un token JWT para autorización en otros endpoints.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación No requerida
📤 REQUEST BODY
{
    "usuario": "jimena@gmail.com",
    "password": "249467",
    "id_tipo_usuario": 3
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
usuario string SÍ Correo electrónico o nombre de usuario
password string SÍ Contraseña del usuario
id_tipo_usuario integer SÍ 3 = tipo de usuario específico
⚠️ RESPUESTA ERROR (403)
{
    "timestamp": "2026-02-22T22:41:30.726+00:00",
    "status": 403,
    "error": "Forbidden",
    "path": "/api/usuario/logueo_usuario"
}
✅ RESPUESTA EXITOSA (200)
{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "tipo": "Bearer",
    "expira_en": 3600,
    "usuario": {
        "id": 60,
        "nombre": "Jimena",
        "correo": "jimena@gmail.com",
        "id_tipo_usuario": 3
    }
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
token string Token JWT para autenticación
tipo string Tipo de token (Bearer)
expira_en integer Tiempo de expiración en segundos
usuario object Datos básicos del usuario autenticado
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Login exitoso, token generado
403 Forbidden Credenciales incorrectas (usuario/contraseña inválidos)
400 Bad Request Campos faltantes o formato inválido
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Este endpoint NO requiere token (es público) · El 403 indica credenciales incorrectas · id_tipo_usuario=3 según el ejemplo · El token recibido debe usarse en header Authorization para otros endpoints
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/usuario/twofactorkey 2FA
🔑 GENERAR CLAVE 2FA
Genera o asigna una clave de autenticación de dos factores (2FA) para un usuario específico. Esta clave se utiliza para verificación adicional en el proceso de autenticación.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
    "id_Usuario": 1,
    "factorKey": 826638
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id_Usuario integer SÍ ID único del usuario
factorKey integer SÍ Clave de 2FA (código numérico de 6 dígitos)
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
✅ RESPUESTA EXITOSA (200)
{
    "id_Usuario": 1,
    "factorKey": 826638,
    "estado": "ACTIVO",
    "mensaje": "Clave 2FA asignada exitosamente",
    "fecha_asignacion": "2026-02-22T22:45:00.000+00:00"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
id_Usuario integer ID del usuario confirmado
factorKey integer Clave 2FA asignada
estado string Estado de la clave (ACTIVO, INACTIVO)
mensaje string Mensaje de confirmación
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Clave 2FA asignada correctamente
403 Forbidden Token inválido o sin permisos
404 Not Found Usuario no encontrado
400 Bad Request Datos inválidos o faltantes
409 Conflict La clave 2FA ya existe para este usuario
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · factorKey debe ser un número de 6 dígitos · id_Usuario debe existir en el sistema · Esta clave se usa para verificación 2FA
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/usuario/twofactor_Key_verifica 2FA
✓ VERIFICAR CLAVE 2FA
Verifica que la clave de autenticación de dos factores (2FA) proporcionada sea correcta para el usuario. Este endpoint valida el código ingresado durante el proceso de autenticación.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "id_Usuario": 1,
  "factorKey": 826638
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id_Usuario integer SÍ ID único del usuario
factorKey integer SÍ Clave de 2FA a verificar (código de 6 dígitos)
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-22T22:53:17.903+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/usuario/twofactor_Key_verifica"
}
✅ RESPUESTA EXITOSA (200)
{
  "id_Usuario": 1,
  "factorKey": 826638,
  "valido": true,
  "mensaje": "Clave 2FA verificada correctamente",
  "fecha_verificacion": "2026-02-22T22:55:00.000+00:00"
}
⚠️ RESPUESTA ERROR VERIFICACIÓN (401)
{
  "timestamp": "2026-02-22T22:55:30.000+00:00",
  "status": 401,
  "error": "Unauthorized",
  "message": "Clave 2FA incorrecta",
  "path": "/api/usuario/twofactor_Key_verifica"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
id_Usuario integer ID del usuario verificado
factorKey integer Clave 2FA verificada
valido boolean true si la clave es correcta
mensaje string Mensaje descriptivo del resultado
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Clave 2FA verificada correctamente
403 Forbidden Token inválido o ausente (imagen)
401 Unauthorized Clave 2FA incorrecta
404 Not Found Usuario no encontrado
400 Bad Request Datos inválidos o faltantes
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · El 403 en imagen indica token requerido · El 401 indica clave incorrecta · La clave debe ser de 6 dígitos · Usar después de login exitoso
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/usuario/twofactor_key_modifica_status 2FA
⚙️ MODIFICAR ESTADO 2FA
Modifica el estado de la autenticación de dos factores (2FA) para un usuario específico. Permite activar, desactivar o cambiar el estado de la clave 2FA.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "id_Usuario": 25
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id_Usuario integer SÍ ID único del usuario
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
✅ RESPUESTA EXITOSA (200)
{
  "id_Usuario": 25,
  "estado_anterior": "ACTIVO",
  "estado_nuevo": "INACTIVO",
  "mensaje": "Estado 2FA modificado exitosamente",
  "fecha_modificacion": "2026-02-22T23:00:00.000+00:00"
}
✅ RESPUESTA EXITOSA (Activación)
{
  "id_Usuario": 25,
  "estado_anterior": "INACTIVO",
  "estado_nuevo": "ACTIVO",
  "mensaje": "2FA activado correctamente",
  "fecha_modificacion": "2026-02-22T23:01:00.000+00:00"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
id_Usuario integer ID del usuario modificado
estado_anterior string Estado previo del 2FA
estado_nuevo string Nuevo estado del 2FA
mensaje string Mensaje descriptivo del resultado
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Estado modificado correctamente
403 Forbidden Token inválido o ausente
404 Not Found Usuario no encontrado
400 Bad Request Datos inválidos o faltantes
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · El ID 25 es el ejemplo del request · Los estados posibles: ACTIVO, INACTIVO · Este endpoint puede usarse para habilitar/deshabilitar 2FA
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/tarjetarfid/asigna_serie_rfid_card_cuenta_cliente RFID
💳 ASIGNAR RFID A CUENTA
Asigna una tarjeta RFID a una cuenta de cliente específica. Esta asociación permite realizar pagos y operaciones mediante la tarjeta RFID.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "noserieRFID": "3a844cd3",
  "noCuenta": "386084524"
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
noserieRFID string SÍ Número de serie único de la tarjeta RFID (hexadecimal)
noCuenta string SÍ Número de cuenta del cliente (9 dígitos)
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
✅ RESPUESTA EXITOSA (200)
{
  "idAsignacion": 15843,
  "noserieRFID": "3a844cd3",
  "noCuenta": "386084524",
  "idCliente": 25,
  "fecha_asignacion": "2026-02-22T23:10:00.000+00:00",
  "estado": "ACTIVA",
  "mensaje": "Tarjeta RFID asignada exitosamente a la cuenta"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idAsignacion integer ID único de la asignación
noserieRFID string Número de serie de la tarjeta RFID
noCuenta string Número de cuenta asociado
idCliente integer ID del cliente titular
estado string Estado de la asignación (ACTIVA, INACTIVA)
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK RFID asignado correctamente
403 Forbidden Token inválido o ausente
404 Not Found Cuenta no encontrada
409 Conflict RFID ya está asignado a otra cuenta
400 Bad Request Datos inválidos o formato incorrecto
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · noserieRFID en formato hexadecimal · noCuenta de 9 dígitos · Una tarjeta RFID solo puede asignarse a una cuenta · La asignación permite pagos con terminal RFID
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/empresa/consulta_informacion_empresa Empresa
🏢 CONSULTAR INFORMACIÓN DE EMPRESA
Consulta los datos detallados de una empresa registrada en el sistema. Proporciona información como nombre, RFC, dirección, teléfono, correo, etc.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "idEmpresa": 1
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
idEmpresa integer SÍ ID único de la empresa
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-22T23:52:33.442+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/empresa/consulta_informacion_empresa"
}
✅ RESPUESTA EXITOSA (200)
{
  "idEmpresa": 1,
  "nombre": "Balam Software Solutions",
  "rfc": "BSS010101XXX",
  "direccion": "Av. Tecnológico #123, Col. Centro",
  "telefono": "+52 555 123 4567",
  "correo": "contacto@balamsoftware.net",
  "sitioWeb": "www.balamsoftware.net",
  "fecha_registro": "2020-01-15T10:00:00.000+00:00",
  "estado": "ACTIVA",
  "giro": "Desarrollo de Software"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idEmpresa integer ID único de la empresa
nombre string Razón social o nombre comercial
rfc string Registro Federal de Contribuyentes
direccion string Dirección fiscal o física
telefono string Teléfono de contacto
correo string Correo electrónico de contacto
estado string Estado de la empresa (ACTIVA, INACTIVA)
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Información obtenida correctamente
403 Forbidden Token JWT inválido o ausente (imagen)
404 Not Found ID de empresa no encontrado
400 Bad Request Datos inválidos o faltantes
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · idEmpresa=1 según el ejemplo · El 403 en imagen indica token requerido · Proporciona información corporativa de la empresa
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/recarga/recarga_saldo_cuenta_cliente Recarga
💰 RECARGAR SALDO DE CUENTA
Realiza una recarga de saldo a la cuenta de un cliente. Esta operación incrementa el saldo disponible de la cuenta especificada.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "cuentaCliente": "174978393",
  "importeRecarga": 100,
  "idTipo_Movimiento": 2,
  "folioTransaccion_Banco": "#PENDINTE",
  "idTerminal": 0
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
cuentaCliente string SÍ Número de cuenta del cliente (9 dígitos)
importeRecarga integer SÍ Monto a recargar
idTipo_Movimiento integer SÍ 2 = Recarga de saldo
folioTransaccion_Banco string SÍ Folio de transacción bancaria (#PENDINTE si es pendiente)
idTerminal integer SÍ ID de terminal (0 si no aplica)
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-23T06:16:34.199+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/recarga/recarga_saldo_cuenta_cliente"
}
✅ RESPUESTA EXITOSA (200)
{
  "idMovimiento": 25847,
  "cuentaCliente": "174978393",
  "importeRecarga": 100,
  "saldoAnterior": 500.50,
  "saldoNuevo": 600.50,
  "fechaMovimiento": "2026-02-23T06:20:00.000+00:00",
  "folioTransaccion_Banco": "#PENDINTE",
  "estado": "COMPLETADA",
  "mensaje": "Recarga realizada exitosamente"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idMovimiento integer ID único del movimiento
cuentaCliente string Número de cuenta recargada
importeRecarga integer Monto recargado
saldoAnterior decimal Saldo antes de la recarga
saldoNuevo decimal Saldo después de la recarga
estado string Estado de la transacción
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Recarga realizada exitosamente
403 Forbidden Token JWT inválido o ausente (imagen)
404 Not Found Cuenta no encontrada
400 Bad Request Datos inválidos o monto incorrecto
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · idTipo_Movimiento=2 para recarga · folioTransaccion_Banco «#PENDINTE» indica pendiente · idTerminal=0 cuando no es operación de terminal
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/transferencia/transferencia_saldo Transferencia
↔️ TRANSFERENCIA DE SALDO
Realiza una transferencia de saldo entre dos cuentas del sistema. La operación debita el monto de la cuenta origen y lo acredita en la cuenta destino.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY (EJEMPLO)
{
  "cuentaOrigen": "174978393",
  "cuentaDestino": "271872026",
  "importe": 500,
  "concepto": "Transferencia",
  "idTipo_Movimiento": 3
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
cuentaOrigen string SÍ Número de cuenta de origen (de donde se debita)
cuentaDestino string SÍ Número de cuenta de destino (donde se acredita)
importe decimal SÍ Monto a transferir
concepto string OPC Descripción de la transferencia
idTipo_Movimiento integer SÍ 3 = Transferencia entre cuentas
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-23T06:20:08.428+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/transferencia/transferencia_saldo"
}
✅ RESPUESTA EXITOSA (200)
{
  "idTransferencia": 35841,
  "cuentaOrigen": "174978393",
  "cuentaDestino": "271872026",
  "importe": 500,
  "saldoOrigenAnterior": 1500.50,
  "saldoOrigenNuevo": 1000.50,
  "saldoDestinoAnterior": 300.00,
  "saldoDestinoNuevo": 800.00,
  "fechaTransferencia": "2026-02-23T06:25:00.000+00:00",
  "estado": "COMPLETADA",
  "folio": "TRF-20260223-001"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idTransferencia integer ID único de la transferencia
cuentaOrigen string Cuenta que envió los fondos
cuentaDestino string Cuenta que recibió los fondos
importe decimal Monto transferido
estado string Estado de la transferencia
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Transferencia realizada exitosamente
403 Forbidden Token JWT inválido o ausente (imagen)
404 Not Found Cuenta origen o destino no encontrada
400 Bad Request Datos inválidos o saldo insuficiente
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · La imagen muestra error 403 por falta de token · idTipo_Movimiento=3 para transferencias · Validar saldo suficiente en cuenta origen
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/cobrosaldo/cobro_saldo_cuenta_cliente Cobro
💸 COBRO DE SALDO A CUENTA
Realiza un cobro o débito a la cuenta de un cliente por concepto de servicios o consumos. Este endpoint reduce el saldo de la cuenta según el importe del servicio.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "cta_Cliente": "271872026",
  "id_Servicio": 3,
  "id_Tipo_Movimiento": 1,
  "id_Recarga_Saldo": 0
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
cta_Cliente string SÍ Número de cuenta del cliente
id_Servicio integer SÍ ID del servicio que se está cobrando (3 en el ejemplo)
id_Tipo_Movimiento integer SÍ 1 = Cobro/Débito
id_Recarga_Saldo integer SÍ ID de recarga asociada (0 si no aplica)
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-23T06:31:41.159+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/cobrosaldo/cobro_saldo_cuenta_cliente"
}
✅ RESPUESTA EXITOSA (200)
{
  "idCobro": 45218,
  "cta_Cliente": "271872026",
  "id_Servicio": 3,
  "nombreServicio": "Pago de servicios",
  "importe": 150.00,
  "saldoAnterior": 500.50,
  "saldoNuevo": 350.50,
  "fechaCobro": "2026-02-23T06:35:00.000+00:00",
  "estado": "COMPLETADO",
  "folio": "COB-20260223-045"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idCobro integer ID único del cobro
cta_Cliente string Cuenta a la que se aplicó el cobro
id_Servicio integer ID del servicio cobrado
importe decimal Monto cobrado
saldoNuevo decimal Saldo después del cobro
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Cobro realizado exitosamente
403 Forbidden Token JWT inválido o ausente (imagen)
404 Not Found Cuenta o servicio no encontrado
400 Bad Request Saldo insuficiente o datos inválidos
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · id_Tipo_Movimiento=1 para cobros · id_Servicio=3 según ejemplo · id_Recarga_Saldo=0 cuando no está asociado a una recarga
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
GET /api/servicios/listar Servicios
📋 LISTAR SERVICIOS
Obtiene el listado completo de servicios disponibles en el sistema. Estos servicios pueden ser utilizados para realizar cobros o consultas.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
  "timestamp": "2026-02-23T06:36:44.063+00:00",
  "status": 403,
  "error": "Forbidden",
  "path": "/api/servicios/listar"
}
✅ RESPUESTA EXITOSA (200)
{
  "servicios": [
    {
      "id": 1,
      "nombre": "Pago de luz",
      "descripcion": "Servicio de pago de energía eléctrica",
      "costo": 150.00,
      "estado": "ACTIVO"
    },
    {
      "id": 2,
      "nombre": "Pago de agua",
      "descripcion": "Servicio de pago de agua potable",
      "costo": 120.00,
      "estado": "ACTIVO"
    },
    {
      "id": 3,
      "nombre": "Pago de teléfono",
      "descripcion": "Servicio de pago de telefonía fija y móvil",
      "costo": 200.00,
      "estado": "ACTIVO"
    },
    {
      "id": 4,
      "nombre": "Pago de internet",
      "descripcion": "Servicio de pago de internet",
      "costo": 180.00,
      "estado": "ACTIVO"
    },
    {
      "id": 5,
      "nombre": "Recarga de saldo",
      "descripcion": "Recarga de saldo a cuenta",
      "costo": 0.00,
      "estado": "ACTIVO"
    }
  ],
  "total": 5,
  "timestamp": "2026-02-23T06:40:00.000+00:00"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
id integer ID único del servicio
nombre string Nombre del servicio
descripcion string Descripción detallada del servicio
costo decimal Costo o tarifa del servicio
estado string Estado del servicio (ACTIVO, INACTIVO)
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Listado de servicios obtenido correctamente
403 Forbidden Token JWT inválido o ausente (imagen)
401 Unauthorized Credenciales incorrectas
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · Método GET sin body · La imagen muestra error 403 por falta de token · Los servicios listados se usan en el endpoint de cobro
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/terminal/consultaTerminal Terminal
📱 CONSULTAR TERMINAL
Consulta la información de una terminal específica por su nombre. Las terminales son dispositivos físicos utilizados para realizar cobros y operaciones RFID.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "nombreTerminal": "ARD-JUMP-01"
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
nombreTerminal string SÍ Nombre único de la terminal (ej. ARD-JUMP-01)
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
✅ RESPUESTA EXITOSA (200)
{
  "idTerminal": 5,
  "nombreTerminal": "ARD-JUMP-01",
  "serie": "TML-2024-001",
  "ubicacion": "Caja Principal - Sucursal Centro",
  "estado": "ACTIVA",
  "ultimaConexion": "2026-02-23T06:45:00.000+00:00",
  "fechaRegistro": "2024-01-15T10:00:00.000+00:00",
  "versionFirmware": "v2.1.3",
  "totalTransacciones": 1250,
  "ultimoMantenimiento": "2026-02-01T09:30:00.000+00:00"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idTerminal integer ID único de la terminal
nombreTerminal string Nombre de la terminal consultada
serie string Número de serie del dispositivo
ubicacion string Ubicación física de la terminal
estado string Estado operativo (ACTIVA, INACTIVA, MANTENIMIENTO)
versionFirmware string Versión de firmware instalada
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Terminal encontrada exitosamente
403 Forbidden Token JWT inválido o ausente
404 Not Found Terminal no encontrada con ese nombre
400 Bad Request Nombre de terminal inválido o vacío
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · nombreTerminal «ARD-JUMP-01» según ejemplo · Las terminales se utilizan para cobros RFID · El estado debe ser ACTIVO para operar
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/servicios/buscarById Servicios
🔍 BUSCAR SERVICIO POR ID
Busca y obtiene la información detallada de un servicio específico utilizando su ID único. Este endpoint complementa al listado general de servicios.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
  "idServicio": 4
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
idServicio integer SÍ ID único del servicio a consultar
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
✅ RESPUESTA EXITOSA (200)
{
  "idServicio": 4,
  "nombre": "Pago de internet",
  "descripcion": "Servicio de pago de internet residencial y empresarial",
  "costo": 180.00,
  "categoria": "Telecomunicaciones",
  "proveedor": "Proveedor de Internet S.A.",
  "tiempoEstimado": "5 minutos",
  "estado": "ACTIVO",
  "fechaRegistro": "2024-01-15T10:00:00.000+00:00",
  "requiereValidacion": true
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
idServicio integer ID único del servicio
nombre string Nombre del servicio
descripcion string Descripción detallada del servicio
costo decimal Costo o tarifa del servicio
categoria string Categoría a la que pertenece
proveedor string Nombre del proveedor del servicio
estado string Estado del servicio (ACTIVO, INACTIVO)
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Servicio encontrado exitosamente
403 Forbidden Token JWT inválido o ausente
404 Not Found Servicio no encontrado con ese ID
400 Bad Request ID inválido o formato incorrecto
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · idServicio=4 según ejemplo · Complementa al endpoint /api/servicios/listar · Los IDs corresponden al listado general
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /login Auth
🔐 LOGIN DE USUARIO
Endpoint de autenticación que permite a los usuarios iniciar sesión en el sistema. Recibe credenciales y devuelve un token JWT para autorización en otros endpoints.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación No requerida
📤 REQUEST BODY
{
  "usuario": "ozper@msn.com",
  "contraseña": "101010"
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
usuario string SÍ Correo electrónico o nombre de usuario
contraseña string SÍ Contraseña del usuario
✅ RESPUESTA EXITOSA (200 OK)
{
  "Message": "Autenticacion correcta",
  "idCliente": "83",
  "id_tipoUsuario": "1",
  "idUsuario": "57",
  "token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJtWmF0IjoxNzcxODI5MTE0LCJleHAiOjEzNSZEMTUMTR9.ivdB3Dnr-TmrjM9xgBMjRINAcu6E9o20akSCBPNnYfs"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
Message string Mensaje de confirmación
idCliente string ID del cliente asociado
id_tipoUsuario string Tipo de usuario (1 = administrador)
idUsuario string ID del usuario autenticado
token string Token JWT para autorización
⚠️ RESPUESTA ERROR (401)
{
  "timestamp": "2026-02-23T07:00:00.000+00:00",
  "status": 401,
  "error": "Unauthorized",
  "message": "Credenciales incorrectas",
  "path": "/login"
}
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Login exitoso, token generado
401 Unauthorized Credenciales incorrectas
400 Bad Request Campos faltantes o formato inválido
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint público (no requiere token) · Usar credenciales válidas · El token recibido debe usarse en header Authorization para otros endpoints · id_tipoUsuario=1 = administrador
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/cuentacliente/obtenerNocuenta_idCliente Cuenta
🔢 OBTENER NÚMERO DE CUENTA POR ID CLIENTE
Obtiene el número de cuenta asociado a un cliente específico utilizando su ID. Este endpoint es útil para recuperar la cuenta principal de un cliente.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
    "id_Cliente": 68
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id_Cliente integer SÍ ID único del cliente
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
    "timestamp": "2026-02-23T06:49:40.342+00:00",
    "status": 403,
    "error": "Forbidden",
    "path": "/api/cuentacliente/obtenerNocuenta_idCliente"
}
✅ RESPUESTA EXITOSA (200)
{
    "id_Cliente": 68,
    "noCuenta": "386084524",
    "tipoCuenta": "Ahorros",
    "fechaApertura": "2024-01-15T10:00:00.000+00:00",
    "estado": "ACTIVA",
    "saldo": 5000.00,
    "moneda": "MXN"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
id_Cliente integer ID del cliente confirmado
noCuenta string Número de cuenta del cliente
tipoCuenta string Tipo de cuenta (Ahorros, Cheques, etc.)
estado string Estado de la cuenta (ACTIVA, INACTIVA)
saldo decimal Saldo actual de la cuenta
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Número de cuenta obtenido exitosamente
403 Forbidden Token JWT inválido o ausente (imagen)
404 Not Found Cliente no encontrado o sin cuenta asociada
400 Bad Request ID de cliente inválido o vacío
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · id_Cliente=68 según ejemplo · El 403 en imagen indica token requerido · Un cliente puede tener múltiples cuentas
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
POST /api/usuario/Consulta_Two_Factor 2FA
🔍 CONSULTAR ESTADO TWO FACTOR
Consulta el estado de la autenticación de dos factores (2FA) para un usuario específico. Obtiene información sobre si el 2FA está activado y la clave asociada.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación Bearer Token
📤 REQUEST BODY
{
    "id_Usuario": 42
}
📋 CAMPOS DEL REQUEST
Campo Tipo Req Descripción
id_Usuario integer SÍ ID único del usuario
🔐 HEADERS REQUERIDOS
Header Valor Req
Authorization Bearer {token} SÍ
Content-Type application/json SÍ
⚠️ RESPUESTA ERROR (403)
{
    "timestamp": "2026-02-23T06:52:00.741+00:00",
    "status": 403,
    "error": "Forbidden",
    "path": "/api/usuario/Consulta_Two_Factor"
}
✅ RESPUESTA EXITOSA (200)
{
    "id_Usuario": 42,
    "factorKey": 826638,
    "estado": "ACTIVO",
    "fechaActivacion": "2024-01-15T10:00:00.000+00:00",
    "ultimoUso": "2026-02-22T22:53:17.903+00:00",
    "metodo2FA": "APP",
    "intentosFallidos": 0
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
id_Usuario integer ID del usuario consultado
factorKey integer Clave 2FA del usuario
estado string Estado del 2FA (ACTIVO, INACTIVO)
fechaActivacion string Fecha de activación del 2FA
metodo2FA string Método de 2FA (APP, SMS, EMAIL)
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Información 2FA obtenida exitosamente
403 Forbidden Token JWT inválido o ausente (imagen)
404 Not Found Usuario no encontrado
400 Bad Request ID de usuario inválido
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint requiere autenticación · id_Usuario=42 según ejemplo · El 403 en imagen indica token requerido · Complementa a los endpoints de 2FA key y verificación
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
GET /actuator/info Infra
ℹ️ INFORMACIÓN DEL MICROSERVICIO
Endpoint de Spring Boot Actuator que proporciona información general del microservicio. Incluye nombre, versión, descripción y autor del proyecto.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación No requerida
✅ RESPUESTA EXITOSA (200)
{
    "app": {
        "name": "bs_probank_ms",
        "description": "aqui debes escribir una descripcion del proyecto",
        "version": "1.0"
    },
    "author": "BALAM SOFTWARE"
}
📋 CAMPOS DE RESPUESTA
Campo Tipo Descripción
app.name string Nombre del microservicio
app.description string Descripción del proyecto (pendiente de definir)
app.version string Versión actual del microservicio
author string Autor o empresa desarrolladora
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK Información obtenida correctamente
401 Unauthorized Si el endpoint estuviera asegurado (no es el caso)
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint público (no requiere autenticación) · La descripción está pendiente de actualizar · Información de metadatos del microservicio · Endpoint de Spring Boot Actuator
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0
GET /actuator/health Infra
🩺 ESTADO DE SALUD DEL MICROSERVICIO
Endpoint de Spring Boot Actuator que proporciona información sobre el estado de salud del microservicio. Verifica la conectividad a base de datos, espacio en disco y componentes personalizados.
URL Base uat-ms-probank-ms:7600
Content-Type application/json
Autenticación No requerida
✅ RESPUESTA EXITOSA (200) – HEALTHY
{
  "status": "UP",
  "components": {
    "db": {
      "status": "UP",
      "details": {
        "database": "MySQL",
        "validationQuery": "isValid()"
      }
    },
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 51460472832,
        "free": 33199120384,
        "threshold": 10485760,
        "exists": true
      }
    },
    "ping": {
      "status": "UP"
    },
    "probank": {
      "status": "UP"
    }
  }
}
📋 CAMPOS DE RESPUESTA
Componente Estado Detalles
status UP Estado general del servicio
db UP Base de datos MySQL conectada
diskSpace UP Espacio en disco: 33.2GB libres / 51.5GB totales
ping UP Endpoint de ping
probank UP Componente personalizado del microservicio
⚠️ RESPUESTA DE ERROR (503 – DOWN)
{
  "status": "DOWN",
  "components": {
    "db": {
      "status": "DOWN",
      "details": {
        "error": "Cannot connect to database",
        "database": "MySQL"
      }
    },
    "diskSpace": {
      "status": "UP",
      "details": {
        "total": 51460472832,
        "free": 33199120384,
        "threshold": 10485760,
        "exists": true
      }
    }
  }
}
📊 CÓDIGOS DE RESPUESTA
Código Descripción Solución
200 OK – UP Servicio funcionando correctamente
503 Service Unavailable – DOWN Servicio no disponible o componente fallando
500 Internal Error Error en el servidor
📌 NOTAS IMPORTANTES: Endpoint público (no requiere autenticación) · status «UP» = todo bien, «DOWN» = problema · db: verifica conexión a MySQL · diskSpace: monitorea espacio disponible · probank: componente personalizado
⚡ ProBank – e-Lana 📚 Documentación Técnica v1.0.0

About balam

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Powered by Balam Software | Designed by TieLabs
© Copyright 2026, All Rights Reserved