SDK de TypeScript / JavaScript
El SDK oficial de W Restaurant para TypeScript y JavaScript es un cliente tipado que cubre todos los endpoints de la API, con autocompletado y tipos de extremo a extremo. Mantente al día actualizando el paquete con tu gestor de dependencias.
- Paquete:
@wrestaurant/sdk - Tipado: TypeScript de extremo a extremo (también funciona en JavaScript puro)
- Entornos: Node.js, Deno, Bun y navegadores con
fetch
Instalación
Code
Configura el cliente
El cliente se autentica con tu API key (wrst_live_…), que se envía en la cabecera
X-Api-Key en cada solicitud. Consulta Autenticación para obtener una.
Code
Consejo: nunca incrustes tu API key en código de cliente (navegador/app). Mantenla en el servidor o en variables de entorno.
Organización del cliente
Los métodos están agrupados por recurso del Punto de Venta, con la forma
client.<grupo>.<método>. Por ejemplo, client.productos.getProducts o
client.turnos.openShift. Cada grupo corresponde a una sección de la
Referencia API.
Tu primera llamada
Cada endpoint recibe la license key de la sucursal (16 caracteres, p. ej.
DS5D2368HCME4O9X). Consulta Sucursales para entender las license keys.
Code
Paginación
Los endpoints de listado devuelven page, pageSize, totalPages y hasNextPage.
Itera hasta agotar las páginas:
Code
Crear una orden
Las órdenes abiertas (cuentas en curso) viven en client.ordenes. Las órdenes ya
cerradas (cheques) se consultan con client.cheques.
Code
Manejo de errores
Las respuestas con error (401, 404, 429, …) lanzan una excepción tipada
WrestaurantApiError con el código de estado y el cuerpo de la respuesta.
Code
Consulta Límites de uso y Errores para los códigos y cabeceras de control de tasa.
Métodos disponibles
Cada endpoint de la API tiene su método equivalente dentro de su grupo. Todos los
métodos reciben un solo objeto con los parámetros de ruta (como licenseKey), los de
consulta y los campos del cuerpo. La lista completa, con todos los parámetros y tipos de
respuesta, está en la Referencia API. Cada endpoint incluye el ejemplo listo
para copiar con el SDK.
| Grupo | Métodos |
|---|---|
client.productos | getProducts, updateProduct, getBestSellers |
client.grupos | getGrupos, getSubgrupos |
client.estaciones | getStations |
client.mesas | getMesas |
client.meseros | getMeseros, authenticateMesero |
client.clientes | getClientes |
client.empresas | getEmpresas |
client.turnos | getTurnos, openShift, closeShift |
client.asistencias | getAsistencias |
client.formasDePago | getPaymentMethods |
client.tiposDescuento | getTiposDescuento |
client.ordenes | createTempOrders, getTempOrders, getOpenOrders, getTempOrderDetails, addOrderItems, cancelOrderItems, applyOrderDiscount, applyItemDiscounts, renameOrder, assignOrderClient, printOpenOrder, closeOpenOrder, createClosedTempOrder |
client.cheques | getOrders, searchOrders, getOrderDetails, getDayOrders |
client.facturas | getFacturaXml |
client.impresoras | listPrinters, getPrinter, createPrinter, updatePrinter, deletePrinter, getPrinters, printOrder, printTest |
client.puntosDeVenta | getTicketHeader, updateTicketHeader |
Migrar desde la versión 0.x
A partir de la versión 1.0.0, los métodos que estaban en client.endpoints se
movieron a su grupo. Los nombres de los métodos no cambian, solo el grupo:
Code
Los métodos de client.impresoras no cambian.