La integración con la plataforma de QBMedica se realiza mediante llamadas REST
utilizando el formato JSON para el intercambio de datos.
Todas las peticiones requieren
autenticación mediante una ApiKey que debe enviarse en el header de cada solicitud.
Flujo básico de integración:
-
Verificar ApiKey (Solo primera vez)
Endpoint: (GET) /api/verificarapikey
Validar que la clave de acceso sea correcta usando el endpoint.
Este paso confirma que su sistema está autorizado.
-
Crear Paciente
Endpoint: (POST) /api/paciente/crear
Una vez autenticado, puede crear un nuevo paciente
Obtendrá el IdPaciente necesario para agendar citas.
-
Consultar paciente
Endpoint: (POST) /api/paciente/consultar
Con este Endpoint puede buscar Pacientes por cédula o nombres.
Obtendrá el IdPaciente necesario para agendar citas.
-
Consultar consultorios
Endpoint: (POST) api/consultorios/consultar
Para poder agendar una cita es necesario tener el ID del consultorio y el ID del profesional.
Este método devuelve un JSON con todos los consultorios y profesionales existentes en el sistema.
Obtendrá el IdConsultorio e IdProfesional necesarios para agendar citas.
-
Agendar cita médica
Endpoint: (POST) /api/cita/crear
Con el IdPaciente, IdConsultorio e IdProfesional
puede crear una cita en el sistema, lo cual verificará automáticamente la disponibilidad horaria y devolverà la respuesta correspondiente (Cita agendada o cupo no disponible)
-
Consultar citas agendadas
Endpoint: (POST) /api/cita/consultar
Puede recuperar las citas de un paciente en un rango de fechas filtrando por IdPaciente o por
número de cédula.
-
Confirmar una cita
Endpoint: (POST) /api/cita/confirmar
Permite confirmar una cita previamente agendada mediante el Id de la cita, actualizando su estado a Confirmada.
-
Cancelar una cita
Endpoint: (POST) /api/cita/cancelar
Permite cancelar una cita previamente agendada mediante el Id de la cita. La cita dejará de estar disponible para la agenda del paciente.
Cada paso depende del anterior y utiliza el ID generado en la respuesta:
- Para crear una cita, necesita el
IdPaciente IdConsultorio IdProfesional obtenido al crear o consultar el Paciente y Consultorios.
- Para consultar citas, necesita el
IdPaciente o la CedulaPaciente.
- Todas las operaciones requieren una ApiKey válida verificada previamente.
💡 Nota importante: La ApiKey debe enviarse siempre en el header de la petición con el nombre
ApiKey.
Nunca la envíe como parámetro en la URL por razones de seguridad.