Introdução. Os Webservices são divididos em 2 grandes grupos: 1. Métodos de Verificação 2. Métodos para Transmissão de Dados

Transcrição

1 MTI Sistemas Manual de Integração por meio de WebServices Importação de Dados para o CRM Autor: Ricardo Matiello Versão 1.2

2 Introdução Este documento tem por objetivo auxiliar os desenvolvedores na integração de seus aplicativos com os cadastros principais do software CRM Professional. Os Webservices são divididos em 2 grandes grupos: 1. Métodos de Verificação 2. Métodos para Transmissão de Dados Métodos de Verificação: Auxilia o Desenvolvedor a verificar o status atual do serviço, assim como prover informações sobre autenticação e comunicação com o Banco de Dados. Métodos para Transmissão de Dados: São os dados que são gerados a partir dos sistemas externos, que deverão ser transmitidos via WebService para o CRM. O Manual Técnico dos Webservices não é o único canal de informação para a integração dos Sistemas com o CRM. Serve preferencialmente como uma referência rápida para auxílio nas atividades de desenvolvimento e integração dos aplicativos. Para um melhor resultado, dúvidas devem ser encaminhadas para o desenvolvimento@mtisistemas.com.br, ou sanadas através do telefone (44) Havendo a necessidade, serão marcadas reuniões de cunho técnico entre as equipes de desenvolvimento para ajustes, acertos, melhorias e quaisquer outras atividades que envolvam a comunicação dos softwares MTI com empresas parceiras.

3 Métodos de Verificação (informações ao Desenvolvedor): StatusHeader Descrição: Este método informa se os demais métodos estão com autenticação habilitada ou não. Quando a autenticação não estiver habilitada, basta invocar o método passando valor nulo (em branco) no campo psheader de cada Método. (sem parâmetros) Retorno: (String) Result String Informa se os métodos estão com Autenticação habilitada ou não. Teste Descrição: Este método retorna um teste simples de chamada, mostrando se está respondendo ou não. (sem parâmetros) Retorno: (String) Result String Informa o resultado do Teste TesteDB Descrição: Este método retorna um teste de chamada com operação de Banco de Dados, mostrando se está respondendo ou não, e também se está conseguindo ler o Banco de Dados. (sem parâmetros) Retorno: (String) Result String Informa o resultado do Teste

4 Métodos para Transmissão de Dados (informações ao Desenvolvedor): ImportaCadastro Descrição: Neste método, são importados os dados cadastrais. psoperacao String I Inclusão / A Alteração pssubstitui String S ou N (Se substitui as informações caso a operação seja de inclusão e mesmo assim encontre o cadastro já inserido no CRM) pscliente String S ou N (Se é Cliente ou não) psoportunidade String S ou N (Se é Oportunidade/Prospect ou não) pscontato String S ou N (Se é Contato ou não) psfornecedor String S ou N (Se é Fornecedor ou não) psidentificador String Identificação do Cadastro no Sistema Externo psnome String Nome do Cliente psrazaosocial String Razão Social psdocumento01 String Número do Documento pstipodocumento01 String (CPF/ CNPJ / RG / CPF) psdocumento02 String Número do Documento pstipodocumento02 String (CPF/ CNPJ / RG / CPF) psendereco String Endereço Principal psnumero String Número pscomplemento String Complemento psbairro String Bairro pscidade String Cidade psestado String Estado pspais String País pscep String CEP psendereco02 String Endereço de Cobrança/Entrega psnumero02 String Número pscomplemento02 String Complemento psbairro02 String Bairro pscidade02 String Cidade psestado02 String Estado pspais02 String País pscep2 String CEP psddd01 String 99 Formato psfone01 String Formato pstipofone01 String Celular / Contato/ Comercial / Residencial psddd02 String 99 Formato psfone02 String Formato pstipofone02 String Celular / Contato/ Comercial / Residencial psddd03 String 99 Formato psfone03 String Formato pstipofone03 String Celular / Contato/ Comercial / Residencial psddd04 String Formato psfone04 String 99 Formato

5 pstipofone04 String Celular / Contato/ Comercial / Residencial psweb String Página WEB do Cadastro ps String principal psmaillist String S ou N (Se receber Marketing Eletrônico) psmsn String MSN do Cadastro psskype String Skype do Cadastro pistatus Int Código do Status do Cadastro no CRM (Ver Tabela STATUS) picategoria Int Código da Categoria do Cadastro no CRM (Ver Tabela CATEGORIAS) pddatanascimento Date DD/MM/YYYY Data de Nascimento psusuario String Identificação do Usuário no Sistema Externo Codigo Int Código Gerado no CRM (Chave Primária)

