Danos Pessoais Causados por Veículos Auto Motores de Via Terrestre DPVAT BILHETES. Manual do Produto Versão 2.2

Transcrição

1 Danos Pessoais Causados por Veículos Auto Motores de Via Terrestre DPVAT BILHETES Manual do Produto Versão 2.2 Junho/2016

2 Índice 1. INFORMAÇÕES GERAIS SOBRE O PRODUTO CONTEXTO OBJETIVO NOME ENDEREÇO DO ARQUIVO WSDL REQUISITOS E ORIENTAÇÕES PARA O ACESSO INFORMAÇÕES DETALHADAS DO SERVIÇO ACESSO VIA BROWSER Endereço/Link de acesso Telas Consulta por Placa e Período Consulta por Chassi e Período Consulta por Placa... 6 Consulta por Placa, UF e Período Consulta por Cassi... 7 Consulta por CNPJ/CPF e Período Consulta por CNPJ/CPF Exemplos: Exemplo de consultas realizadas com sucesso Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta: Retornos gerais ACESSO WEBSERVICE Nome das consultas do serviço INFORMAÇÕES SOBRE O RETORNO DAS CONSULTAS Parâmetros de retorno: caso de sucesso Estrutura dos Dados Exemplos de retorno: caso de sucesso Informações de retorno: caso de erro Parâmetros de retorno: caso de erro Exemplo de retorno: caso de erro PARÂMETROS DE ENTRADA DAS CONSULTAS Consulta por Chassi e Período Consulta por Chassi Consulta por CNPJ/CPF e Período Consulta por CNPJ/CPF Consulta por Placa e Período Consulta por Placa Consulta por Placa, UF e Período CLASSE WS JAVA PARA CONSULTA CONSULTA EM LOTE Contexto Objetivo Consulta em Lote Considerações gerais sobre parâmetros de entrada e/ou saída Arquivo(s) de entrada Arquivo(s) de saída... 18

3 1. Informações gerais sobre o produto 1.1 Contexto A base de dados contém as informações sobre os pagamentos dos bilhetes de seguro obrigatório e do veículo, como numero do chassi, placa nome e CPF do proprietário. 1.2 Objetivo É um produto destinado às seguradoras, que necessitam validar informações relacionadas aos acidentes de transito que envolva o seguro obrigatório. Na consulta por placa e/ou chassi podem ser informado todos os proprietários do veículo. Na consulta por CPF e/ou CNPJ podem ser informados todos os veículos de propriedade do CPF e/ou CNPJ informado. 1.3 Nome Danos Pessoais Causados por Veículos Auto Motores de Via Terrestre 1.4 Endereço do arquivo WSDL Requisitos e orientações para o acesso Para acessar o sistema, a seguradora deverá entrar em contato com o Canal de Atendimento da Central de Serviços através do telefone: ou atendimento@ceser.org.br. 3

4 2. Informações detalhadas do serviço 2.1 Acesso via Browser Endereço/Link de acesso Telas 4

5 Consulta por Placa e Período Consulta por Chassi e Período 5

6 Consulta por Placa Consulta por Placa, UF e Período 6

7 Consulta por Cassi Consulta por CNPJ/CPF e Período 7

8 Consulta por CNPJ/CPF Exemplos: Exemplo de consultas realizadas com sucesso Exemplo de retorno com erro na consulta Parâmetro Inválido Indica que um ou mais campos estão nulos ou inválidos 8

9 2.1.4 Possíveis retornos com erro na consulta: Retornos gerais Retorno Usuário ou Senha Inválido Parâmetro inválido Não há retorno para esta consulta Sua consulta não foi realizada, entre em contato com o suporte Cliente não possui permissão para o método Acesso não permitido para o IP Cliente não possui crédito disponível Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método Contrato inativo ou fora do período de vigência Método inválido Produto inválido Produto em desenvolvimento Produto indisponível, tente novamente mais tarde Descrição Indica que o usuário e/ou a senha informada são inválidos Indica que um ou mais campos estão nulos ou inválidos Indica que não foi encontrado nenhum registro para os campos informados Indica que ocorreu um erro inesperado e é preciso entre em contato com o suporte Indica que o usuário não tem permissão para realizar a consulta Indica que a consulta foi realizada a partir de um IP não cadastrado para a empresa do usuário Indica que a consulta não pode ser realizada, pois não há crédito suficiente Indica que o contrato da empresa é de Experiência de Uso e a quantidade máxima de consultas permitidas já foi atingida. Indica que a empresa não possui nenhum contrato ativo e/ou vigente para o produto. Indica que esta consulta não está disponível. Indica que esta consulta não está disponível. Indica que esta consulta não está disponível. Indica que o produto está indisponível e nenhuma consulta poderá ser realizada. 9

