@forgecodebr/idealsoft-sdk
v0.1.0
Published
SDK TypeScript para integração com o módulo Integrações do Shop Control (IdealSoft)
Downloads
5
Maintainers
Readme
@forgecode/idealsoft-sdk
SDK TypeScript para o módulo Integrações do Shop Control (IdealSoft).
Recursos
- Autenticação (token)
- Assinatura HMAC (Signature header)
- Wrapper genérico para chamadas
- Endpoints: produtos, clientes, vendas, estoques (exemplos)
Instalação
npm install node-fetch @forgecode/idealsoft-sdkUso básico
import { IdealSoftClient, authenticate, endpoints } from "@forgecode/idealsoft-sdk";
async function main(){
const client = new IdealSoftClient({
baseUrl: "https://api.idealsoft.com.br",
codFilial: "001",
secretKey: process.env.IDEALSOFT_SECRET || "",
});
await authenticate(client, { usuario: "teste", senha: "teste" });
const produtos = await endpoints.listProducts(client);
console.log(produtos.dados);
}
main();Extensão
A biblioteca foi projetada para ser simples de estender — adicione novos arquivos de endpoints dentro de src/endpoints seguindo o padrão existente.
// OBS: // - Ajuste os caminhos dos endpoints conforme a sua instalação da IdealSoft — alguns clientes personalizam rotas. // - Recomenda-se usar o ambiente de homologação fornecido pela IdealSoft para testar antes de ir para produção.
// FIM
