Skip to main content

​
Requisitos

  • Node.js 18 o superior.
  • Un API key de La Pyme con los scopes necesarios.
  • Guardar el API key en una variable de entorno del servidor.

​
Instalar

npm add lapyme
El paquete es ESM. En proyectos CommonJS, importalo con await import("lapyme").

​
Crear el cliente

import { Lapyme } from "lapyme";

export const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});
La API key se envía como bearer token. El SDK arma el header Authorization por vos.
No uses el SDK con API keys desde el navegador. Usalo en backend, jobs, scripts o cualquier entorno donde puedas proteger secretos.

​
Probar credenciales

import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});

const warehouses = await lapyme.warehouses.list({ limit: 1 });

console.log(warehouses.result.data);
Si la credencial no existe, está revocada o no tiene permisos, la API responde con un error estructurado. Revisá Errores para capturarlos.

​
URL de servidor

Producción es el servidor por default. Para pruebas contra otro entorno, podés sobreescribirlo: 
import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  serverURL: "https://api.lapyme.com.ar",
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
});

​
Reintentos

Podés configurar reintentos por cliente o por operación. Para writes con Idempotency-Key, reutilizá la misma key cuando reintentes la misma operación. 
import { Lapyme } from "lapyme";

const lapyme = new Lapyme({
  bearerAuth: process.env["LAPYME_API_KEY"] ?? "",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 30,
      exponent: 2,
      maxElapsedTime: 120,
    },
    retryConnectionErrors: true,
  },
});