Base de Licenciamento. Manual do Produto Versão 1.3

Transcrição

1 Base de Licenciamento Manual do Produto Versão 1.3 Junho/2017

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 Chassi ou Placa Exemplos: Exemplo de consultas realizadas com sucesso Exemplo de retorno com erro na consulta Parâmetro Inválido Possíveis retornos na consulta: 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 Chassi ou Placa Informações de retorno: caso de erro Exemplo de retorno: caso de erro PARÂMETROS DE ENTRADA DAS CONSULTAS Consulta por Chassi ou Placa... 9

3 1. Informações gerais sobre o produto 1.1 Contexto Banco de dados de veículos disponibilizado pela CETIP, com as informações sobre as características construtivas dos veículos e licenciamento. 1.2 Objetivo Obter e validar informações do licenciamento do veículo. 1.3 Nome Base de Licenciamento. 1.4 Endereço do arquivo WSDL Homologação: Produção: 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. 2. Informações detalhadas do serviço 2.1 Acesso via Browser Endereço/Link de acesso Homologação: Produção: Telas Consulta por Chassi ou Placa 4

5 2.1.3 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 Possíveis retornos na consulta: Código Retorno Descrição Indica que a consulta foi realizada 000 Consulta realizada com sucesso com sucesso 5

6 001 Sua consulta não foi realizada, entre em contato com o suporte 002 Parâmetro inválido 003 Usuário ou Senha Inválido 004 Acesso não permitido para o IP Contrato inativo ou fora do período de vigência Cliente não possui permissão para o método Cliente não possui crédito disponível 009 Método inválido 010 Produto inválido Cliente já utilizou todas as consultas do Contrato de Experiência de Uso para esse método 011 Produto em desenvolvimento 012 Não há retorno para esta consulta Nenhum registro encontrado para este veículo Não há informações a serem consultadas Para realizar a consulta deve ser preenchida a placa ou o chassi Indica que ocorreu um erro inesperado e é preciso entre em contato com o suporte Indica que um ou mais campos estão nulos ou inválidos Indica que o usuário e/ou a senha informada são inválidos Indica que a consulta foi realizada a partir de um IP não cadastrado para a empresa do usuário Indica que a empresa não possui nenhum contrato ativo e/ou vigente para o produto. Indica que o usuário não tem permissão para realizar a consulta 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 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 não foi encontrado nenhum registro para os campos informados Indica que não foram encontrados registros para este veículo na base Cetip Indica que não existem informações sobre o parâmetro da consulta na Cetip Indica que apenas um dos parâmetros deve ser informado 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. 6

7 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 Chassi ou Placa Nome da Operação consultachassiplaca 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 à Base de Licenciamento realizadas com sucesso Estrutura dos Dados Nome do Campo Tipo Tamanho Descrição do Campo Dados da Consulta cdretornotransacao Int 3 Código de retorno da transação dscdretorno Char 255 Descrição do código de retorno qtdocorrencias Int 2 Quantidade de ocorrências da consulta Dados do Veículo Base Licenciamento codigorenavam Char 9 RENAVAM ufemplacamento Char 2 UF de Emplacamento proprietario Char 255 Nome Proprietário do veículo cpfcnpj Char 14 CPF ou CNPJ do Proprietário do Veículo placaatual Char 7 Placa do Veículo coddpvat Char 1 Código DPVAT chassi Char 17 Chassi do Veículo exercicio Int 4 Ano do exercício combustivel Char 1 Tipo de Combustível do Veículo marca Char Marca do Veículo anofabricacao Int 4 Ano de Fabricação dataatual Char 10 Data Atual Exemplos de retorno: caso de sucesso Exemplos de XML de retorno para consultas realizadas com sucesso Consulta por Chassi ou Placa <consulta> <BASELICENCIAMENTO> <cdretornotransacao>000</cdretornotransacao> <dscdretorno>consulta OK</dsCdRetorno> <qtdocorrencias>1</qtdocorrencias> <veiculos> <veiculo> 7

8 <codigorenavam> </codigorenavam> <ufemplacamento>pr</ufemplacamento> <proprietario>nome do Proprietário do Veículo</proprietario> <cpfcnpj> / </cpfcnpj> <placaatual>zzz0000</placaatual> <coddpvat>10</coddpvat> <chassi>0aa00000a </chassi> <exercicio>2015</exercicio> <combustivel>0</combustivel> <marca /> <anofabricacao>2014</anofabricacao> <dataatual>25/03/2015</dataatual> </veiculo> </veiculos> <saldo>0.00</saldo> <protocolo> </protocolo> </BASELICENCIAMENTO> </consulta> Informações de retorno: caso de erro Informações detalhadas de retorno para consultas realizadas com erro. 8

9 Exemplo de retorno: caso de erro <consulta> <BASELICENCIAMENTO> <codretorno>002</codretorno> <descretorno>parâmetro inválido</descretorno> <saldo>0,00</saldo> <protocolo> </protocolo> </BASELICENCIAMENTO> </consulta> <consulta> <BASELICENCIAMENTO> <codretorno>012</codretorno> <descretorno>não há retorno para esta consulta</descretorno> <saldo>0,00</saldo> <protocolo> </protocolo> </BASELICENCIAMENTO> </consulta> 2.4 Parâmetros de entrada das consultas Consulta por Chassi ou 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 Chassi * Varchar 21 Não Informar Chassi para consulta Placa * Varchar 7 Não Informar Placa para consulta Observação: Para os campos marcados com *, apenas um destes deve estar preenchido. 9