RENAVAM BIN RF. Manual do Produto Versão 2.4

Transcrição

1 RENAVAM BIN RF Manual do Produto Versão 2.4 Junho/2015

2 Índice 1. INFORMAÇÕES GERAIS SOBRE O SERVIÇO 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 Consulta por Chassi Exemplos Exemplo de consultas realizadas com sucesso Consulta por Placa com mais de 01 ocorrência Consulta por Placa com 01 ocorrência Consulta por Chassi com mais de 01 ocorrência Consulta por Chassi com 01 ocorrência Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos com erro na consulta Retornos Específicos Retornos Gerais ACESSO WEBSERVICE Protocolo de Comunicação 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 Consulta por Placa e Consulta por Chassi com mais de 01 ocorrência, Consulta por Placa Detalhamento e Chassi Detalhamento Consulta por Placa e Consulta por Chassi com 01 ocorrência Informações de retorno: caso de erro Exemplo de retorno: caso de erro Possíveis retornos na consulta: PARÂMETROS DE ENTRADA DAS CONSULTAS Consulta por Placa Consulta por Placa Detalhamento Consulta por Chassi Consulta por Chassi Detalhamento 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... 21

3 1. Informações gerais sobre o serviço 1.1 Contexto Base de dados do DENATRAN para obtenção de informações sobre roubos e furtos de veículos. Contém informações sobre todos os Boletins de Ocorrência de Roubo/Furto, os avisos de localização, recuperação e devolução ao proprietário. 1.2 Objetivo Obter informações oficiais dos Boletins de Ocorrência de Roubo/Furto, localização e recuperação de veículos. 1.3 Nome RENAVAM BIN RF Registro Nacional de Veículos Automotores Base Integrada Nacional de Roubo e Furto 1.4 Endereço do arquivo WSDL Homologação: Produção: 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 Homologação: Produção: Telas Consulta por Placa 4

5 Consulta por Chassi Exemplos Exemplo de consultas realizadas com sucesso Consulta por Placa com mais de 01 ocorrência Nesse caso, o resultado da consulta é apresentado em 2 passos. 1º Passo: Listagem com todas ocorrências. 2º Passo: Ao clicar sobre a placa do veículo, a ocorrência é detalhada. 5

6 Consulta por Placa com 01 ocorrência Nesse caso, é apresentado diretamente o resultado detalhado. 6

7 Consulta por Chassi com mais de 01 ocorrência Nesse caso, o resultado da consulta é apresentado em 2 passos. 1º Passo: Listagem com todas ocorrências. 2º Passo: Ao clicar sobre o chassi do veículo, a ocorrência é detalhada. 7

8 Consulta por Chassi com 01 ocorrência Nesse caso, é apresentado diretamente o resultado detalhado. 8

9 Exemplo de retorno com erro na consulta Parâmetro Inválido 9

10 2.1.4 Possíveis retornos com erro na consulta Retornos Específicos Transação efetuada Retorno Campo <nome do campo> fora da especificação de tamanhos Erro na aplicação Nenhum registro encontrado Existem mais registros do que o previsto para essa consulta Veículo não cadastrado e com ocorrência de roubo/furto Veículo não cadastrado e com sinalização de alarme Veículo cadastrado e com sinalização de alarme Descrição Indica que a consulta foi realizada com sucesso Campo com quantidade de caracteres inválida Indica que ocorreu um erro ao realizar a consulta Indica que não foi encontrado nenhum resultado para os dados informados Indica que foram encontrados mais registros que o esperado para os dados informados Indica que o veículo não foi cadastrado e possui ocorrência de roubo/furto Indica que o veículo não foi cadastrado e possui sinalização de alarme Indica que o veículo está cadastrado e possui sinalização de alarme Veículo cadastrado e com ocorrência de roubo/furto Indica que o veículo está cadastrado e possui ocorrência de roubo/furto Número do documento de identificação do proprietário inválido Chassi inválido Código do Renavam inválido UF Jurisdição inválida Placa inválida Não foi possível conexão com a UF de origem Código órgão de Segurança Invalido Indica que o número informado do documento de identificação do proprietário é inválido Indica que o chassi informado é inválido Indica que o código do renavam informado é inválido Indica que a UF de jurisdição informada é inválida Indica que a placa informada é inválida Indica que não foi possível realizar a conexão com a UF de origem Indica que o código de segurança informado é 10

