SYSTEM OPERATIONAL

VÖLVÏD API

Portal Profesional de Documentación de la API REST de Volvid. Administre clínicas veterinarias y los accesos para la prueba gratuita de 14 días.

Base URL
http://www.api.volvidmascotas.com
Version
1.0.0 (Latest)
Authentication
JWT Bearer Token
Core API Endpoints
Format: JSON
Method Endpoint Description Security
POST /api/auth/register Registra una nueva veterinaria y su usuario administrador. Activa la prueba de 14 días. PUBLIC
POST /api/auth/login Inicia sesión y genera un Bearer JWT token, devolviendo la fecha de expiración de la prueba. PUBLIC
POST /api/auth/register-owner Registra o inicia sesión a un propietario de mascotas (formulario tradicional o Google OAuth). PUBLIC
POST /api/auth/forgot-password Solicita la recuperación de contraseña enviando las instrucciones al correo electrónico del usuario. PUBLIC
POST /api/auth/reset-password Restablece la contraseña del usuario validando el token de recuperación y actualizando la base de datos. PUBLIC
GET /api/breeds Consulta el catálogo de razas de perros o gatos filtradas por tipo. PUBLIC
POST /api/pets Registra una mascota (nombre, tipo, foto, edad, color, temperamento, estado, observaciones) vinculada al propietario autenticado. JWT OWNER
GET /api/clients/search Busca propietarios y sus mascotas por coincidencia de cédula, teléfono o nombre para vinculación bajo demanda. PUBLIC
POST /api/clients/link Vincula un paciente (mascota y propietario) a una veterinaria específica. PUBLIC
GET /api/clients/clinic/:clinicId Obtiene la lista de pacientes y propietarios vinculados exclusivamente a la clínica indicada. PUBLIC
POST /api/clients/register-and-link Registra un nuevo propietario y mascota en Volvid y los vincula automáticamente a la veterinaria. PUBLIC
GET /api/vets/clinic/:clinicId Obtiene la lista de veterinarios activos registrados en una clínica específica. PUBLIC
POST /api/vets Registra un nuevo veterinario vinculado a la clínica con su tarjeta profesional y especialidad. PUBLIC
POST /api/medical-records Crea una nueva Historia Clínica asignando consecutivo exclusivo por clínica (ej. HC-0001) con examen físico, diagnóstico y receta. PUBLIC
GET /api/medical-records/pet/:petId Consulta el historial clínico cronológico completo de una mascota. PUBLIC
GET /api/medical-records/consecutive/:clinicId Obtiene el siguiente número de consecutivo correlativo (ej. HC-0001) para una veterinaria. PUBLIC
POST /api/appointments Programa una nueva cita médica para un paciente vinculado a la clínica con fecha, hora y veterinario asignado. PUBLIC
GET /api/appointments/clinic/:clinicId Obtiene la agenda y calendario de citas de la clínica con filtros por fecha, mes y estado. PUBLIC
PUT /api/appointments/:id/status Actualiza el estado de la cita (scheduled, waiting, in-progress, completed, cancelled). PUBLIC
GET /api/pets Obtiene la lista de mascotas registradas por el propietario autenticado. JWT OWNER
POST /api/pets/:id/report-lost Reporta una mascota como extraviada (Alerta SOS), activando modo rescate y aviso comunitario. JWT OWNER
POST /api/pets/:id/mark-found Marca la mascota como encontrada y desactiva la alerta SOS. JWT OWNER
GET /api/pets/lost Feed público de todas las mascotas actualmente reportadas como extraviadas. PUBLIC
POST /api/service-providers/register Registra una nueva postulación como paseador y/o transportador de mascotas con documentos de verificación. PUBLIC / OWNER
GET /api/service-providers/my-status Consulta el estado actual de postulación y verificación de antecedentes del prestador. PUBLIC / OWNER
POST /api/admins/register Registra un nuevo Administrador de la Plataforma Volvid (superadmin, admin o soporte). PUBLIC
POST /api/admins/login Inicia sesión como Administrador de Volvid y genera token JWT Bearer con rol volvid_admin. PUBLIC
GET /api/admins/profile Obtiene los datos del perfil y permisos del administrador autenticado. JWT ADMIN
GET /api/admins Lista todos los administradores registrados en la plataforma Volvid. JWT ADMIN
PUT /api/admins/:id/status Actualiza el estado de un administrador (active, inactive, suspended). JWT ADMIN
GET /api/admins/pets Catálogo maestro de todas las mascotas registradas en Volvid con dueño, raza, estado y código QR. JWT ADMIN
GET /api/admins/pets/:id Consulta la ficha técnica completa de una mascota con historias clínicas, citas y datos de contacto. JWT ADMIN
GET /api/admins/pets/:id/qr Obtiene y genera el código QR oficial de Volvid en alta definición para descarga e impresión. JWT ADMIN
GET /api/admins/owners Lista todos los usuarios y propietarios registrados con conteo de mascotas y fecha de alta. JWT ADMIN
GET /api/admins/clinics Lista todas las clínicas veterinarias registradas con estado de prueba gratuita y métricas operativas. JWT ADMIN
GET /api/admins/vets Lista todos los médicos veterinarios y sus clínicas asignadas. JWT ADMIN
GET /api/admins/stats Métricas globales en tiempo real del ecosistema Volvid para el Dashboard de Administración. JWT ADMIN
Explorar API Interactiva (Swagger UI)