CartamaticPOS SDK

Instalación

Cómo instalar @cartamatic/pos-sdk desde GitHub Packages y preparar un consumidor server-side.

@cartamatic/pos-sdk es un package privado publicado en GitHub Packages.

Package privado

El repo consumidor necesita acceso a GitHub Packages de Cartamatic y un token con read:packages guardado fuera del repo.

Instalar package

Usa pnpm en repos Cartamatic.

pnpm add @cartamatic/pos-sdk

El repo consumidor debe tener acceso de lectura a packages de la organización Cartamatic.

Configurar registry

Configura el registry del scope @cartamatic.

@cartamatic:registry=https://npm.pkg.github.com

El token de lectura de packages debe venir desde el mecanismo seguro del entorno: GitHub Actions secrets, Vercel environment variables o configuración local no commiteada. Nunca guardes tokens en el repo.

.npmrc
package.json

Requisitos runtime

RequisitoDetalle
Node>=22.13 según package.json del SDK.
EntornoServer-side: route handlers, server actions, jobs o servicios internos.
BrowserNo soportado. No importes el SDK en client components.
Provider actualtoteat.
Package managerpnpm.

Primer cliente

Credenciales server-side

createPosClient debe recibir credenciales ya resueltas por el backend. No debe leer credenciales desde el browser ni desde variables públicas.

import { createPosClient } from "@cartamatic/pos-sdk";

const posConnection = await loadRestaurantPosConnection({
  tenantId,
  restaurantId,
  localId
});

const pos = createPosClient({
  provider: posConnection.provider,
  toteat: {
    restaurantId: posConnection.externalRestaurantId,
    localId: posConnection.externalLocalId,
    userId: posConnection.externalUserId,
    apiToken: posConnection.apiToken
  }
});

Variables del SDK

Las variables CARTAMATIC_POS_TOTEAT_* del repo Cartamatic/pos-sdk son para tests de integración y capturas locales contra un local concreto.

No son el modelo runtime recomendado para apps multi-restaurante como dashboards Cartamatic.

Errores de instalación comunes

En esta página