11 UF Boletim ocorrência invalido Número do boletim de ocorrência invalido Ano boletim ocorrência invalido Categoria da ocorrência invalido inválido Indica que a UF do boletim de ocorrência informada é inválida Indica que o número do boletim de ocorrência informado é inválido Indica que o ano do boletim de ocorrência informado é inválido Indica que a categoria da ocorrência informado é inválido 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 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. 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. 11

12 2.2.2 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 Placa Consulta por Placa Detalhamento Consulta por Chassi Consulta por Chassi Detalhamento Nome da Operação ConsultaSerpro908 ConsultaSerpro908Env2 ConsultaSerpro907 ConsultaSerpro907Env2 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 Renavam BINRF realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo codmetodo Char 10 Código do método utilizado na consulta nomemetodo Char 50 Nome do método utilizado na consulta codret Char 3 Código do retorno Mensagem Char 50 Mensagem de retorno, podendo ser: Nenhum registro encontrado Existem mais registros do que o previsto para essa consulta Veículo não cadastrado e com ocorrência de roubo/furto Veículo não cadastrado e com sinalização de alarme Veiculo cadastrado e com sinalização de alarme Veículo cadastrado e com ocorrência de roubo/furto Número do documento de identificação do proprietário inválido Chassi inválido Código do Renavam inválido UF Jurisdição inválida Placa inválida Chassi invalido Não foi possível conexão com a UF de origem Código órgão de Segurança Invalido 12

13 088 - UF Boletim ocorrência invalido Número do boletim de ocorrência invalido Ano boletim ocorrência invalido Categoria da ocorrência invalido qtdeocorrencias Char 2 Quantidade de ocorrências encontradas qtdocorrencias Char 2 Quantidade de ocorrências encontradas chassi Char 21 Chassi do veículo placa Char 7 Placa do veículo ufjurisdicao Char 2 UF onde o veículo foi emplacado municipioemplacamento Char 40 Município onde o veículo foi emplacado marcamodelo Char 50 Descrição da marca/modelo do veículo nomecor Char 100 Descrição da cor do Veículo, podendo ser: 2 - AZUL 3 - BEGE 4 - BRANCA 05 - CINZA 6 - DOURADA 7 - GRENA 8 - LARANJA 9 - MARROM 10 - PRATA 11 - PRETA 12 - ROSA 13 - ROXA 14 - VERDE 15 - VERMELHA 16 - FANTASIA 0 - NAO INFORMADO 1 - AMARELA 99 - NAO INFORMADO anomodelo Char 4 Ano do modelo do veículo anofabricacao Char 4 Ano de fabricação do veículo indicadorcatocorr Char 1 Indicador do tipo da ocorrência, podendo ser: 1 Declaração 2 Recuperação 3 - Devolução indicadorocorre Char 1 Indicador do tipo da ocorrência, podendo ser: 1 Declaração 2 Recuperação 3 - Devolução ufboletimocorr Char 2 UF onde foi registrado o boletim de ocorrência codorgaoseguranca Char 4 Código do órgão de segurança que realizou o registro do boletim de ocorrência numeroboletim Char 7 Número do boletim de ocorrência anoboletim Char 4 Ano de registro do boletim de ocorrência codmunicipioocorr Char 4 Código do município da ocorrência 13

