Manual para o WebService
Introdução
A integração entre o cliente e a e-catálogos é feita da seguinte forma:
• O cliente deverá fazer uma vídeo conferência com o suporte da e-catálogos para configurar as tabelas e as funções a serem integradas, de forma que fique o mais fácil possível para o cliente desenvolver seu WebService, e em alguns casos não sendo necessário fazer alterações no WebService do cliente (quando já
existir).
• É recomendado que antes da vídeo conferência o responsável técnico do cliente leia e entenda os campos das tabelas e das funções utilizadas pela e-catálogos para que a integração seja mais rápida.
• Depois de feita todas as configurações, daremos início a uma fase de testes para verificar se a integração foi feita da forma correta.
• Após a fase de testes a integração ficará em observação pelo período de sete a trinta dias para garantir a integridade dos dados recebidos e enviados pela e-catálogos.
• O WebService da e-catálogos é totalmente dinâmico, o que transforma a integração com o nosso sistema um procedimento muito rápido e eficiente, podendo em alguns casos ser feito em menos de dois dias.
Forma de envio das informações
A integração será realizada via REST, para o envio das operações será utilizado o método POST com os seguintes parâmetros:
• Usuário: será disponibilizado pela e-catálogos, mesmo acesso do painel administrativo.
• Senha: será disponibilizado pela e-catálogos, mesmo acesso do painel administrativo.
• Operacao: nome da operação escolhida na configuração do
WebService.
• Funcao: CONSULTAR, INSERIR E DELETAR.
• Arquivo: arquivo a ser inserido, não utilizar quando a função for “consultar”.
A configuração do WebService deverá ser feita juntamente com o suporte da e-catálogos.
O cliente poderá escolher o formato de entrada e
saída do arquivo (XML,JSON,CSV,TXT), além de poder
customizar os nomes das colunas das tabelas.
As tabelas e funções do WebService serão listadas e
explicadas abaixo. Em negrito estarão os nomes das colunas, e quando houver o símbolo “asterisco” (*), significa que seguido dele está um complemento informativo da coluna, como valores ou etc.
Os envios em XML devem vir com codificação “ISO-8859-1”
e devem vir no formato “string”.
No caso de envios no formato CSV e TXT o delimitador será
escolhido pelo cliente e é configurado pelo nosso suporte. Os arquivos no formato TXT tem um limite de caracteres por campo predeterminado pelo cliente e também é configurado pelo nosso suporte.
Tabelas
Tabela para Marca “tb_marcas” possui os seguintes campos
abaixo:
• mc_id_erp: Código da marca já cadastrada no ERP. • mc_nome: Nome da marca.
• mc_visualizar: Visualizar marca.*
* - Indica quando a marca estiver disponível para visualizar ou não. 0 - Para não exibir a marca.
1 - Para exibir a marca. • mc_cnpj: CNPJ.
• modified: Data da última modificação. • mc_endereco: Endereço marca.
• mc_numero: Número da marca.
• mc_complemento: Complemento da marca. • mc_bairro: Bairro da marca.
• mc_cidade: Cidade da marca. • mc_uf: UF da marca.
• mc_cep: CEP da marca.
Tabela para Cliente “tb_cliente” possui os seguintes campos abaixo:
• cl_cod_erp: Código do cliente já cadastrado no ERP. • cl_nome_comprador: Nome do comprador.
• cl_cargo: Cargo do comprador dentro da empresa. • cl_razao: Razão social.
• cl_fantasia: Nome fantasia. • cl_unidade: Unidade.
• cl_cnpj: CNPJ.
• cl_ie: Inscrição Estadual. • cl_fone: Telefone principal.
• cl_ddd: DDD do telefone principal. • cl_cep_fa: CEP de Faturamento. • cl_end_fa: Endereço de Faturamento. • cl_n_fa: Número de Faturamento.
• cl_comp_fa: Complemento de Faturamento. • cl_bairro_fa: Bairro de Faturamento.
• cl_cidade_fa: Cidade de Faturamento.
• cl_ibge_cidade_fa: Código do IBGE da cidade de Faturamento. • cl_uf_fa: UF de Faturamento.
• cl_fone_fa: Telefone com DDD de Faturamento. • cl_fax_fa: Fax com DDD de Faturamento.
• email_cad: Email do cadastro. • cl_data: Data de cadastro.
• preco_1: Utilizar tabela de preço 1.* • preco_2: Utilizar tabela de preço 2.* • preco_3: Utilizar tabela de preço 3.*
* - Indica qual tabela de preço que o cliente utilizará. • cl_credito_total: Crédito total para compra.
• cl_credito_utilizado: Crédito utilizado. • cl_cep_unid: CEP da Unidade.
• cl_end_unid: Endereço da Unidade. • cl_n_unid: Número da Unidade.
• cl_bairro_unid: Bairro da Unidade. • cl_cidade_unid: Cidade da Unidade.
• cl_ibge_cidade_unid: Código do IBGE da cidade da Unidade. • cl_uf_unid: UF da Unidade.
• cl_fone_unid: Telefone com DDD da Unidade. • cl_fax_unid: Fax com DDD da Unidade.
• cl_tipo: Tipo de loja.*
* - Indica se a loja do cliente é a principal ou vinculada a outro cliente. P - Indica loja principal.
V - Indica a loja vinculada ao cliente. • cl_email_add1: Primeiro e-mail adicional. • cl_email_add2: Segundo e-mail adicional. • cl_valor_minimo: Valor mínimo de compra.
• modified: Data da última modificação.
• cl_observacao: Observação do cliente.
• cl_codigo_erp_end_fa: Código do ERP do endereço de Faturamento. • cl_codigo_erp_end_unid: Código do ERP do endereço da Unidade. • cl_bloqueio: Campo de bloqueio do cliente.
• cl_motivo: Campo do motivo do bloqueio.
Tabela para Representante “tb_representante” possui os
seguintes campos abaixo:
• rp_cod_erp: Código do representante já cadastrado no ERP. • rp_nome: Nome do representante.
• rp_rg: RG do representante. • rp_emissor: Emissor do RG.
• rp_data_emissao: Data de emissão do RG. • rp_uf_emissor: UF emissor do RG.
• rp_cpf: CPF do representante.
• rp_reg_core: Código do registro core do representante comercial. • rp_sexo: Sexo.
• rp_datanasc: Data de nascimento.
• rp_usuario: Campo usuário representante. • rp_senha: Campo senha representante. • rep_cep: CEP do representante.
• rp_endereco: Endereço do representante. • rp_n: Número.
• rp_comp: Complemento.
• rp_bairro: Bairro do representante. • rp_cidade: Cidade do representante. • rp_uf: UF do representante.
• rp_desc_especial: Desconto para representante.*
* - Indica se o representante pode ter ou não o desconto. 0 - Define que o representante pode ter um desconto. 1 - Define que o representante não pode ter um desconto. • rp_limite_desc_especial: Limite para desconto especial. • rp_limite_desc_ref: Limite de desconto por referência. • modifield: Data da última modificação.
• rp_ultimo_aceso: Campo de ultimo acesso.
Tabela para Categorias “tb_categorias” possui os seguintes
campos abaixo:
• cat_cod_erp: Código da categoria já cadastrada no ERP. • cat_id: Código identificador nas tabelas e-catálogos.*
* - Recebido apenas como retorno, não pode ser enviado. • cat_nome: Nome da categoria.
• cat_visivel: Visualizar a Categoria.*
* - Indica se a categoria deve está disponível para visualizar ou não. 0 - Define que a categoria não será exibida.
1 - Define que a categoria será exibida. • modified: Data da última modificação.
• parent: Código da categoria pai ( “cat_id” ).*
* - Evitar usar, pois o campo “cat_id” é o campo identificador da e-catálogos.
Tabela para Cores “tb_cores” possui os seguintes campos
abaixo:
• cor_id_erp: Código da cor já cadastrada no ERP. • cor_nome: Nome da cor.
• cor_visualizar: Visualizar cor.*
* - Indica se a cor deve está disponível para visualizar ou não. 0 - Define que a cor não será exibida.
1 - Define que a cor será exibida. • modified: Data da última modificação.
Tabela para Tamanhos “tb_tamanhos” possui os seguintes
campos abaixo:
• tmh_cod_erp: Código do tamanho já cadastrado no ERP. • tmh_nome: Nome do tamanho.
• tmh_visualizar: Visualizar tamanho .*
* - Indica se o tamanho deve está disponível para visualizar ou não. 0 - Define que a tamanho não será exibido.
1 - Define que a tamanho será exibido. • modified: Data da última modificação.
Funções
1 - A função para vincular uma marca ao cliente possui os seguintes campos abaixo:
• fk_cliente: Campo com o código do cliente.*
* - Um campo da tabela “tb_cliente” deverá ser escolhido para servir como chave identificadora do cliente.
• fk_marca: Campo com o código da marca.*
* - Um campo da tabela “tb_marcas” deverá ser escolhido para servir como chave identificadora do cliente.
• cm_preco_1: Tabela com preço 1 selecionado.* • cm_preco_2: Tabela com preço 2 selecionado.* • cm_preco_3: Tabela com preço 3 selecionado.*
* - Apenas um dos campos de preço deve ter valor “1”. 0 - Define a tabela de preço que não serão utilizadas. 1 - Define a tabela de preço que será utilizada.
• modified: Data da última modificação.
2 - A função para inserir produtos e suas variações (info_produtos) é feita da seguinte forma:
• Existem duas tabelas a serem preenchidas, a tb_produtos e a tb_info_produtos.
• Os dados da tb_produtos virão primeiro e após eles, virão os dados da tb_info_produtos.
• Todo produto deve ter pelo menos um info_produto.
• Podem existir uma infinidade de info_produtos para um produto, por este motivo esta função só pode ser feita via “XML” ou “JSON”, pois nela nós temos dois tipos de tag, a tag com o nome da função, e a tag “info_produto”.
• Existem cinco chaves estrangeiras nesta função, e para cada uma delas deverá ser escolhido um campo na sua respectiva
Campos das tabelas:
Tabela Produto “tb_produtos
”.• prd_id_erp: Código do produto no ERP. • prd_nome: Nome do produto.
• prd_referencia: Referência do produto. • prd_oferta: Produto em oferta.*
* - Indica que o produto pode está em oferta ou não. 0 - Produto em oferta.
1 - Produto não está em oferta. • prd_ipi: IPI do produto.
• prd_icms: ICMS do produto.
• prd_nome_colecao: Nome da coleção do produto. • prd_dados_tecnicos: Dados técnicos do produto.
• prd_dados_composicao: Dados da composição do produto. • prd_dados_descricao: Dados da descrição do produto. • prd_grade: Tipo de grade para utilização.*
* - Indica qual tipo de grade para utilizar no produto. 0 – Indica grade fechada.
1 - Indica grade aberta.
• prd_data_inicio: Data inicial do produto no catálogo. • prd_data_fim: Data final do produto no catálogo. • prd_data_prazo: Data do prazo do produto.
• prd_data_limite: Data limite para escolha do prazo de entrega. • prd_peso: Peso do produto.
• prd_cub_a: Campo altura da cubagem. • prd_cub_i: Campo largura da cubagem.
• prd_cub_p: Campo profundidade da cubagem.
• prd_desc_unit: Campo para desconto unitário do produto. • prd_codigo_barra: Código de barras do produto.
• prd_visualizar: Visualizar produto.*
* - Indica quando o produto estiver disponível para visualizar ou não. 0 - Para não exibir o produto.
1 - Para exibir o produto.
• modified: Data da última modificação.
• prd_controle_estoque: Controle de estoque.*
* - Indica que o produto haverá ou não controle de estoque. 0 - Para não haver controle de estoque do produto.
1 - Possui controle de estoque no produto.
Tabela Info Produto “tb_info_produtos”.
• ifp_valor_1: Preço 1 do produto. • ifp_valor_2: Preço 2 do produto. • ifp_valor_3: Preço 3 do produto.
• ifp_estoque_1: Quantidade em estoque 1. • ifp_estoque_2: Quantidade em estoque 2. • ifp_estoque_3: Quantidade em estoque 3. • ifp_estoque_fixo: Quantidade de estoque fixo. • ifp_qtde_minima: Quantidade mínima por seleção. • ifp_qtde_multipla: Quantidade múltipla.*
* - Indica se será utilizada a quantidade múltipla.
0 - Para não. 1 - Para sim.
• ifp_destaque: Variante principal para exibição. • ifp_peso: Peso por referência.
• ifp_cub_a: Altura da cubagem por referência. • ifp_cub_l: Largura da cubagem por referência.
• ifp_cub_p: Profundidade da cubagem por referência. • ifp_sku_erp: Código do SKU cadastrado no ERP. • modified: Data da última modificação.
Conclusão
