Obtener y Actualizar Usuarios

Esta sección documenta los endpoints para obtener y actualizar información de usuarios en MEDISMART 3.0.

URLs Base

• Entorno QA: https://qa-serv.medibuslive.com
• Entorno de Producción: https://serv.medibuslive.com

Headers Requeridos

Content-Type: application/json
Authorization: Bearer {access_token}

Nota: El access_token debe ser obtenido previamente mediante el endpoint de autenticación OAuth2 documentado en la Referencia API.

Obtener Usuario

Este endpoint permite obtener información de un usuario mediante su email o username.

Endpoint

GET /backoffice/api/client/users

Parámetros de Consulta

*Importante: Al menos uno de los dos parámetros (email o username) debe ser enviado en la solicitud. Ambos son opcionales individualmente, pero no pueden omitirse simultáneamente.

Ejemplos de Solicitud

Opción 1: Buscar por email

curl --location 'https://qa-serv.medibuslive.com/backoffice/api/client/users?email=rojash.camiloe@gmail.com' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Opción 2: Buscar por username

curl --location 'https://qa-serv.medibuslive.com/backoffice/api/client/users?username=198801151' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Respuesta Exitosa

{
    "success": true,
    "message": "User found successfully",
    "data": {
        "userId": "c3410674-2698-4f5c-982a-f0d5a0e891f9",
        "email": "rojash.camiloe@gmail.com",
        "username": "198801151",
        "firstName": "Camilo",
        "lastName": "Rojas",
        "active": true,
        "verified": true
    }
}

Descripción de la Respuesta

• success: Indica si la solicitud fue exitosa (true) o falló (false)
• message: Mensaje descriptivo del resultado de la operación
• data.userId: Identificador único del usuario (UUID)
• data.email: Correo electrónico del usuario
• data.username: Nombre de usuario en el sistema
• data.firstName: Primer nombre del usuario
• data.lastName: Apellido del usuario
• data.active: Indica si la cuenta del usuario está activa
• data.verified: Indica si el correo electrónico del usuario ha sido verificado

Actualizar Usuario

Este endpoint permite actualizar información de un usuario existente.

Endpoint

PATCH /backoffice/api/client/users/{userId}

Parámetros de Ruta

Cuerpo de la Solicitud

Todos los campos son opcionales. Solo se actualizarán los campos que se envíen en la solicitud.

{
    email?: string;        // Correo electrónico (debe ser válido)
    firstName?: string;    // Primer nombre
    lastName?: string;     // Apellido
    phoneNumber?: string;  // Número de teléfono
}

Validaciones

• email: Debe ser un correo electrónico válido si se proporciona
• firstName: Debe ser una cadena de texto si se proporciona
• lastName: Debe ser una cadena de texto si se proporciona
• phoneNumber: Debe ser una cadena de texto si se proporciona

Ejemplo de Solicitud

curl --location --request PATCH 'https://qa-serv.medibuslive.com/backoffice/api/client/users/c3410674-2698-4f5c-982a-f0d5a0e891f9' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data-raw '{
    "email": "rojash.camiloe@gmail.com",
    "phoneNumber": "+56959218752"
}'

Ejemplo con Múltiples Campos

curl --location --request PATCH 'https://qa-serv.medibuslive.com/backoffice/api/client/users/c3410674-2698-4f5c-982a-f0d5a0e891f9' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data-raw '{
    "email": "nuevo.email@example.com",
    "firstName": "Juan",
    "lastName": "Pérez",
    "phoneNumber": "+56912345678"
}'

Respuesta Exitosa

{
    "success": true,
    "message": "User updated successfully",
    "data": {
        "userId": "c3410674-2698-4f5c-982a-f0d5a0e891f9",
        "email": "rojash.camiloe@gmail.com",
        "username": "198801151",
        "firstName": "Camilo",
        "lastName": "Rojas",
        "phoneNumber": "+56959218752",
        "active": true,
        "verified": true
    }
}

Respuesta de Error

{
    "success": false,
    "message": "User not found"
}

O si hay errores de validación:

{
    "success": false,
    "message": "Validation failed",
    "errors": [
        {
            "field": "email",
            "message": "email must be an email"
        }
    ]
}

Descripción de la Respuesta

• success: Indica si la solicitud fue exitosa (true) o falló (false)
• message: Mensaje descriptivo del resultado de la operación
• data: Objeto con la información actualizada del usuario
• errors: (Solo en caso de error) Array con los errores de validación específicos

Notas Importantes

1. Autenticación: Todos los endpoints requieren un token de acceso válido en el header Authorization
2. Actualización Parcial: El endpoint PATCH solo actualiza los campos enviados, los demás campos permanecen sin cambios
3. Validación de Email: Si se actualiza el email, debe ser un formato válido
4. Identificador de Usuario: El userId debe ser un UUID válido para el endpoint de actualización