Documentação da API

Introdução

A API de integração do tradeGo funciona através de views SQL criadas no seu banco de dados. O sistema sincroniza automaticamente os dados dessas views, mantendo informações atualizadas de clientes, produtos, pedidos, vendedores e demais entidades.

Como funciona

1. Você cria as views SQL no seu banco de dados seguindo nossa especificação
2. As views mapeiam os dados do seu ERP para o formato do tradeGo
3. O tradeGo sincroniza automaticamente os dados em intervalos regulares
4. Sua equipe de vendas acessa informações sempre atualizadas no app

Requisitos

Bancos de Dados Suportados

• SQL Server: 2012 ou superior (recomendado: 2016+)
• MySQL: 5.7 ou superior (recomendado: 8.0+)
• MariaDB: 10.2 ou superior (recomendado: 10.5+)
• Oracle Database: 11g ou superior (recomendado: 19c+)
• PostgreSQL: 10 ou superior (recomendado: 14+)

Permissões Necessárias

• Permissões para criar views no schema/database
• Usuário com permissão de leitura (SELECT) nas views criadas
• Conectividade de rede entre o servidor do banco e os servidores do tradeGo

Conectividade

• IP dos servidores tradeGo liberado no firewall
• Porta do banco de dados acessível:
  • SQL Server: porta 1433 (padrão)
  • MySQL/MariaDB: porta 3306 (padrão)
  • Oracle: porta 1521 (padrão)
  • PostgreSQL: porta 5432 (padrão)

Instalação

Passo 1: Criar usuário de integração

Escolha o script de acordo com seu banco de dados:

SQL Server

-- Criar login no SQL Server
CREATE LOGIN tradego_integration WITH PASSWORD = 'SuaSenhaSegura123!';

-- Criar usuário no banco de dados
USE SeuBancoDeDados;
CREATE USER tradego_integration FOR LOGIN tradego_integration;

-- Conceder permissão apenas de leitura
GRANT SELECT ON SCHEMA::dbo TO tradego_integration;

MySQL / MariaDB

-- Criar usuário (substitua 'localhost' pelo IP se necessário)
CREATE USER 'tradego_integration'@'%' IDENTIFIED BY 'SuaSenhaSegura123!';

-- Conceder permissão de leitura no banco de dados
GRANT SELECT ON SeuBancoDeDados.* TO 'tradego_integration'@'%';

-- Aplicar as permissões
FLUSH PRIVILEGES;

Oracle Database

-- Criar usuário
CREATE USER tradego_integration IDENTIFIED BY "SuaSenhaSegura123!";

-- Conceder permissão de conexão
GRANT CREATE SESSION TO tradego_integration;

-- Conceder permissão de leitura em todas as tabelas do schema
GRANT SELECT ANY TABLE TO tradego_integration;

-- OU para conceder apenas em um schema específico:
-- GRANT SELECT ON SCHEMA_OWNER.* TO tradego_integration;

PostgreSQL

-- Criar usuário
CREATE USER tradego_integration WITH PASSWORD 'SuaSenhaSegura123!';

-- Conectar ao banco de dados
\c SeuBancoDeDados;

-- Conceder permissão de uso do schema
GRANT USAGE ON SCHEMA public TO tradego_integration;

-- Conceder permissão de leitura em todas as tabelas
GRANT SELECT ON ALL TABLES IN SCHEMA public TO tradego_integration;

-- Garantir permissão em tabelas futuras
ALTER DEFAULT PRIVILEGES IN SCHEMA public 
GRANT SELECT ON TABLES TO tradego_integration;

Passo 2: Criar as views

Execute os scripts de criação de cada view conforme documentado nas seções seguintes. Você pode criar todas de uma vez ou apenas as views necessárias para sua operação.

Passo 3: Configurar a integração

Entre em contato com o suporte do tradeGo fornecendo:

• String de conexão do banco de dados
• Credenciais do usuário de integração
• Lista de views criadas
• Frequência desejada de sincronização

tdg_cliente

View principal de clientes. Contém informações cadastrais completas, endereço, contatos, histórico de compras e configurações comerciais.

Estrutura

Exemplo de criação da view