14 nomemunicipioocorr Char 50 Nome do município da ocorrência tipodeclaracao Char 1 Indica se o veículo foi roubado ou furtado, podendo ser: 1 Roubado 2 - Furtado dataocorr Char 8 Data da ocorrência tipodocinformante Char 1 Tipo do documento do informante, podendo ser: 1 CPF 2 CGC 3 Carteira de identidade 4 Carteira de trabalho 5 Passaporte 6 Carteira de habilitação 7 Título de eleitor 9 - Outros identinformante Char 14 Número do documento do informante dddfonecontato Char 4 DDD do telefone de contato do informante fonecontato Char 9 Telefone de contato do informante ramalfonecontato Char 5 Ramal do telefone de contato do informante nomeinformante Char 40 Nome do informante numcentralalarme Char 2 Número de identificação da central de recepção de alarme nos órgãos de segurança. dataregistroalarme Char 8 Data de registro do alarme nos órgãos de segurança horaregistroalarme Char 4 Hora de registro do alarme nos órgãos de segurança 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 por Placa e Consulta por Chassi com mais de 01 ocorrência, Consulta por Placa Detalhamento e Chassi Detalhamento <?xml version="1.0" encoding="utf-8"?> <consulta> <registro> <codmetodo>908env1</codmetodo> <nomemetodo>consulta por Placa</nomemetodo> <codret>000</codret> <mensagem>transação efetuada</mensagem> <qtdocorrencias>02</qtdocorrencias> <placa>aaa0000</placa> <ufjurisdicao>rj</ufjurisdicao> <chassi> </chassi> <ufboletimocorr>rj</ufboletimocorr> <codorgaoseguranca>ssp</codorgaoseguranca> <numeroboletim> </numeroboletim> <anoboletim>2014</anoboletim> <indicadorocorre>1</indicadorocorre> 14

15 <saldo>0.00</saldo> <protocolo> </protocolo> </registro> <registro> <codmetodo>908env1</codmetodo> <nomemetodo>consulta por Placa</nomemetodo> <codret>000</codret> <mensagem>transação efetuada</mensagem> <qtdocorrencias>02</qtdocorrencias> <placa>aaa0000</placa> <ufjurisdicao>sp</ufjurisdicao> <chassi> </chassi> <ufboletimocorr>sp</ufboletimocorr> <codorgaoseguranca>ssp</codorgaoseguranca> <numeroboletim> </numeroboletim> <anoboletim>2015</anoboletim> <indicadorocorre>1</indicadorocorre> <saldo>0.00</saldo> <protocolo> </protocolo> </registro> </consulta> Consulta por Placa e Consulta por Chassi com 01 ocorrência <?xml version="1.0" encoding="utf-8"?> <consulta> <registro> <codmetodo>908env1</codmetodo> <nomemetodo>consulta por Placa</nomemetodo> <codret>000</codret> <mensagem>transação efetuada</mensagem> <qtdocorrencias>01</qtdocorrencias> <chassi> </chassi> <placa>aaa0000</placa> <ufjurisdicao>rj</ufjurisdicao> <municipioemplacamento>rio DE JANEIRO</municipioemplacamento> <marcamodelo>gm/corsa HATCH MAXX</marcamodelo> <nomecor>preta</nomecor> <anomodelo>2011</anomodelo> <anofabricacao>2011</anofabricacao> <indicadorcatocorr>1</indicadorcatocorr> <ufboletimocorr>rj</ufboletimocorr> <codorgaoseguranca>ssp</codorgaoseguranca> <numeroboletim> </numeroboletim> <anoboletim>2014</anoboletim> <codmunicipioocorr>5901</codmunicipioocorr> <nomemunicipioocorr /> <tipodeclaracao>2</tipodeclaracao> <dataocorr> </dataocorr> <tipodocinformante>1</tipodocinformante> <identinformante> </identinformante> <dddfonecontato /> <fonecontato> </fonecontato> <ramalfonecontato /> <nomeinformante>nome DO INFORMANTE</nomeinformante> <numcentralalarme>00</numcentralalarme> <dataregistroalarme> </dataregistroalarme> <horaregistroalarme>0000</horaregistroalarme> <saldo>0.00</saldo> <protocolo> </protocolo> </registro> 15

