Skip to content

About

A forma mais fácil e rápida de integrar o InfoSimples na sua aplicação Node.JS

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Repository files navigation

InfoSimples SDK Node.js

A forma mais fácil e rápida de integrar a API v2 da InfoSimples na sua aplicação Node.js.

NPM Version NPM Downloads Types License: MIT

Sobre o projeto

A InfoSimples oferece uma API de consultas online (em tempo real) a portais públicos brasileiros — Receita Federal, Tribunais, Portal da Transparência, ANVISA, ANTT, CNJ, TCU e dezenas de outros órgãos, úteis para automações de KYC, due diligence, gestão cadastral e fiscal, e prevenção a fraudes.

Este pacote é um wrapper tipado e enxuto sobre essa API: cada endpoint vira um método de um client já autenticado, sem lógica de negócio própria além das chamadas HTTP.

Recursos

  • TypeScript-first — tipos de payload para cada endpoint e um client totalmente tipado.
  • Client autenticado — informe o token uma única vez em connect(); todos os métodos o reutilizam.
  • Superfície previsível — um método por endpoint, agrupado por órgão (client.<órgão>.<consulta>()).
  • Sem dependências pesadas — apenas axios em runtime.
  • Retorno cru da API — cada método resolve com o data da resposta da InfoSimples, sem transformação.

Requisitos

Instalação

# npm
npm install infosimples-sdk

# pnpm
pnpm add infosimples-sdk

# yarn
yarn add infosimples-sdk

# bun
bun add infosimples-sdk

Uso

Iniciando o client

import InfoSimples, { InfoSimplesClient } from 'infosimples-sdk';

const client: InfoSimplesClient = InfoSimples.connect({
  token: process.env.INFOSIMPLES_TOKEN!,
});

Fazendo uma consulta

Cada método recebe um objeto com os parâmetros do endpoint e resolve com a resposta da API:

const resultado = await client.receitaFederal.cnpj({ cnpj: '00000000000191' });

console.log(resultado);

Com .then()/.catch():

client.correios
  .cep({ cep: '01310-930' })
  .then(resposta => console.log(resposta))
  .catch(erro => console.error(erro));

TypeScript

Os parâmetros de cada endpoint são tipados. O tipo InfoSimplesClient descreve toda a árvore de órgãos e métodos disponíveis — útil para injeção de dependência e para mocks em testes.

Documentação dos endpoints

Os exemplos de uso de cada endpoint vivem na wiki do projeto, uma página por órgão:

Para a referência completa de parâmetros e formato de resposta de cada consulta, consulte a documentação oficial da InfoSimples.

Status do projeto

⚠️ Em desenvolvimento. A API pública ainda pode mudar entre versões 0.x sem aviso prévio. Fixe uma versão exata no package.json até o 1.0.0.

A cobertura de endpoints é ampliada continuamente; a lista sempre atual está na wiki.

Itens pendentes

  • Ampliar a cobertura de endpoints da API InfoSimples, priorizando a esfera federal e o eixo Rio–SP.
  • Concluir os tribunais restantes (TRFs, TRTs, TJs, TSE/TST).
  • Tipar as respostas de cada endpoint (hoje apenas os parâmetros de entrada são tipados).
  • Publicar um guia de contribuição dedicado.

Contribuindo

Contribuições são bem-vindas — em especial para cobrir os endpoints que ainda faltam.

  • Abra uma issue descrevendo a mudança antes de PRs grandes.
  • Os commits seguem Conventional Commits (validados por commitlint).
  • Antes de abrir o PR: pnpm lint && pnpm build && pnpm test && pnpm format:check.

Arquitetura e convenções do repositório estão em AGENTS.md e docs/.

Changelog

Veja CHANGELOG.md.

Licença

MIT © Alan Matias

About

A forma mais fácil e rápida de integrar o InfoSimples na sua aplicação Node.JS

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages