Pular para o conteúdo
Login

Documentação API Sunlux

Documentação API Sunlux

Por Heron Rangel
Publicado em 16 de abril de 2026 – Atualizado em 16 de abril de 2026

1. O que é esta API?

A API Sunlux é uma interface de comunicação que permite ao seu sistema “conversar” com o servidor da Sunlux. Ela funciona através de requisições, onde você envia um dado (como o número de um pedido) e o servidor devolve as informações detalhadas sobre ele.

Informações de Acesso:

  • Servidor (Base URL): http://sunlux.no-ip.info:8090

  • Formato de dados: JSON (um padrão de texto organizado que computadores leem facilmente).

2. Como as consultas funcionam?

A API possui rotas (Endpoints). Para todas elas, você deve usar o método POST, que é como se você estivesse enviando um formulário para o servidor.

3. Autenticação e Segurança

Para que o servidor Sunlux reconheça e autorize suas requisições, todas as chamadas aos endereços (endpoints) da API devem conter um cabeçalho de autenticação.

A API utiliza o padrão Authorization Basic. Isso significa que você deve enviar as credenciais de acesso (usuário e senha) em cada requisição realizada.

Como configurar o cabeçalho:

  • Chave do Cabeçalho: Authorization

  • Valor: Basic {credenciais_convertidas}

Passo a passo para gerar o valor:

  1. Junte seu usuário e sua senha separados por dois pontos (Exemplo: usuario:senha).

  2. Converta esse texto para o formato Base64.

  3. O resultado final no cabeçalho será algo como: Authorization: Basic dXN1YXJpbzpzZW5oYQ==.

Nota Importante: Sem este cabeçalho, o servidor retornará um erro de “Não Autorizado” (Erro 401), impossibilitando o acesso aos dados.

Rotas

A. Consulta de Cadastro (/api/sunlux/cadastro)

Use esta função quando precisar de todos os dados de um cliente ou fornecedor (nome, CNPJ, endereço, telefone, etc.).

  • O que você envia: O código de identificação do cadastro (IDCad).

  • Exemplo de envio:

    JSON

     
    { "IDCad": 1 }

  • O que você recebe: Uma ficha completa com mais de 40 campos, incluindo todas as informações pertinentes ao cadastro da revenda.

Descrição dos Campos:

  • IDCad: IDCadastro

  • cliente: Nome / Razão Social

  • fantasia: Apelido / Fantasia

  • CNPJ: CNPJ

  • IE: Inscrição Estadual

  • IM: Inscrição Municipal

  • CEP: CEP

  • endereco: Endereço

  • num: Número

  • compl: Complemento

  • Bairro: Bairro

  • Cidade: Cidade

  • UF: Unidade Federativa

  • Fone1: Fone

  • Fone3: Fone 3

  • Fone2: Fax

  • PJ: Pessoa Juridica

  • mail: E-Mail

  • Ecli: É Cliente

  • Efor: É Fornec.

  • Etra: Transportadora para NF

  • cDCad: Data do Cadastro

  • IDtCad: Tipo

  • site: Site

  • Responsavel: Responsavel

  • cUCad: Usuário do Cadastro

  • Porte: Porte

  • IDVen: Vendedor Padrão

  • IDCpg: Condição de Pagamento Padrão

  • pDes: Desconto Padrão

  • LimCre: Limite de Crédito

  • CondFixa: Condição de Pagamento Fixa

  • Bloqueado: Bloqueado

  • Filial: Filial

  • IDSeg: Segmento

  • CapSoc: Capital Social

  • DtAtiv: Data da Ativação

  • Efun: Funcionário

  • IDRota: Rota para entrega

  • IDRotaOrd: Ordem dentro da Rota

  • mailNE: Não quer receber E-Mail Mala Direta

  • sexo: Sexo

  • DtGru: Data Alteração do Grupo

  • IDpais: Código do Pais

  • IDCom: Comissionado

  • enq: Enquadramento Fiscal (0 = Simples Nacional, 1 = Lucro Presumido, 2 = Lucro Real)

  • pr: Produtor Rural

  • indIEDest: Indicador da IE do Destinatário

  • IDCla: Classificação

B. Consulta de Histórico (/api/sunlux/historico)

Use esta função para buscar movimentações dentro de um período específico.

  • O que você envia: O ID do cadastro e o intervalo de datas (Início e Fim).

  • Exemplo de envio:

    JSON

     
    { 
  "IDCad": 1, 
  "DtInicio": "02-01-2021", 
  "DtFim": "03-01-2021" 
}

  • O que você recebe: Uma lista contendo os IDs dos últimos 50 pedidos e as datas em que ocorreram dentro do filtro informado.

Descrição dos Campos: 

  • IDPed: ID do pedido

  • dt: Data do pedido

C. Consulta de Pedido (/api/sunlux/pedido)

