Saltar al contenido
firmo
Docs / SDKs

SDKs

SDK de TypeScript y JavaScript @firmo-ecf/sdk en npm, con tipos, reintentos e idempotencia. El de Python está pendiente: mientras, usa requests.

Disponible TypeScript

El SDK de TypeScript ya está publicado en npm (@firmo-ecf/sdk). Envuelve la misma API REST con tipos del contrato, reintentos e idempotencia automática. El de Python sigue pendiente. Lo que hacen se puede hacer con fetch o requests, como en el inicio rápido.

TypeScript y JavaScript#

npm
npm i @firmo-ecf/sdk
emitir.ts
import { Firmo } from '@firmo-ecf/sdk';

const firmo = new Firmo({ apiKey: process.env.FIRMO_API_KEY! });

const ecf = await firmo.ecf.emitir({
  tipo: 31,
  comprador: { rnc: '131000000', razonSocial: 'Ferretería El Puente SRL' },
  items: [{ descripcion: 'Cemento gris 42.5 kg', cantidad: 20, precioUnitario: 500 }],
});

console.log(ecf.estado, ecf.encf);

El SDK envía en cada petición el header Firmo-Channel: sdk para que el e-CF quede registrado con canal: "sdk". Es un dato declarado por el cliente. Ver el header Firmo-Channel.

La interfaz del SDK puede cambiar antes de la versión 1.0. La API REST es la referencia estable.

Python#

Próximamente

pip
pip install firmo

Mientras tanto, usa la API directamente con requests o httpx.

Otros lenguajes#

En la República Dominicana hay mucho PHP, C#/.NET y Java. Están en la hoja de ruta. Mientras, puedes generar un cliente a partir de openapi.json.