Prima-Back
    Prima-Back
    • API DOCUMENTATION
    • Principal
      • /
        GET
    • Modulo Administradores
      • Vendedores Operaciones
        • Registro de Vendedores
        • Visualizar Vendedores
        • Visualizar Vendedores por Mongo ID
        • Visualizar Vendedores por cedula
        • Actualizar Vendedor
        • Eliminar Vendedor
      • Estadisticas
        • Estadisticas de documentos
        • Visualizacion de top Vendedores
        • Visualizar Ventas por Vendedor
      • Login Administradores
        POST
      • Recuperacion de contraseña Administrador
        POST
    • Modulo Vendedores
      • Inicio de Sesión Vendedores
        POST
      • Confirmación de Cuenta
        GET
      • Solicitud de restablecimiento de contraseña
        POST
      • Restablecimiento de contraseña
        POST
    • Modulo Clientes
      • Registrar Cliente
        POST
      • Visualizar Clientes
        GET
      • Visualizar Clientes por RUC
        GET
      • Actualizar Cliente
        PATCH
      • Eliminar Cliente
        DELETE
    • Modulo Productos
      • Crear Producto
        POST
      • Visualizar Productos
        GET
      • Visualizar Productos por ID
        GET
      • Actualizar Producto
        PATCH
      • Eliminar Producto
        DELETE
    • Modulo Pedidos
      • Crear Orden
        POST
      • Visualizar Ordenes
        GET
      • Visualizar Ordenes por ID
        GET
      • Actualizar Orden
        PATCH
      • Actualizar Estado de Orden
        PATCH
      • Eliminar Orden
        DELETE

    API DOCUMENTATION

    📚 PRIMA S.A. API#

    Bienvenido a la documentación de la API RESTful de PRIMA S.A. Aquí encontrarás toda la información necesaria para integrar y consumir nuestros servicios de gestión de ventas, inventario y relaciones con clientes.

    🛠️ Repositorio#

    Este proyecto está disponible en GitHub, donde encontrarás el código fuente completo, ejemplos y guías de configuración:
    GitHub - PRIMA S.A.

    🌍 Visión General#

    PRIMA S.A. es una empresa dedicada a la comercialización de materiales de construcción y servicios asociados. Nuestra API permite a aplicaciones externas manejar de forma programática:
    Autenticación de administradores y vendedores mediante JSON Web Tokens (JWT).
    Gestión de clientes: alta, consulta, actualización y estado de clientes (RUC, dirección, crédito).
    Gestión de productos: catálogo de productos con stock, precios, imágenes y unidades de medida.
    Procesamiento de órdenes: creación, listado, filtrado, actualización de estado y eliminación de órdenes.
    Administración de vendedores: registro, actualización y eliminación de perfiles de vendedores.
    Estadísticas y reportes: métricas básicas de ventas, inventario y actividad de usuarios.
    Manejo de archivos a través de Cloudinary para imágenes de productos.

    🔑 Características Principales#

    ✅ Seguridad: autenticación con JWT (expiración de 8 horas), cifrado de contraseñas con bcryptjs y validación de entradas con express-validator.
    🚀 Escalabilidad: arquitectura modular en Node.js + Express, con carpetas separadas para controladores, rutas, modelos y middlewares.
    🌐 Flexible: CORS habilitado para integraciones desde distintas aplicaciones front-end.
    🧪 Probada: suite de tests con Jest y Supertest para asegurar la calidad del API en entornos de desarrollo y producción.

    📘 Cómo usar esta documentación#

    1.
    Navega por la barra lateral para explorar los distintos recursos (Auth, Admin, Clients, Products, Orders, Sellers, Stats).
    2.
    Ejecuta ejemplos de petición directamente desde APIDOG para probar respuestas en vivo.
    3.
    Consulta los modelos de datos y los esquemas de request/response al final de cada sección.
    4.
    Encuentra escenarios de ejemplo en la sección “Examples” para flujos comunes (CRUD completo, autenticación, recuperación de contraseña).
    Modified at 2025-04-26 00:34:04
    Next
    /
    Built with