Copy page

SDKs

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
npm install @wrestaurant/sdk
# o: pnpm add @wrestaurant/sdk
# o: yarn add @wrestaurant/sdk

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
import { WrestaurantApiClient } from "@wrestaurant/sdk";

const client = new WrestaurantApiClient({
  apiKey: process.env.WRESTAURANT_API_KEY!, // wrst_live_...
});

Consejo: nunca incrustes tu API key en código de cliente (navegador/app). Mantenla en el servidor o en variables de entorno.

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
const productos = await client.endpoints.getProducts({
  licenseKey: "DS5D2368HCME4O9X",
  page: 1,
  pageSize: 100,
});

console.log(productos.totalResults, productos.products);

Paginación

Los endpoints de listado devuelven page, pageSize, totalPages y hasNextPage. Itera hasta agotar las páginas:

Code
let page = 1;
const all = [];

while (true) {
  const res = await client.endpoints.getProducts({
    licenseKey: "DS5D2368HCME4O9X",
    page,
    pageSize: 100,
  });
  all.push(...(res.products ?? []));
  if (!res.hasNextPage) break;
  page++;
}

Crear una orden

Code
const orden = await client.endpoints.createTempOrders({
  licenseKey: "DS5D2368HCME4O9X",
  mesa: "12",
  noPersonas: 2,
  productos: [
    { idProducto: "P001", cantidad: 2 },
  ],
});

console.log(orden.folio);

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
import { WrestaurantApiClient, WrestaurantApiError } from "@wrestaurant/sdk";

try {
  await client.endpoints.getProducts({ licenseKey: "DS5D2368HCME4O9X" });
} catch (err) {
  if (err instanceof WrestaurantApiError) {
    console.error(err.statusCode, err.body); // p. ej. 429 -> límite excedido
  } else {
    throw err;
  }
}

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 bajo client.endpoints. 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.