Base de Dados de Sinistros de Indenização Integral (Irrecuperável) BDSII. Manual do Produto Versão 2.4

Transcrição

1 Base de Dados de Sinistros de Indenização Integral (Irrecuperável) BDSII Manual do Produto Versão 2.4 Janeiro/2018

2 Índice 1. INFORMAÇÕES GERAIS SOBRE O PRODUTO CONTEXTO... 3 OBJETIVO... 3 NOME... 3 ENDEREÇO DO ARQUIVO WSDL... 3 REQUISITOS E ORIENTAÇÕES PARA O ACESSO... 3 MÉTODOS INFORMAÇÕES DETALHADAS DO SERVIÇO ACESSO VIA BROWSER Endereço/Link de acesso Telas Consulta por Placa Consulta por Chassi Consulta por Chassi e Placa Exemplos: Exemplos de consultas realizadas com sucesso Consulta por Placa; Consulta por Chassi; Consulta por Chassi e Placa Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta: Retornos gerais ACESSO WEBSERVICE Protocolo de Comunicaçã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... 9 Exemplo de retorno: caso de erro PARÂMETROS DE ENTRADA DAS CONSULTAS Consulta por Placa (BuscaPlaca) Consulta por Chassi (BuscaChassi) Consulta por Chassi e Placa (BuscaPlacaChassi) 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... 13

3 1. Informações gerais sobre o produto 1.1 Contexto O BDSII Banco de Dados de Sinistros de Indenização Integral (Irrecuperável) foi criado por força do Termo de Ajustamento de Conduta Nº 486, assinado em 06/10/2003, com a Promotoria de Justiça de Defesa dos Direitos do Consumidor do Ministério Público da União DF. Contém as informações sobre o número de chassi e/ou placa de veículos segurados indenizados integralmente e considerados irrecuperáveis. A consulta a essa base de dados é pública. Diariamente a Quality envia as informações dos sinistros de indenização integral irrecuperáveis (colisão) para a CNseg, que atualiza a base de dados e, através de link com o Detran DF, permite a consulta pública a tais informações. 1.2 Objetivo O sistema foi construído de maneira simples para fornecer ao consumidor apenas resposta do tipo SIM/NÃO, indicando se existe ou não a informação de sinistro de indenização integral. A pesquisa pode ser realizada informando placa e/ou chassi. 1.3 Nome Base de Dados de Sinistros de Indenização Integral (Irrecuperável) 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. Os novos usuários deverão solicitar seu acesso a um usuário já cadastrado no Canal de Atendimento ao Cliente, conforme abaixo: 3

4 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. 1.6 Métodos 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 informação de sinistro de indenização integral por chassi Consulta informação de sinistro de indenização integral por placa Consulta informação de sinistro de indenização integral por placa e chassi Nome da Operação BuscaChassi BuscaPlaca BuscaPlacaChassi 2. Informações detalhadas do serviço 2.1 Acesso via Browser Endereço/Link de acesso Produção: 4

5 2.1.2 Telas Consulta por Placa Consulta por Chassi 5

6 Consulta por Chassi e Placa Exemplos: Exemplos de consultas realizadas com sucesso Consulta por Placa; Consulta por Chassi; Consulta por Chassi e Placa 6

7 Exemplo de retorno com erro na consulta Parâmetro Inválido Indica que um ou mais campos estão nulos ou inválidos Possíveis retornos com erro na consulta: Retornos gerais Retorno Usuário ou Senha Inválido Parâmetro inválido 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. O parâmetro Placa deve conter 7 caracteres no formato AAA9999. O parâmetro 7

8 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 Chassi deve conter, no máximo, 21 caracteres Indica que não foi encontrado nenhum registro para os campos informados Indica que ocorreu um erro inesperado e é preciso entrar em contato com o suporte Indica que o usuário não tem permissão para realizar a consulta ao método 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. 2.2 Acesso webservice Protocolo de Comunicação O protocolo de comunicação com o webservice é o SOAP 1.1. Esse protocolo aceita apenas requisições POST. 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 BDSII realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo resposta Char 1 1 Encontrado 2 Não Encontrado datainclusao Char 8 Data da Inclusão no formato DDMMAAAA Saldo Decimal 13,2 Saldo só deve ser considerado para contratos Pré-pago Protocolo Char 20 Número de protocolo da consulta 8

9 2.3.2 Exemplos de retorno: caso de sucesso Exemplo de XML de retorno para consultas realizadas com sucesso. Esse exemplo de retorno se aplica aos métodos: Consulta por Placa (BuscaPlaca) Consulta por Chassi (BuscaChassi) Consulta por Chassi e Placa (BuscaPlacaChassi) <BDSII> <resposta> 1 </resposta> <datainclusao> </datainclusao> <saldo>0.00 </saldo> <protocolo> </protocolo> </BDSII> 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 <BDSII> <resposta>parâmetro inválido</resposta> <saldo>0,00</saldo> <protocolo> </protocolo> </ BDSII > 2.4 Parâmetros de entrada das consultas Consulta por Placa (BuscaPlaca) 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 9

10 Placa Varchar 7 Sim Informar Placa para consulta Consulta por Chassi (BuscaChassi) 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 Consulta por Chassi e Placa (BuscaPlacaChassi) 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 Varchar 7 Sim Informar Placa para consulta Chassi Varchar 21 Sim Informar Chassi para consulta 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 10

11 2.5.4 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 exigir 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 KYT6013 KQL1309 LJB5663 Em caso de utilizar os dois parâmetros: KYT6013;9BFZF55P8B LJB5663; 9BGTB11NNNC 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. 11

12 No produto BDSII, as consultas podem ser por chassi (como mostrado no exemplo), por placa ou por chassi e placa. 12

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

14 2º passo: 3º passo: Clicar em OK, abrirá um arquivo xml, para abri-la em excel, arraste o arquivo xml para dentro de uma planilha excel. Seu processamento aparecerá com o formato habitual do excel, separado por colunas. 14