6 LimpaFinanceiro Descrição: Neste método, todos os Lançamentos do Módulo Financeiro são apagados.

7 ImportaFinanceiro Descrição: Neste método, são importados os Lançamentos Financeiros. psoperacao String I Inclusão / A Alteração / E - Exclusão pssubstitui String S ou N (Se substitui as informações caso a operação seja de inclusão e mesmo assim encontre o lançamento já inserido no CRM) psidentificador String Identificação do Lançamento no Sistema Externo pscliente String Identificação do Cliente no Sistema Externo (ERP) / Chave Primária pddatalcto Date DD/MM/YYYY Data Original do Lançamento piconta Int Código da Conta no CRM (Tabela FIN_CONTAS) psdescricao String Descrição do Lançamento picategoria Int Código da Categoria no CRM (Tabela FIN_CATEGORIAS) pisubcategoria Int Código da SubCategoria no CRM (Tabela FIN_SUBCATEGORIAS) pdvencimento Date DD/MM/YYYY Data de Vencimento pfvalor Float Valor pssituacao String A Aberto / P - Pago pddatapagamento Date DD/MM/YYYY Data do Pagamento (enviar em branco se ainda estiver pendente) psobservacoes String Observações sobre o Lançamento psusuario String Identificação do Usuário no Sistema Externo psvenda String Identificação da Venda no Sistema Externo (ERP) / Chave Primária Codigo Int Número do Lançamento no CRM / Chave Primária

8 ImportaVendaCab Descrição: Neste método, são importados os dados referentes ao cabeçalho de venda. psnumvenda String Identificação da Venda no Sistema Externo (ERP) / Chave Primária psusuario String Identificação do Usuário no Sistema Externo pscliente String Identificação do Cadastro no Sistema Externo pddata Date DD/MM/YYYY Data da Venda pshora String MM:SS Hora da Venda piformapgto Int Código da Forma de Pagamento no CRM (Tabela FORMASPGTO) piespeciepgto Int Código da Espécie de Pagamento no CRM (Tabela ESPECIEPGTO) picanalvenda Int Código do Canal de Venda no CRM (Tabela CANAISVENDA) psnotafiscal String Número/Série da Nota Fiscal psobservacoes String Observações sobre o Lançamento

9 ImportaVendaItens Descrição: Neste método, são importados os dados referentes aos itens de venda. psnumvenda String Identificação da Venda no Sistema Externo (ERP) / Chave Primária psproduto String Identificação do Produto no Sistema Externo pfquantidade Float Quantidade pfvalorunitario Float Valor Unitário do Produto pfdesconto Float Desconto Aplicado pfvalortotal Float Valor Total (já com o Desconto Aplicado)

10 ImportaVendedor Descrição: Neste método, são importados os dados dos Vendedores. psoperacao String I Inclusão / A Alteração pssubstitui String S ou N (Se substitui as informações caso a operação seja de inclusão e mesmo assim encontre o vendedor já inserido no CRM) psidentificador String Identificação do Vendedor no Sistema Externo psnome String Nome do Cliente pssenha String Senha de Acesso no CRM ps String do Vendedor pssuperior Sting Identificação do Superior (Supervisor/Gerente) no Sistema Externo Codigo Int Código Gerado no CRM (Chave Primária)

11 ImportaProduto Descrição: Neste método, são importados os dados dos Produtos. psoperacao String I Inclusão / A Alteração pssubstitui String S ou N (Se substitui as informações caso a operação seja de inclusão e mesmo assim encontre o produto já inserido no CRM) psidentificador String Identificação do Produto no Sistema Externo psdescricao String Descrição do Produto psdescricaodetalhada String Descrição Detalhada do Produto pigrupo Int Código do Grupo de Produtos no CRM (Tabela GRUPOSPRODUTO) pisubgrupo Int Código do Grupo de Produtos no CRM (Tabela SUBGRUPOSPRODUTO) pfvalorunitario Float Valor Unitário do Produto Codigo Int Código Gerado no CRM (Chave Primária)

12 Anexo I Autenticação dos WebServices Para efetuar a autenticação nos webservices, os métodos que envolvem rotinas do sistema são protegidos por uma Chave de Autenticação. Em cada método, o primeiro campo chama-se psheader, onde deve ser informado a chave para autenticação. Detalhes do Campo para Autenticação: Nome do Campo: psheader Descrição: Chave para Autenticação Formato: String Chave Default para Homologação: 8888