CREATE VIEW tdg_cliente AS
SELECT 
    cli.CNPJ_CPF AS cpfcnpj,
    cli.CODIGO AS cliente_id,
    cli.EMPRESA_ID AS empresa_id,
    cli.RAZAO_SOCIAL AS razao_social,
    cli.NOME_FANTASIA AS fantasia,
    cli.TIPO_PESSOA AS tipo_pessoa,
    cli.INSC_ESTADUAL AS inscricao_estadual,
    cli.CEP AS cep,
    cli.ENDERECO AS endereco,
    cli.NUMERO AS numero,
    cli.COMPLEMENTO AS complemento,
    cli.BAIRRO AS bairro,
    cli.CIDADE AS cidade,
    cli.UF AS uf,
    cli.TELEFONE AS telefone_1,
    cli.TELEFONE2 AS telefone_2,
    cli.EMAIL AS email_comercial,
    cli.EMAIL_COBRANCA AS email_cobranca,
    cli.EMAIL_NFE AS email_nfe,
    cli.CONTATO AS contato,
    cli.RAMO_ATIVIDADE AS ramo_atividade_id,
    cli.LATITUDE AS latitude,
    cli.LONGITUDE AS longitude,
    CASE WHEN cli.ATIVO = 'S' THEN 1 ELSE 0 END AS ativo,
    cli.NIVEL_CONDICAO AS nivel_cond,
    cli.NIVEL_FORMA AS nivel_forma,
    DATEDIFF(DAY, cli.DATA_ULTIMA_COMPRA, GETDATE()) AS dias_sem_compra,
    cli.OBS_NOTA AS obs_nota,
    cli.QTD_COMPRAS_MES AS compra_mes,
    cli.VALOR_COMPRAS_MES AS valor_mes,
    cli.TITULOS_ABERTO AS tit_abr,
    cli.ALTERACOES_PENDENTES AS alt_pend,
    cli.ACEITE_LGPD AS lgpd,
    CASE WHEN cli.MICRO_EMPRESA = 'S' THEN 1 ELSE 0 END AS micro_empresa,
    DATEDIFF(DAY, cli.DATA_ATUALIZACAO, GETDATE()) AS diassematualizacao,
    0 AS qtde_dias,
    FORMAT(cli.DATA_ULTIMA_COMPRA, 'yyyy-MM-dd') AS ultima_compra,
    cli.TOTAL_PEDIDOS AS total_pedidos,
    FORMAT(cli.DATA_CADASTRO, 'yyyy-MM-dd') AS cliente_desde,
    cli.LISTA_ENTREGA_ID AS listaEnt,
    CASE WHEN cli.BLOQUEADO = 'S' THEN 1 ELSE 0 END AS bloqueado,
    vnd.CPF AS vendedor_id,
    cli.WHATSAPP AS whatsapp,
    cli.OBSERVACOES AS obs_geral,
    cli.CLASSIFICACAO AS classificacao,
    CONVERT(CHAR(32), HASHBYTES('MD5', CONCAT(cli.CNPJ_CPF, cli.DATA_ATUALIZACAO)), 2) AS hashcode
FROM 
    SUA_TABELA_CLIENTES cli
    LEFT JOIN SUA_TABELA_VENDEDORES vnd ON cli.VENDEDOR_ID = vnd.ID;

tdg_produtos

Catálogo de produtos com informações de estoque, categorização, preços e embalagens.

Estrutura

Exemplo de criação da view

CREATE VIEW tdg_produtos AS
SELECT 
    prd.ID AS produto_id,
    prd.CODIGO AS codigo_interno,
    prd.DESCRICAO AS descricao_produto,
    prd.CATEGORIA_ID AS categoria_id,
    prd.SUBCATEGORIA_ID AS subcategoria_id,
    prd.FABRICANTE_ID AS industria_id,
    prd.ESTOQUE_ATUAL AS qtde_estoque,
    prd.DATA_VALIDADE AS vencimento,
    prd.EMPRESA_ID AS empresa_id,
    prd.IS_KIT AS kit_produto,
    prd.PRODUTO_PAI_ID AS produto_pai_id,
    prd.URL_IMAGEM AS imagem,
    prd.TIPO AS tipo_produto,
    prd.COMBO_ID AS kit_combo_id,
    prd.VENDA_SOMENTE_COMBO AS somente_combo,
    prd.DUN14 AS dun,
    prd.EAN AS ean,
    prd.NCM AS ncm,
    prd.QTD_PALLET AS qt_pallet,
    CONVERT(CHAR(32), HASHBYTES('MD5', CONCAT(prd.ID, prd.DATA_ATUALIZACAO)), 2) AS hashcode
FROM 
    SUA_TABELA_PRODUTOS prd
WHERE 
    prd.ATIVO = 'S';

tdg_pedidos

Pedidos de vendas com informações de cliente, condições comerciais, valores e status.

Estrutura

tdg_itens_pedidos

Itens dos pedidos de vendas com quantidades, valores e informações do produto.

Estrutura

tdg_vendedor

Cadastro de vendedores/representantes da equipe comercial.

Estrutura

tdg_cliente_condicao

Relaciona clientes com as condições de pagamento permitidas.

Estrutura

tdg_cliente_forma

Relaciona clientes com as formas de pagamento permitidas.

Estrutura

tdg_cliente_limite

Limites de crédito dos clientes.

Estrutura

tdg_produto_lista

Preços dos produtos por lista de preço/tabela comercial.

Estrutura

tdg_historico_pedidos

Histórico consolidado de pedidos realizados.

Estrutura

tdg_lancamentos

Lançamentos financeiros e contas a receber.

Estrutura

tdg_clientes_titulos

Títulos a receber dos clientes.

Estrutura

tdg_comissao

Controle de comissões dos vendedores.

Estrutura

tdg_categoria

Categorias de produtos.

Estrutura

tdg_industria

Cadastro de indústrias/fabricantes.

Estrutura

tdg_supervisor

Cadastro de supervisores de vendas.

Estrutura

Suporte e Contato

Precisa de ajuda?

Nossa equipe técnica está pronta para auxiliar na implementação da integração.