Base de Sinistros Pagos DPVAT DPVAT SINISTROS. Manual do Produto Versão 2.3

Transcrição

1 Base de Sinistros Pagos DPVAT DPVAT SINISTROS Manual do Produto Versão 2.3 Janeiro/2018

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 Beneficiário Exemplos: Exemplo de consulta realizada com sucesso... 5 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... 8 Exemplo de retorno: caso de erro PARÂMETROS DE ENTRADA DAS CONSULTAS Consulta por Beneficiário 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... 12

3 1. Informações gerais sobre o produto 1.1 Contexto A base de dados contém informações sobre sinistros pagos, tais como nome e CPF do beneficiário, chassi e placa do veículo, data da ocorrência do sinistro, natureza do sinistro (morte, invalidez ou DAMS). 1.2 Objetivo O banco de dados de sinistros do DPVAT é um produto destinado às seguradoras que necessitam obter e validar informações relacionadas aos acidentes de trânsito que tenham sido indenizados pelo seguro obrigatório. 1.3 Nome Base de Sinistros Pagos DPVAT 1.4 Endereço do arquivo WSDL Requisitos e orientações para o acesso Para entrar em contato com a Superintendência Executiva de Negócios da CNseg, seja em caso de dúvida, reclamações, sugestões ou para solicitação de informações sobre nossas soluções, acione o Canal de Atendimento ao Cliente. Para utilizar o Canal de Atendimento ao Cliente, acesse cnseg.org.br clicando no banner Soluções Tecnológicas para o Mercado e, em seguida, no banner Atendimento ao Cliente. Informamos que o login é o seu e no seu primeiro acesso você deverá solicitar uma senha, clicando em recuperar senha. 3

4 Os novos usuários deverão solicitar seu acesso a um usuário já cadastrado no Canal de Atendimento ao Cliente, conforme abaixo: Após o primeiro acesso é possível alterar sua senha, através dos passos a seguir: 1º Passo: Após logar, na primeira tela apresentada, no menu superior clique em Alterar Senha. 2º Passo: Preencha com a senha de sua escolha e clique em Concluir Abertura para finalização. 2. Informações detalhadas do serviço 2.1 Acesso via Browser Endereço/Link de acesso Telas 4

5 Consulta por Beneficiário Exemplos: Exemplo de consulta realizada com sucesso Exemplo de retorno com erro na consulta Parâmetro Inválido Indica que o campo está nulo ou inválido 5

6 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. 6

7 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 Beneficiário Nome da Operação ConsultaBeneficiario 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 CpfCnpjBeneficiario Char 14 CPF ou CNPJ do Beneficiário NomeBeneficiario Char 40 Nome do Beneficiário Placa Char 7 Placa do veículo Chassi Char 21 Chassi do veículo Boletim Char 12 Boletim de ocorrência DataOcorrencia Char 8 Data da ocorrência no formato AAAAMMDD NaturezaSinistro Char 1 Código da natureza do sinistro DescNaturezaSinistro Char 30 Descrição da natureza do sinistro 1 Morte 2 Invalidez parcial 3 DAMS 4 Invalidez total 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. <?xml version="1.0" encoding="utf-8"?> <consulta> 7

8 <SINISTRO> <CpfCnpjBeneficiario> </CpfCnpjBeneficiario> <NomeBeneficiario>NOME</NomeBeneficiario> <Placa>XXX0000</Placa> <Chassi></Chassi> <Boletim>00000</Boletim> <DataOcorrencia> </DataOcorrencia> <NaturezaSinistro>1</NaturezaSinistro> <DescNaturezaSinistro>Morte</DescNaturezaSinistro> <saldo>0.00</saldo> <protocolo> </protocolo> </SINISTRO> </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 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 <consulta> <SINISTRO> <retorno>parâmetro inválido</retorno> <saldo>0.00</saldo> <protocolo> </protocolo> </SINISTRO> </consulta> 8

9 2.4 Parâmetros de entrada das consultas Consulta por Beneficiário 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 CpfCnpjBeneficiario Char 14 Sim Informar CPF ou CNPJ para acesso 2.5 Consulta em Lote Contexto A Consulta em Lote armazena em arquivo único o resultado obtido de um montante de consultas feitas ao Portal de Serviços e Soluções Objetivo Disponibilizar resultado de consultas sequenciais feitas ao Portal de Serviços e Soluções em arquivo consolidado Consulta em Lote O Módulo pode ser acessado seguindo os seguintes passos: Efetuar Log In no Portal de Serviços e Soluções 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 de Serviços e Soluções (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. 9

10 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 ) 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 Após a última linha do arquivo, tanto no Excel quanto no.txt, não pode conter ENTER, senão, será considerada como uma nova linha e o sistema sinalizará como inconsistência na quantidade de linhas informadas. 10

11 No produto DPVAT SINISTROS, as consultas podem ser realizadas unicamente por CPF/CNPJ do Beneficiário, como mostrado no exemplo. Verificar se a informação de número de linhas está correta, marcar a caixa informando que está de acordo e clicar em enviar. Após processado, é possível realizar o download do arquivo final. Selecionar o link indicado pela seta, onde consta o protocolo do arquivo enviado. Realizar o download do arquivo no local indicado pela seta. 11

12 2.5.6 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 WinZip, WinRar etc.) 12

13 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. 13