Ir directamente al contenido
Español
Más asistencia técnica
Ponte en contacto
  • No hay sugerencias porque el campo de búsqueda está vacío.

📡 Arquitectura y uso de la REST API en ValueStreamer

Este artículo explica la arquitectura técnica de la REST API de ValueStreamer, su integración en entornos de clientes y cómo acceder a la documentación correspondiente de la API. Se muestra cómo conectar sistemas externos (por ejemplo, ERP, MES) a través de una middleware, se describen los formatos de interfaz soportados y se explica el uso de la REST API en la práctica diaria, incluyendo el acceso a archivos de documentación (PDF y YAML).

🔍 Contenido

  • Arquitectura del sistema

  • Funcionamiento de la integración con middleware

  • Acceso y documentación de la API

  • Consejos y buenas prácticas

  • Preguntas frecuentes (FAQ)

🛠️ ¿Cómo funciona?

🏗️ Arquitectura del sistema

  • ValueStreamer opera en la nube de Microsoft Azure.

  • La aplicación tiene una arquitectura modular:

    • El acceso a la base de datos está encriptado (SSL) hacia una base de datos MySQL en Azure.

    • 📸 Captura de pantalla: Vista general de la arquitectura
      (Coloca aquí directamente la captura:
      architecture-overview)

🔗 Integración de sistemas externos vía middleware

  • La REST API actúa de forma pasiva: espera solicitudes de sistemas externos o middleware, pero no ofrece mecanismos de push/pull activos.

Pasos del proceso:

  1. El sistema del cliente (por ejemplo, MES, ERP) envía datos al middleware.

  2. El middleware procesa, transforma y mapea los datos.

  3. El middleware transmite los datos en formato JSON a través de la REST API a ValueStreamer.

  4. Las respuestas también se realizan mediante la API.

ℹ️ Nota:

  • No hay acceso a sistemas externos desde ValueStreamer mediante la API.

  • Sólo se soporta el formato JSON (no XML).

  • Todos los accesos a la API requieren autenticación ("HTTP Basic Auth").

📚 Acceso y documentación de la API

  • Los endpoints están agrupados por módulos (por ejemplo, KPIs, tareas, desviaciones, acciones correctivas).

Ejemplos de archivos de documentación:

✨ Consejo:
Puedes cargar los archivos .yaml directamente en Swagger UI o Swagger Editor para probar los endpoints de la API de forma interactiva y generar automáticamente código de cliente.

✨ Consejos y buenas prácticas

  • 💡 Comienza con una simple prueba GET en Postman para verificar el acceso a la API.

  • 📌 Asegúrate de mantener nombres de campos consistentes si usas campos personalizados.

  • 📄 Usa los archivos .yaml para integrar clientes de forma automatizada.

  • 🛠️ Implementa logs dedicados en el middleware para detectar errores de API de manera temprana.

  • ✅ Prueba todas las integraciones de la API en un entorno seguro antes de pasar a producción.

❓ Preguntas frecuentes (FAQ)

¿La sincronización con ERP o MES es automática?
No, la integración se realiza exclusivamente mediante middleware del cliente o herramientas de terceros.

¿Puedo acceder directamente a la API sin middleware?
Sí, por ejemplo, usando Postman o scripts propios. Sin embargo, para uso productivo, se recomienda el uso de middleware.

¿Existen webhooks o disparadores basados en eventos desde ValueStreamer?
No, la REST API es puramente pasiva. Actualmente no hay mecanismos orientados a eventos.