10 2.2 Acesso Webservice Nome das consultas do serviço A tabela a seguir apresenta as consultas disponíveis para consumo e o nome da operação na interface do serviço. Descrição da Consulta Consulta por Chassi e Período Consulta por Chassi Consulta por CNPJ/CPF e Período Consulta por CNPJ/CPF Consulta por Placa e Período Consulta por Placa Consulta por Placa, UF e Período Nome da Operação BuscaChassi BuscaChassiSemPeriodo BuscaCnpjCpf BuscaCnpjCpfSemPeriodo BuscaPlaca BuscaPlacaSemPerido BuscaPlacaUf 2.3 Informações sobre o retorno das consultas Esta seção apresenta estruturas e exemplos dos retornos de cada consulta Parâmetros de retorno: caso de sucesso Informações detalhadas sobre os parâmetros de retorno para consultas ao DPVAT BILHETES realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo id_pag_dut BigInt - Identificador Interno cod_uf_dut Char 2 UF do DUT ano_exerc Smallint - Ano Exercício placa Char 7 Placa retornada renavan Int - Renavam Retornado chassi Varchar 21 Chassi Retornado proprietario Varchar 40 Nome do Proprietário cnpj _cpf BigInt - Cnpj ou Cpf do proprietário num _bco Smallint - Número do Banco data _proc Int - Data do processamento do DUT emissao _guia Int - Data da emissão da guia valor_premio Numeric 13,2 Valor do prêmio pago tipo_pagamento Char 1 Tipo do pagamento 10

11 saldo_pagamento_parcelado Numeric 13,2 Saldo do pagamento (se parcelado) qtd_pagamento_parcelado Int - Quantidade de parcelas pagas Identificação da Consulta protocolo Char 20 Número de protocolo da consulta saldo Decimal 13,2 Saldo só deve ser considerado para contratos Pré-pago Exemplos de retorno: caso de sucesso Exemplos de XML de retorno para consultas realizadas com sucesso. <consulta> <DPVAT> <id_pag_dut></id_pag_dut> <cod_uf_dut></cod_uf_dut> <ano_exerc></ano_exerc> <placa></placa> <renavan></renavan> <chassi></chassi> <proprietario></proprietario> <cnpj_cpf></cnpj_cpf> <num_bco></num_bco> <data_proc></data_proc> <emissao_guia></emissao_guia> <valor_premio></valor_premio> <tipo_pagamento></tipo_pagamento> <saldo_pagamento_parcelado></saldo_pagamento_parcelado> <qtd_pagamento_parcelado></qtd_pagamento_parcelado> <saldo></saldo> <protocolo></protocolo> </DPVAT> </consulta> Informações de retorno: caso de erro Informações detalhadas de retorno para consultas realizadas com erro Parâmetros de retorno: caso de erro Retorno Usuário ou Senha Inválido Parâmetro inválido Não há retorno para esta consulta Sua consulta não foi realizada, entre em contato com o suporte Cliente não possui permissão para o método Acesso não permitido para o IP Cliente não possui crédito disponível Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método 11

12 Contrato inativo ou fora do período de vigência Método inválido Produto inválido Produto em desenvolvimento Produto indisponível, tente novamente mais tarde Exemplo de retorno: caso de erro <?xml version="1.0" encoding="utf-8"?> <consulta> <DPVAT> <retorno>parâmetro inválido</retorno> <saldo>0.00</saldo> <protocolo> </protocolo> </DPVAT> </consulta> 2.4 Parâmetros de entrada das consultas Consulta por Chassi e Período Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Chassi Varchar 21 Sim Informar Chassi para consulta Periodo Varchar 9 Sim Informar o período da consulta no formato <Ano Inicial> <Ano Inicial> Consulta por Chassi Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Chassi Varchar 21 Sim Informar Chassi Consulta por CNPJ/CPF e Período Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário CnpjCpf Varchar 14 Sim Informar Cnpj/Cpf Periodo Varchar 9 Sim Informar o período da consulta no formato <Ano Inicial> <Ano Inicial> 12

13 2.4.4 Consulta por CNPJ/CPF Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário CnpjCpf Varchar 14 Sim Informar Cnpj/Cpf Consulta por Placa e Período Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Placa Char 7 Sim Informar Placa Periodo Varchar 9 Sim Informar o período da consulta no formato <Ano Inicial> <Ano Inicial> Consulta por Placa Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Placa Char 7 Sim Informar Placa Consulta por Placa, UF e Período Parâmetro Tipo Tamanho Obrigatório Observações IdUsuario Varchar 255 Sim Informar Login do Usuário Senha Varchar 255 Sim Informar Senha do Usuário Placa Char 7 Sim Informar Placa Periodo Varchar 9 Sim Informar o período da consulta no formato <Ano Inicial> <Ano Inicial> UF Char 2 Sim Informar UF 2.5 Classe WS Java para consulta Exemplo de classe WS Java para consulta ao método Consulta por Chassi. Os demais métodos devem seguir este mesmo exemplo, alterando apenas os parâmetros de entrada: package br.org.cnseg; 13

