Pular para o conteúdo principal

TypeScript SDK

Biblioteca oficial para integrar a Engine API em aplicações Node.js e TypeScript.

Instalação​

npm install @engine-api/sdk

Quick Start​

import { EngineAPI } from "@engine-api/sdk";

const engine = new EngineAPI({
  apiKey: process.env.ENGINE_API_KEY,
  environment: "sandbox", // 'sandbox' | 'production'
});

// Emitir NFe
const nfe = await engine.nfe.emitir({
  naturezaOperacao: "VENDA DE MERCADORIA",
  destinatario: {
    cpfCnpj: "99888777000155",
    nome: "Cliente Exemplo SA",
  },
  itens: [
    {
      descricao: "Produto Teste",
      ncm: "61091000",
      cfop: "5102",
      quantidade: 1,
      valorUnitario: 100.0,
    },
  ],
});

console.log("Chave:", nfe.accessKey);

Métodos Disponíveis​

MóduloMétodoDescrição
engine.nfe.emitir(data)Emitir NFe
engine.nfe.cancelar(id, motivo)Cancelar NFe
engine.nfe.consultar(id)Consultar NFe
engine.nfe.listar(filtros)Listar NFes
engine.nfce.emitir(data)Emitir NFCe
engine.boleto.registrar(data)Registrar boleto
engine.mdfe.emitir(data)Emitir MDFe
engine.cte.emitir(data)Emitir CTe

Configuração​

const engine = new EngineAPI({
  apiKey: "sk_test_...", // API Key (obrigatória)
  environment: "sandbox", // 'sandbox' | 'production'
  timeout: 30000, // Timeout em ms (default: 30s)
  retries: 3, // Número de retries (default: 3)
});