Use esta função para detalhar um pedido de venda específico, incluindo quais produtos e opções estão nele.

  • O que você envia: O número do pedido (IDPed).

  • Exemplo de envio:

    JSON

     
    { "IDPed": 195890 }

  • O que você recebe: Todas as informações pertinentes ao pedido. Dentro de cada pedido, você verá detalhes dos produtos inclusos e dentro dos produtos verá todas as informações pertinentes às opções.

Descrição dos Campos: (Pedido)

  • IDPed: ID

  • IDtPed: Tipo de Pedido

  • dt: Data do Pedido

  • IDCad: Cedente do Pedido

  • n_doc: Número do Documento

  • IDCpg: Condição de Pagamento

  • bloq: Orçamento/Pedido

  • compra: Compra/Venda

  • IDVen: Vendedor

  • cNF: Nota Fiscal

  • pVen: Comissão

  • pCad: Percentual a pagar da comissão

  • pDesc: Desconto %

  • vDesc: Valor do Desconto

  • tItem: Total de Itens

  • vPed: Valor Total do Pedido

  • EntDt: Data Entrega

  • EntHr: Hora Entrega

  • dtEnv: Data Envio

  • tUnid: Total de quantidades

  • IDTra: Transportadora

  • tvVen: Total comissão vendedor

  • vFrete: Valor do Frete

  • cUPed: Usuário Cadastro

  • cDPed: Data Lançamento

  • IDCom: Comissionado

  • DtImp: Data da impressão

  • IDSta: Status Pedido

  • tpVen: Percentual de Comissão do Pedido

  • tpesoB: Total peso bruto

  • vCus: Total Custo

  • PedCusto: Pedido a preço de Custo

  • tMKP: Percentual Total do Markup do Pedido

  • IDCon: Contato

  • pCom: % Comissão Comissionado

  • modFrete: Frete por Conta

  • PesoMP: Peso Matéria Prima

  • tvImp: Valor Total Impostos

  • IDExt: ID Externo (Mobile, terceiros)

  • NroVol: Número de volumes do Pedido

  • regra: 0 – Normal, 1 – Inventário, 2 – Consignado, 3 – Devolução, 4 – Produção, 5 – Orçamento, 6 – Sem Estoque, 7 – Sem Caixa

  • vBas: Total Base Item

  • PIpt: PIpt

  • IDCto: ID do Contrato

  • nAno: Ano do Contrato

  • ND: Nota de Débito

Descrição dos Campos: (Produtos)

  • IDItem: IDItem

  • IDPed: Número Pedido

  • Item: Código do Item

  • IDPro: ID Produto

  • quant: Quantidade

  • pDescI: Desconto

  • vPedI: Valor de Venda

  • vtPedI: Total Item

  • markup: Markup

  • vBase: Base para Calculos

  • vtBase: Total Base Item

  • vCusto: Valor de Custo

  • vtCusto: Total Custo Item

  • vtImp: Total Impostos

  • pCom: Percentual de Comissão Vendedor

  • vCom: Comissão Valor

  • dtEnt: Cortina

  • qEnt: Quantidade entregue

  • tpesoB: Total Peso Bruto

  • lote: Lote

  • cDPedI: Data do Lançamento

  • trib: Tributação ICMS

  • qCalc: Cálculo da quantidade

  • TVenda: 0 = Normal, 1 = Promoção, 2 = Queima, 3 = Brinde

  • TCom: 0 = Normal, 1 = Sem Comissão, 2 = Diferença

  • cUPedI: Usuário Cadastro

  • vLibDesc: Valor Máximo para desconto

  • qEntPar: Quantidade entrega parcial

Descrição dos Campos: t_pedIIAD

  • ID: ID

  • IDPed: ID do pedido

  • IDItem: IDItem

  • IDInfo: IDInfo

  • rotulo: rotulo

  • ordem: ordem

  • IDOp: ID Opção

  • Opcao: Informação

  • IDLista: IDLista

  • tCalc: 0;’Calc. Área’;1;’Calc. Altura’;2;’Calc. Largura’;3;’Calc. Valor’;4;’Calc. Campo’;5;’Percentual’;6;’Final Área’;7;’Final Altura’;8;’Final Largura’;

  • qOp: Quantidade

  • vOp: Valor Opção conforme Tipo de Cálculo

  • vDs: Desconto da Opção

  • vFn: Valor Final da Opção

  • IDGIa: ID Grupo de Campos

  • Obs: Observação

  • CtlProc: Controle de processamento: 0 – Nada, 1 – VALORES, 2 – FILTROS, 3 – MEDIDAS, 7 – VLR + FIL, 8 – FIL + MED, 9 – Todos

  • OrdProd: Ordem produção usado no layout de impressão

Heron Rangel

Desenvolvimento
Home
Ajuda!
Parceiros
Buscar
×

 

Olá! 😁

Selecione o contato que deseja iniciar a conversa!

Você será atendido por ordem de chamada!

×