14 import java.io.bytearrayinputstream; import java.io.bytearrayoutputstream; import java.io.ioexception; import java.net.url; import javax.xml.soap.messagefactory; import javax.xml.soap.mimeheaders; import javax.xml.soap.soapconnection; import javax.xml.soap.soapconnectionfactory; import javax.xml.soap.soapconstants; import javax.xml.soap.soapexception; import javax.xml.soap.soapmessage; public class CNSegSOAP { public static void main(string[] args) { processa("usuario@cnseg.org.br", "senha", "chassi"); } public static void processa(string usuario, String senha, String chassi){ StringBuffer soapmessage = new StringBuffer(); //Cria o XML para envio, pode ser feito usando JDOM soapmessage.append("<soapenv:envelope xmlns:soapenv=" xmlns:dpv=" ").append(" <soapenv:header/>").append(" <soapenv:body>").append(" <dpv:buscachassisemperiodo>").append(" <usuario>"+usuario+"</usuario>").append(" <senha>"+senha+"</senha>").append(" <chassi>"+chassi+"</chassi>").append(" </dpv:buscachassisemperiodo>.append(" </soapenv:body>").append("</soapenv:envelope>"); dosoap(soapmessage.tostring(), " "); //Realiza chamada SOAP } public static void dosoap(string xml, String urlwsdl){ try { MessageFactory factory = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL); SOAPMessage message; try { MimeHeaders header = new MimeHeaders(); header.addheader("content-type", "application/soap+xml"); message = factory.createmessage(header, new ByteArrayInputStream(xml.getBytes())); SOAPConnection con = SOAPConnectionFactory.newInstance().createConnection(); URL url = new URL(urlWsdl); SOAPMessage res = con.call(message, url); ByteArrayOutputStream out = new ByteArrayOutputStream(); res.writeto(out); System.out.println(out.toString()); // Aqui temos o XML de retorno basta realizar a desserialização } catch (IOException ex) { System.out.println(ex.getMessage()); } } catch (SOAPException ex) { System.out.println(ex.getMessage()); } } } 14

15 2.6 Consulta em Lote Contexto A Consulta em Lote armazena em arquivo único o resultado obtido de um montante de consultas feitas ao Portal CESER Objetivo Disponibilizar resultado de consultas sequenciais feitas ao Portal CESER em arquivo consolidado Consulta em Lote O Módulo pode ser acessado seguindo os seguintes passos: Efetuar Log In no Portal CESER Acessar a opção de menu superior Lote Acessar a opção de menu lateral Consulta em lote Caso o objetivo seja consultar o resultado de um Lote, seguir os seguintes passos: Efetuar Log In no Portal CESER (Caso ainda não esteja logado). Acessar a opção de menu superior Lote Acessar a opção de menu lateral Pesquisar em lote Considerações gerais sobre parâmetros de entrada e/ou saída Restrições: O Arquivo de entrada não pode ter mais do que Linhas. O Arquivo de entrada deve ter o formato CSV ou TXT O Arquivo de entrada deve ter apenas um parâmetro por linha (salvo quando a consulta exige mais parâmetros de entrada. Neste caso, os parâmetros devem ser separados por ; Ponto e Vírgula ). 15

16 2.6.5 Arquivo(s) de entrada Todo arquivo de entrada deve ter por padrão, apenas um parâmetro por linha. Ex.: Nome do arquivo xxxxxxxxxx.txt ou yyyyyyyyyyy.csv KYT6013 KQL1309 LJB Em caso de utilizar os dois parâmetros: KYT6013;9BFZF55P8B LJB5663; 9BGTB11NNNC

17 No produto DPVAT BILHETES, as consultas podem ser por CNPJ/CPF (como mostrado no exemplo), por placa, por chassi, por placa e período, por chassi e período, por placa, período e UF e por CNPJ/CPF e período. Verificar se a informação de número de linhas está correta, selecionar a opção de acordo e enviar. Após processado poderá ser realizado o download do arquivo final. Selecionar o link indicado pela seta, onde consta o protocolo do arquivo enviado. 17

18 Realizar o download do arquivo no local indicado pela seta Arquivo(s) de saída Os arquivos de retorno terão o formato XML. Desta forma, o usuário tem liberdade para trabalhar com o mesmo em várias ferramentas. Excel, Notepad, dentre outros. Para isto, salve o arquivo final e ao abrir execute os seguintes passos: 1º passo: (Obs. Pode ser utilizada qualquer ferramenta de extração de arquivos, como WinZip, WinRar, etc.) 18

19 2º passo: 3º passo: Clicar em OK, abrirá um arquivo XML. Para abri-lo, arraste o arquivo para dentro de uma planilha Excel. Seu processamento aparecerá com o formato habitual do Excel, separado por colunas. 19