Bienvenido
¿Qué es WRestaurantAPI?
Restaurant API es una capa de integración que se instala directamente en el servidor de punto de venta del restaurante (el mismo equipo donde corre Soft Restaurant) y expone, a través de endpoints REST, la información que normalmente solo vive dentro de la base de datos local del POS (SQL Server).
En otras palabras: convierte los datos de tu Soft Restaurant —menú, productos, ventas, mesas, cortes, etc.— en información que cualquier aplicación externa (un sitio web, una app de pedidos, un dashboard, una integración con un tercero) puede consultar de forma segura mediante peticiones HTTP, sin necesidad de tocar la base de datos directamente.
Arquitectura general
El diagrama siguiente resume cómo se comunican las tres piezas del sistema:
| # | Paso | Descripción |
|---|---|---|
| 1 | El usuario final hace una petición | Una aplicación cliente (en el diagrama, representada por Node.js, aunque puede ser cualquier tecnología capaz de hacer peticiones HTTP) llama a un endpoint de Restaurant API. |
| 2 | Restaurant API solicita los datos | La API, que vive en el mismo servidor que Soft Restaurant, consulta directamente la base de datos SQL Server de Soft Restaurant. |
| 3 | Soft Restaurant regresa la información | SQL Server responde con los datos crudos solicitados (productos, ventas, existencias, etc.). |
| 4 | Restaurant API responde al usuario final | La API transforma esos datos en una respuesta JSON estandarizada y se la entrega a la aplicación cliente. |
Este flujo es importante porque significa tres cosas para ti como integrador:
- No necesitas acceso directo a la base de datos del restaurante. Toda la comunicación pasa por la API, que actúa como intermediario seguro y controlado.
- La API corre localmente, dentro del mismo servidor de punto de venta, por lo que refleja la información en tiempo real, tal como está en Soft Restaurant en ese momento.
- Instalar el ejecutable que viene en el manual de como instalarlo para crear el tunel entre tu restaurante y la API.
Antes de empezar
Antes de hacer tu primera llamada a la API, necesitas completar los siguientes pasos:
Paso 1 - Crear su cuenta en WRestaurantAPI
Para comenzar, acceda a wrestaurantapi.com y cree su cuenta.
Registrar credenciales: Accione el botón "Iniciar Sesión", posteriormente seleccione "Crear cuenta" e ingrese credenciales.
Verifique Correo Electrónico e Inicie Sesión.
Paso 2 - Seleccionar plan
Ingrese a la sección Suscripción y seleccione un plan.
Complete el onboarding de cobro proporcionado por Stripe
Vuelve a wrestaurantapi.com
Se actualizará la interfaz con su suscripción generada.
Paso 3 - Crear Worker
Ingrese a la sección "Workers"
Selecciona la opción "Nuevo Worker"
"Ingrese el nombre del punto de venta y seleccione Crear Worker."
Dependiendo del plan previamente seleccionado, el usuario tendrá un límite de generación de workers, si este excede su límite, el sistema generará una advertencia, en la que se le explique al usuario que, de generar un worker fuera de su límite se generará un cobro extra. El cobro se realizará una vez que el worker haya instalado.
Advertencia de límite de workers alcanzados:
Vista de workers generados:
Paso 4 - Creación de API Key
El usuario deberá dirigirse a la sección "API keys" y presionar el botón "Nueva API Key".
Deberá asignar un nombre y presionar el botón generar.
Importante: Copie la API Key antes de cerrar esta ventana. Una vez cerrada, no será posible recuperarla.
Deberá usar su API Key para consumir los endpoints o el SDK de WRestaurantAPI
Paso 5 - Proceso de instalación
5.1 Descargar Instalador de worker
Navegue a /Workers
Seleccione el botón desplegable "Descargar agente para Windows" y asegúrese de siempre descargar la versión mas actual.
La versión mas actual será la que aparezca al comienzo del listado y con la etiqueta "Nuevo" de color verde.
Debe seleccionar la versión del sistema operativo: x64 o x86.
5.2 Proceso de instalación en el punto de venta
Navegue por su explorador de archivos hasta encontrar el archivo comprimido de wrestaurantapi
Descomprima el archivo en una carpeta
Seleccione la carpeta y busque el instalador "wrestaurant"
Abrir como administrador
Ingrese los datos correspondientes:
- Servidor SQL y Base de datos se encuentran principalmente en la aplicación "Multiempresas"
- Usuario y Contraseña estarán preestablecidos
- Clave de licencia: Pegue su API Key.
- Versión POS: Seleccione la versión del softrestaurant asociada a su punto de venta.
Después de llenar todos los campos, presione "Instalar".
Al terminar la instalación visualizará el dashboard del instalador:
Para desinstalar el agente, abra el instalador como administrador y presione el botón Desinstalar (color rojo). El sistema eliminará todos los componentes instalados.
Eliminará todo rastro del Worker:
- Servicio
- Registros de la api
- Configuración de carpetas
- Rastros de archivos (instalador, .exe y complementos)
¿Por qué motivo necesitará desinstalar WRestaurantAPI?
- Cambio de versión.
- Reinstalación forzosa.