16 </consulta> Informações de retorno: caso de erro Informações detalhadas de retorno para consultas realizadas com erro Exemplo de retorno: caso de erro <consulta> <registro> <codmetodo>908env1</codmetodo> <nomemetodo>consulta por Placa</nomemetodo> <codret> </codret> <mensagem>parâmetro inválido </mensagem> <saldo>0.00</saldo> <protocolo> </protocolo> </registro> </consulta> Retornos da consulta: Código Retorno Retorno 000 Transação efetuada com sucesso 001 Nenhum registro encontrado 003 Existem mais registros do que o previsto para essa consulta 017 Veículo não cadastrado e com ocorrência de roubo/furto 018 Veículo não cadastrado e com sinalização de alarme 019 Veículo cadastrado e com sinalização de alarme 048 Veículo cadastrado e com ocorrência de roubo/furto 054 Número do documento de identificação do proprietário inválido 065 Código do Renavam inválido 075 UF Jurisdição inválida 076 Placa inválida 077 Chassi inválido 085 Não foi possível conexão com a UF de origem 087 Código órgão de Segurança Invalido 088 UF Boletim ocorrência invalido 089 Número do boletim de ocorrência invalido 090 Ano boletim ocorrência invalido 096 Categoria da ocorrência invalido Acesso não permitido para o IP Campo <nome do campo> fora da especificação de tamanhos Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método Cliente não possui crédito disponível Cliente não possui permissão para o método 16

17 Contrato inativo ou fora do período de vigência Erro na aplicação Método inválido Não há retorno para esta consulta Parâmetro inválido Produto em desenvolvimento Produto inválido Sua consulta não foi realizada, entre em contato com o suporte Usuário ou Senha Inválido 2.4 Parâmetros de entrada das consultas 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 IdPlaca Varchar 7 Sim Placa para consulta Consulta por Placa Detalhamento 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 IdChassi Varchar 21 Sim Chassi para consulta IdUfJurisdicao Varchar 2 Sim UF para consulta IdPlaca Varchar 7 Sim Placa para consulta IdUfBoletim Varchar 2 Sim UF do Boletim de Ocorrência para a consulta IdCodOrgSeg Varchar 4 Sim Código do órgão de segurança para consulta IdBoletim Varchar 7 Sim Número do Boletim de Ocorrência para consulta IdAnoBoletimOcorre Varchar 4 Sim Ano do boletim de ocorrência para consulta IdIndicadorOcorr Varchar 1 Sim Identificador do tipo de ocorrência para a consulta 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 17

18 IdChassi Varchar 21 Sim Chassi para consulta Consulta por Chassi Detalhamento 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 IdChassi Varchar 21 Sim Chassi para consulta IdUfJurisdicao Varchar 2 Sim UF para consulta IdPlaca Varchar 7 Sim Placa para consulta IdUfBoletim Varchar 2 Sim UF do Boletim de Ocorrência para a consulta IdCodOrgSeg Varchar 4 Sim Código do órgão de segurança para consulta IdBoletim Varchar 7 Sim Número do Boletim de Ocorrência para consulta IdAnoBoletimOcorre Varchar 4 Sim Ano do boletim de ocorrência para consulta IdIndicadorCatOcorr Varchar 1 Sim Identificador do tipo de ocorrência para a 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 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: 18

19 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 ) 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

20 No produto Renavam BINRF, as consultas podem ser por placa (como mostrado no exemplo) ou por chassi. 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. 20

21 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: 21

22 1º passo: (Obs. Pode ser utilizada qualquer ferramenta de extração de arquivos WinZip, WinRar, etc.) 2º passo: 22

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

24 24