Manual de Integração. Webservice SOAP. Versão 2 08/2015

Transcrição

1 Manual de Integração Webservice SOAP Versão 2 08/2015

2 Produtos da JMB Tecnologia de Informação Ltda Site: Contatos: (suporte técnico) (comercial) Telefones: +55 (11) Sumário 1. Apresentação Endpoint Histórico de Alterações Métodos Métodos de Administração Método: consultarrecupera Método: consultarextrato Método: alterarsenha Método: consultarsaldo Método: consultarmovimentopre Métodos de Produto SERASA Método: consultarrechequepefin Método: consultarconcentre Método: consultarinfoempresa Método: consultarcreditbureau Método: consultarcadastro Métodos de Produtos de Outras Fontes Método: consultarveiculos Método: consultartelefones Método: consultarempresa Método: consultarscpcnet Método: consultarfiscalbasicopj Documentação do Webservice ATK 1

3 Método: consultarfiscalbasicopf Método: consultarintegrada Método: consultarconsumidores Método: consultarlocalizacaocpf Método: consultarlocalizacaocnpj Método: consultarpendenciasfinanceiras Resposta Exemplo de Utilização Em PHP Em Delphi Contato Documentação do Webservice ATK 2

4 1. Apresentação A JMB Tecnologia de Informação desenvolveu essa aplicação para uma integração padronizada de suas consultas com nossos parceiros de desenvolvimento. O Nosso objetivo é agilizar a integração inicial, minimizar as manutenções de layout ou novas versões dos serviços, e principalmente garantir que o retorno das consultas sempre chegue atualizado e completo para o cliente final. Os nossos parceiros já receberão os dados de resposta formatados conforme requerido contratualmente com o fornecedor da informação, no caso a SERASA Experian e BV. Esta versão entra em vigor em Junho/2015, e as formas anteriores de integração serão bloqueadas e desativadas em Dezembro/ Endpoint O endereço abaixo possui o XML de definição do Webservice (WSDL) Histórico de Alterações Versão Data Narração v1 01/06/2015 Lançamento do Webservice v2 08/08/2015 Alteração nas funcionalidades dos produtos Recheque/Pefin e Concentre. Inclusão dos produtos CreditBureau e InfoEmpresas. 4. Métodos Abaixo estão descritos TODOS os métodos para os serviços disponíveis em nosso tarifador. Verifique junto ao departamento comercial da ATK/JMB, quais os serviços contratados na sua integração, pois somente o que for contratado será liberado para consulta, assim como os PREÇOS dos serviços e detalhes dos mesmos. Todos os métodos possuem dois parâmetros obrigatórios, necessários para identificação do usuário/cliente que realiza consulta. usuario Número Sim Usuário para login senha Texto Sim Senha do usuário formatohtml Texto Não Formatação do HTML da resposta, negociado com o Departamento Comercial. Qualquer parâmetro enviado que não faz parte do método ou diferente que qualquer um definido abaixo será ignorado. Documentação do Webservice ATK 3

5 4.1. Métodos de Administração Método: consultarrecupera O método recupera uma consulta realizada anteriormente. consulta Número Sim Número da consulta a ser recuperada Método: consultarextrato Este produto relaciona de forma sintética ou analítica as consultas realizadas no período solicitado tudo que o cliente consultou. O campo "Valor" (valores cobrados nas consultas) será apresentado somente se a modalidade do cliente for um pré-pago. O horário das consultas são considerado em GMT+0:00, sem acréscimos de horário de verão. Haverá limite de 1000 linhas por consulta, para evitar lentidão e sobrecarga no protocolo do webservice. Parâmetros para o extrato do mês atual Consultas do mês corrente. filtro Texto Sim Informar "mes". Parâmetros para o extrato do mês anterior Consultas realizadas no mês anterior ao corrente. filtro Texto Sim Informar "mes-1". Parâmetros para o extrato para dois meses anteriores Consultas realizadas dois meses anterior ao corrente. filtro Texto Sim Informar "mes-2". Parâmetros para o extrato por período Consultas realizadas em um período definido. Períodos longos poderão atrasar a resposta da consulta. Documentação do Webservice ATK 4

6 filtro Texto Sim Informar "periodo". datainicial Texto Sim Data de início do período, no formato DD/MM/AAAA. O horário inicial será considerado como 00:00:00. datafinal Texto Sim Data de final do período, no formato DD/MM/AAAA. O horário final será considerado como 23:59:59. Parâmetros para o extrato por intervalo do número das consultas Consultas realizadas entre uma numeração e outra. Intervalos longos poderão atrasar a resposta da consulta. O número das consultas é única e sequencial ascendente para todas as consultas realizadas, portanto para um cliente, os números não serão consecutivos. filtro Texto Sim Informar intervalo. consultainicial Número Sim Número da consulta inicial. consultafinal Número Sim Número da consulta final. Parâmetros adicionais Completa o filtro das consultas solicitadas pelos parâmetros anteriores. agregar Número Não Informar 1 para agregar/agrupar as consultas por produto. A soma dos valores das consultas é exclusivo para clientes pré-pago. incluirerros Número Não Informar 1 para considerar as consultas com erro. incluirgrupo Número Não Informar 1 para também incluir as consultas de outros usuários, do mesmo grupo do cliente que foi informado no parâmetro usuário Método: alterarsenha Troca de senha pelo usuário. Parâmetros para troca de senha: novasenha Texto Sim Nova senha escolhida pelo usuário, permite letras, números e é case-sensitive. confirmacao Texto Sim Exija que seu cliente faça redigitarão da senha, e passe neste segunda parâmetro. Documentação do Webservice ATK 5

7 Método: consultarsaldo O método recupera o saldo da conta, apenas para clientes pré-pago. Não há parâmetros extras além do usuário e senha Método: consultarmovimentopre Movimentos de créditos para Clientes Pré-Pagos. (Em processo de liberação no WebService) 4.2. Métodos de Produto SERASA Detalhe sobre o conteúdo da resposta das consultas dos Produtos SERASA ver em ou Método: consultarrechequepefin Este produto traz informações sobre um Cheque e/ou PEFIN (Pendências Financeiras). Nesse método podese consultar um ou mais cheques, com a consulta de PEFIN agregada ou apenas a uma consulta de Pefin; enviar apenas os parâmetros da consulta desejada. Parâmetros de identificação do consultado: cpf Texto Sim¹ Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. cnpj Texto Sim¹ Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. ¹ Obrigatório informar CPF ou CNPJ de acordo com o documento a ser consultado Parâmetros para uma consulta de Cheque (via CMC7 ou Dados Bancários): Via CMC7: Identificando o cheque através do código do CMC7 localizando na parte inferior da folha. cmc7inicial Número Sim² As 30 posições (os 3 blocos de números juntos, 8, 10 e 12 caracteres respectivamente) do primeiro cheque ou o único para consulta cmc7final Número Não² As 30 posições (os 3 blocos de números juntos, 8, 10 e 12 caracteres respectivamente) do último cheque a ser consultado de uma sequência de até 12 cheques. Documentação do Webservice ATK 6

8 Via dados bancários: Identificando o cheque através das informações de número do cheque, banco, agência e conta. chequeinicial Número Sim² Número do cheque inicial ou único a ser consultado, com o dígito. Está localizado na parte superior da folha, nos campos C2 e C3, exemplo: chequefinal Número Não² Número do cheque final a ser consultado, de uma sequência de até 12 cheques, com o dígito. Está localizado na parte superior da folha, nos campos C2 e C3, exemplo: banco Número Sim² Número do banco com até 3 algarismos. agencia Número Sim² Número da agência com até 4 algarismos mais o dígito verificador (a posição mais à direita será considerada o dígito da agência). conta Número Sim² Número da conta corrente com o dígito (a posição mais à direita será considerada o dígito da conta). ² Obrigatório informar quando optar pelo tipo de consulta: CMC7 ou Dados Bancários Se forem enviados parâmetros via "CMC7" e via "Dados Bancários" sistema considerará somente o CMC7 e ignorará os dados bancários. Parâmetros complementares para uma consulta de Cheque: adicionais Texto Não Consultar Tabela 2. Exemplo: +alertacheque+irm Parâmetros para consulta de PEFIN Dados de Pendencias Financeiras, com ou sem a consulta de cheque. pefin Texto Sim³ Consultar Tabela 1. adicionais Texto Não Consultar Tabela 2. Exemplo: +gastoestimado+irm+alertascoring uf Texto Sim 4 No caso de Pefin com protesto estadual, especificar o unidade federativa. (esse parâmetro será ignorado se não for requisitado Pefin Estadual) ³ Obrigatório somente quando escolher esse opcional 4 Obrigatório somente quando escolher Protesto Estadual Tabela 1 - Valores possível para o parâmetro "pefin" Código normal protestoestadual protestonacional Descrição Consulta sem protestos. Traz protestos do Estado requisitado. Não tem custo adicional. (Informar também o estado no parâmetro "uf") Traz protesto a nível nacional. Adicional de 2 e 1/2 (duas vezes e meia) o valor da consulta de Pefin. Documentação do Webservice ATK 7

9 Nota: O parâmetro "adicionais" quando necessário deve ser enviado uma única vez com todas as opções tanto de Recheque quanto de Pefin. Opções enviadas que não estão disponíveis para Recheque ou Pefin, PF ou PJ serão ignoradas. Tabela 2 - Valores possíveis para o parâmetro "adicionais" (quantos forem desejados) Código Disponível Descrição +alertaidentidade v2 Pefin, PF e PJ Alerta de Identidade. Adicional de 1 vez o valor da consulta de Cheque com Pefin para PF e 1/2 (metade) do valor da consulta Cheque com Pefin para PJ. +alertaobito Pefin, PF Alerta de Óbito. Adicional de 1 e 1/2 (uma vez e meia) o valor da consulta de Pefin. +gastoestimado Pefin, PF e PJ Gasto Estimado. Adicional de 2 e 1/2 (duas vezes e meia) o valor da consulta de Pefin. +IRM Pefin e Recheque, PF e PJ IRM (Índice de Relacionamento de Mercado). Adicional de 4 vezes o valor da consulta de Cheque (se só cheque) OU 1 e 1/2 (um vez e meia) a Consulta de Pefin PF OU 1,16 vezes a consulta de Pefin PJ. +participacaosocietaria Pefin, PF Participação Societária. Adicional de 1 (uma vez) o valor da consulta de Pefin. +limitecredito Pefin, PF e PJ Limite de Crédito. Adicional de 1 vez o valor da consulta de Cheque com Pefin PF ou 3 vezes a consulta Pefin PJ. +localizacaoendereco Pefin, PF e PJ Localização de Endereço. Adicional de 1 vez o valor da consulta de Cheque com Pefin PF ou 1 vez a consulta de Pefin PJ. +rendapresumida Pefin, PF Renda Presumida. Adicional de 2 vezes o valor da consulta de Pefin. +rendaestimada v2 Pefin, PF Renda Mensal Estimada. Adicional de 2 vezes o valor da consulta de Pefin. +alertascoring v2 Pefin, PJ (Opção temporariamente desativada) Alerta Scoring. Adicional de 1 vez o valor da consulta de Pefin. +faturamentopresumido Pefin, PJ Faturamento Presumido. Adicional de 3 (três) vezes o valor da consulta de Pefin. +indicadoroperacionalidade Pefin, PJ Indicador de Operacionalidade. Adicional de 1 vez o valor da consulta de Pefin. +socioadministradores Pefin, PJ Sócios e Administradores. Adicional de 1,75 vezes o valor da consulta de Pefin. +participacaoemempresas Pefin, PJ Participação em Empresas. Adicional de 1,75 vezes o valor da consulta de Pefin. +riscocredito v2 Pefin, PJ Classificação de Risco de Crédito. Adicional de 2 vezes o valor da consulta de Pefin. +alertadecheque Recheque, PF e PJ Informa os alertas de cheque para o CPF ou CNPJ. Adicional de 1 vez o valor da consulta de Cheque com Pefin. Parâmetros para agregar dados à consulta de Recheque ou Pefin: Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. Documentação do Webservice ATK 8

10 telefone Texto Sim 5 Confirmação da titularidade do telefone informado. Informar o DDD, entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente. Parâmetros para consulta de endereço Realize uma consulta agregadora de confirmação de endereço. cep Texto Sim 5 Código de Endereçamento Postal com de 8 algarismos. Pode conter o traço separador porque será retirado arbitrariamente. 5 Obrigatório somente quando escolher esse opcional Método: consultarconcentre Este produto traz informações Restrições de Crédito de Pessoa Física e / ou Jurídica; enviar apenas os parâmetros da consulta desejada. Parâmetros de identificação do consultado: cpf Texto Sim¹ Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. cnpj Texto Sim¹ Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. ¹ Obrigatório informar CPF ou CNPJ de acordo com o documento a ser consultado. Parâmetros para consulta de Concentre concentre Texto Sim Consultar Tabela 3. adicionais Texto Não Consultar Tabela 4. Exemplo: +gastoestimado+irm+alertaobito Tabela 3 - Valores possível para o parâmetro "concentre" Código resumido detalhado Descrição Detalhes das ocorrências em até 5 registros. Detalhes das ocorrências em até 99 registros. Adicional de 1/6 (um sexto) o valor da consulta de Concentre. Nota: Opções enviadas que não estão disponíveis para PF ou PJ serão ignoradas. Documentação do Webservice ATK 9

11 Tabela 4 - Valores possíveis para o parâmetro "adicionais" (quantos forem desejados) Código Disponível Descrição +alertaidentidade v2 PF e PJ Alerta de Identidade. Adicional de 1/3 (um terço) do valor da consulta de Concentre. +alertaobito PF Alerta de Óbito. Adicional de 1/2 (metade) do valor da consulta de Concentre. +gastoestimado PF e PJ Gasto Estimado. Adicional de 1 (uma) vez o valor da consulta de Concentre. +IRM PF e PJ IRM (Índice de Relacionamento de Mercado). Adicional de 1/2 (metade) do valor da consulta de Concentre. +participacaosocietaria PF Participação Societária. Adicional de 1/5 (um quinto) do valor da consulta de Concentre. +limitecredito PF e PJ Limite de Crédito. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. +localizacaoendereco PF e PJ Localização de Endereço. Adicional de 1/5 (um quinto) do valor da consulta de Concentre. +rendapresumida PF Renda Presumida. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. +rendaestimada v2 PF Renda Mensal Estimada. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. +alertascoring v2 PJ (Opção temporariamente desativada) Alerta Scoring. Adicional de 1/5 (um quinto) do valor da consulta de Concentre. +faturamentopresumido PJ Faturamento Presumido. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. +indicadoroperacionalidade PJ Indicador de Operacionalidade. Adicional de 1/3 (um terço) do valor da consulta de Concentre. +sociosadministradores PJ Sócios e Administradores. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. +participacaoemempresas PJ Participação em Empresas. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. +recuperacaocredito v2 PJ Índice de Recuperação de Crédito. Adicional de 1/2 (metade) do valor da consulta de Concentre. +confirmei PF e PJ Informa os alertas de cheque para o CPF ou CNPJ. Adicional de 1/3 (um terço) do valor da consulta de Concentre. +consultas PF e PJ Registros das consultas efetuadas por outros à esse CPF ou CNPJ (passagens). Adicional de 1/6 (um sexto) do valor da consulta de Concentre. +classificacaorisco1 v2 ou +classificacaorisco2 v2 PJ Classificação de risco de crédito 1.0 ou 2.0. Adicional de 1/3 (um terço) para 1.0 e 2/3 (dois terços) para 2.0 do valor da consulta de Concentre. +riscocreditosetor v2 PJ Risco de Crédito no Setor. Adicional de 2/3 (dois terços) do valor da consulta de Concentre. Documentação do Webservice ATK 10

12 Parâmetros para agregar dados à consulta de Concentre: Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. telefone Texto Sim 5 Confirmação da titularidade do telefone informado. Informar o DDD, entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente. 5 Obrigatório somente quando escolher esse opcional Método: consultarinfoempresa Novo método liberado a partir da v2. Relatório de Comportamento de Negócios de Pessoas Jurídicas. Parâmetros de identificação do consultado: cnpj Texto Sim¹ Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. ¹ Obrigatório informar CNPJ de acordo com o documento a ser consultado. Parâmetros para consulta de infoempresa adicionais Texto Não Consultar Tabela 5. Exemplo: +gastoestimado+irm+quadrosocial Tabela 5 - Valores possíveis para o parâmetro "adicionais" (quantos forem desejados) Código +alertaidentidade +IRM +participacaosocietaria +quadrosocial ou +quadrosocialcompleto +consultas +gastoestimado +riscocreditosetor +faturamentopresumido Descrição Alerta de Identidade. Adicional de 1/4 (um quarto) do valor base da consulta de InfoEmpresa. IRM (Índice de Relacionamento de Mercado). Adicional de 1/3 (um terço) do valor base da consulta de Info Empresa. Participação Societária. Adicional de 1/3 (um terço) do valor base da consulta de InfoEmpresa. Quadro Social ou Quadro Social Completo. Adicional de 1/3 (um terço) para quadro social e 2/3 para quadro social completo do valor base da consulta de InfoEmpresa. Registro de Consultas (Passagens). Adicional de 1/3 (um terço) do valor da consulta de InfoEmpresa. Gasto Estimado. Adicional de 2/3 (dois terços) do valor da consulta de InfoEmpresa. Risco de Crédito no Setor. Adicional de 1/2 (metade) do valor da consulta de InfoEmpresa. Faturamento Presumido. Adicional de 2/3 (dois terços) do valor da consul- Documentação do Webservice ATK 11

13 +limitecredito +perfilfinanceiro +riskscoring3 ou + riskscoring4 +alternativos +situacaofiscal ta de InfoEmpresa. Limite de Crédito. Adicional de 2/3 (dois terços) do valor da consulta de InfoEmpresa. Perfil Financeiro. Adicional de 1 e 1/2 (uma vez e meia) do valor da consulta de InfoEmpresa. Classificação de Risco 3.0 ou 4.0. Adicional de 4/9 (quatro nonos) para 3.0 e 1/2 (metade) do valor da consulta para 4.0 de InfoEmpresa. Endereços e telefones alternativos. Adicional de 1/3 (um terço) do valor do Info Empresa. Situação Fiscal. Adicional de 1/4 (um quarto) do valor do Info Empresa Método: consultarcreditbureau Novo método liberado a partir da v2. Cadastro Positivo de Pessoas Físicas. Parâmetros de identificação do consultado: cpf Texto Sim¹ Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. ¹ Obrigatório informar CPF de acordo com o documento a ser consultado. Parâmetros para consulta de CreditBureau adicionais Texto Não Consultar Tabela 6. Exemplo: +rendaestimada+irm+quadrosocial Tabela 6 - Valores possíveis para o parâmetro "adicionais" (quantos forem desejados) Código Descrição +obito Alerta de Óbito. Adicional de 1/5 (um quinto) do valor base da consulta de Credit Bureau. +alertaidentidade Alerta de Identidade. Adicional de 1/5 (um quito) do valor base da consulta de Credit Bureau. +limitecredito Limite de Crédito. Adicional de 2/3 (dois terços) do valor base da consulta de Credit Bureau. +rendapresumida (Opção temporariamente desativada) Renda Presumida. Adicional de 2/3 (dois terços) do valor base da Consulta de Credit Bureau. +rendaestimada Renda Estimada. Adicional de 2/3 (dois terços) do valor base da consulta de Credit Bureau. +irm IRM (Índice de Relacionamento de Mercado). Adicional de 1/2 (metade) do valor base da consulta de Credit Bureau. +gastoestimado Gasto Estimado. Adicional de 1 (uma) vez do valor da consulta de Credit Bureau. +anotacoes Mais Anotação (99 ocorrências). Adicional de 1/5 (um quinto) do valor base da Consulta de Credit Bureau. Documentação do Webservice ATK 12

14 Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. telefone Texto Sim Confirmação da titularidade do telefone informado. Informar o DDD, entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente Método: consultarcadastro Este produto traz informações da Receita federal, confirmação de Nome de Pessoas Física ou Juridicas; enviar apenas os parâmetros da consulta desejada. Parâmetros de identificação do consultado: cpf Texto Sim¹ Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. cnpj Texto Sim¹ Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. ¹ Obrigatório informar CPF ou CNPJ de acordo com o documento a ser consultado. Parâmetros para agregar dados à consulta de Cadastro: Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. telefone Texto Sim 5 Confirmação da titularidade do telefone informado. Informar o DDD, entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente. Parâmetros para consulta de endereço Realize uma consulta agregadora de confirmação de endereço. cep Texto Sim 5 Código de Endereçamento Postal com de 8 algarismos. Pode conter o traço separador Documentação do Webservice ATK 13

15 5 Obrigatório somente quando escolher esse opcional. porque será retirado arbitrariamente. Documentação do Webservice ATK 14

16 4.3. Métodos de Produtos de Outras Fontes Método: consultarveiculos O método obtém informações de um veículo. subservico Texto Sim Ver Tabela 7. (Outros parâmetros exigidos de acordo com a Tabela 8, descritos na Tabela 7) Tabela 7 - Valores possíveis para o parâmetro "subservico" (permitido somente um por consulta) Código Descrição Parâmetros Obrigatórios base-de-leilao Informa as ocasiões quando o veículo consultado chassi ou placa foi a leilão e as URLs contendo as fotos dos veículos que foram a leilão. chassi-decodificador Dados do decodificador do Chassi, autenticidade chassi do chassi mencionado na solicitação chassi-motor Dados de Chassi x Motor (Correspondentes) chassi ou motor chassi-precificador Dados de Precificador (Tabela FIPE) chassi crv-crlv Dados da CRLV's crlv debitos-estaduais Descreve as características e restrições do veículo, (placa e uf) ou chassi com a indicação de débitos de multas e IPVA. dpvat Descreve as características dos três últimos seguros chassi obrigatórios pagos do veículo. gravame Descreve as características da alienação. chassi proprietarios-historico proprietario-confirmacao proprietario-veiculos relacionados renavam Histórico de todos os pagamentos e licenciamentos do veículo. Retorna a quantidade total de proprietários anteriores (até 150 registros) e demais dados, conforme informado no período e UF quando selecionada. Informa até 12 veículos vinculados ao documento consultado. Retorna a quantidade total de veículos relacionados ao documento pesquisado (até 150 registros) e demais dados relacionados e informado no período. Descreve as características do veículo (ex: marca/modelo, cor, potência, tração, etc), restrições (ex: alienação, arrendamento, etc) e alerta placa ou chassi. Se informado anoinicial e anofinal retornará informações analítica. UF opcional por placa. (placa e uf) ou chassi cpf ou cnpj (cpf ou cnpj) e anoinicial e anofinal. placa ou motor ou chassi ou cambio ou RENAVAM Documentação do Webservice ATK 15

17 de roubo/furto. renavam-dpvat-gravame Combinação dos três subserviços. chassi roubo-furto sinistro Descreve as características do veículo e detalha as informações de roubo/furto (exemplo: data e município da ocorrência, etc.) Informa a existência de Sinistro de Indenização Integral para o Chassi/Placa consultada. chassi ou placa chassi ou placa Tabela 8 - Parâmetros possíveis para a consulta conforme requisitado na Tabela 7 correspondente ao subserviço escolhido Parâmetro Tipo Descrição placa Texto Placa do veículo, no formato ABC1234 chassi Texto Chassis com 17 caracteres renavam Número RENAVAM com 11 algarismos motor Texto Motor com 20 caracteres cambio Texto Câmbio com 20 caracteres cpf Texto Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. cnpj Texto Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. crlv Texto Certificado de Registro e Licenciamento de Veículo com 21 caracteres uf Texto Dois caracteres representando a Unidade Federativa anoinicial Número Ano inicial de um período, no formato anofinal Número Ano final de um período, formato Método: consultartelefones Informações do Endereço de Instalação e Confirmação da titularidade do Telefone informado ou dos telefones de um CPF: Pode-se realizar a consulta pelo número de telefones (até 2) ou pelo número do CPF (Pessoa Física), se for enviado número de telefone e CPF o sistema priorizará a consulta por CPF e ignorará o número do telefone informado. Parâmetros da consulta via telefone: telefone Texto Sim 5 Confirmação da titularidade do telefone informado. Informar o DDD, entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente. telefone2 Texto Não Confirmação da titularidade do segundo telefone informado. Informar o DDD, entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente. Documentação do Webservice ATK 16

18 Parâmetros da consulta via CPF: cpf Texto Sim¹ Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. 5 Obrigatório informar CPF ou telefone de acordo com o a opção de consulta escolhido Método: consultarempresa Este produto informações sobre uma empresa. É um relatório de informação completa de pessoa jurídica, contemplando informações cadastrais e restritivas da empresa, bem como informações de outras participações em empresas. Fornece as seguintes informações: CNPJ, Razão Social; Endereço; Data de Fundação; Participação Societária (CPF, Nome, Capital Social, NIRE) Pendências e Restrições Financeiras; Emitentes de cheques sem fundos (CCF - Resolução 1682 do Banco Central) Protestos; Recuperação, Falências e Ações. cnpj Texto Sim Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. detalhamento Texto Sim Informar analitica ou sintetica. incluirscore Número Não Informar 1 para acrescentar pontuação em uma escala. Opção disponível somente para detalhamento analítico. incluirparticipacao Número Não Informar 1 para acrescentar informação de Participação em outras empresas, qualquer outro valor será considerado sem essa informação. incluirsocios Número Não Informar 1 para acrescentar a informação dos sócios e administradores da empresa Método: consultarscpcnet Este produto informações sobre de uma empresa ou pessoa física com dados do SCPC Serviço Central de Proteção ao Crédito da Boa Vista Serviços. Abaixo segue as relação de parâmetros exclusivos de PF ou PJ, parâmetros comuns entre dois tipos de pessoa e parâmetros de consulta agregadoras, como cheque, telefone e CEP. Documentação do Webservice ATK 17

19 Parâmetros exclusivos para consulta de pessoas físicas (PF) cpf Texto Sim Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. tipocredito Texto Não Tipo de Crédito para PF. Ver Tabela 9. Parâmetros exclusivos para consulta de pessoas jurídica (PJ) cnpj Texto Sim Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. tipocredito Texto Não Tipo de Crédito para PJ. Ver Tabela 9. Parâmetros comuns entre pessoas físicas e jurídicas valorcredito Texto Não Valor do crédito. Usar ponto ou vírgula para separar os decimais. Não usar separador de milhares. abrangencia Texto Não Abrangência. Ver Tabela 10. Se não for informado, será considerado valor nacional. uf Texto Depende Unidade Federativa, com dois caracteres, obrigatória quando a abrangência for estadual. incluirscore Número Não Informar 1 para acrescentar a informação de Scoring. Mais detalhes aqui. Parâmetros para consulta de cheque pelo CMC7 Realize uma consulta agregadora de cheque através do código do CMC7 localizando na parte inferior da folha. cmc7 Texto Não As 30 posições (os 3 blocos de números juntos, 8, 10 e 12 caracteres respectivamente) qtdecheques Número Não Quantidade de cheques a ser verificado (sequencia superior ao do informado), permitido até 24 cheques. databoa Texto Não Data para desconto do primeiro cheque Parâmetros para consulta de cheque pelos dados bancários Realize uma consulta agregadora de cheque através das informações de número do cheque, banco, agência e conta. Documentação do Webservice ATK 18

20 cheque Texto Não Número do cheque com o dígito. Está localizado na parte superior da folha, nos campos C2 e C3, exemplo: qtdecheques Número Não Quantidade de cheques a ser verificado (sequencia superior ao do informado), permitido até 24 cheques. databoa Texto Não Data para desconto do primeiro cheque, no formado DD/MM/AAAA. banco Número Não Número do banco com até 3 algarismos agencia Número Não Número da agência com até 4 algarismos mais o dígito verificador (a posição mais à direita será considerada o dígito da agência). conta Número Não Número da conta corrente com o dígito (a posição mais à direita será considerada o dígito da conta). Parâmetros para consulta de CEP Realize uma consulta agregadora de confirmação de endereço através do CEP informado. cep Texto Não Código de Endereçamento Postal com de 5 algarismos. Pode conter o traço separador porque será retirado arbitrariamente. Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. telefone Texto Não Informar o DDD entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente. Tabela 9 - Valores possíveis para o parâmetro "tipocredito" Valor CC CD CH CP CV OU Valor FI ME Descrição do Tipo de Crédito para Pessoa Física Cartão de Crédito Crédito Direto Cheque Crédito Pessoal Crédito de Veículos Outros Descrição do Tipo de Crédito para Pessoa Jurídica Financeira Mercantil Documentação do Webservice ATK 19

21 Tabela 10 - Valores possíveis para o parâmetro "abrangencia" Valor Descrição nacional Abrangência nacional. estadual Abrangência estadual. Se utilizado, obriga o preenchimento do parâmetro uf Método: consultarfiscalbasicopj Este produto informações fiscais de uma empresa, com base nos bancos de dados da Receita Federal, Sintegra (Fazenda Estadual), QSA (Quadro de sócio e administradores) e responsáveis legais. Cada opcional acrescentado será cobrado de acordo com o Pacote de Serviços contratado. cnpj Texto Sim Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. incluirfaturamento Número Não Informar 1 para incluir Informação de Faturamento Presumido. incluirparticipacao Número Não Informar 1 para incluir informação de participação desta empresa em outras empresas. incluirsocios Número Não Informar 1 para incluir informação de sócios e administradores. incluirsociosoutrasempresas Número Não Informar 1 para incluir informação da participação dos sócios em outras empresas. incluirccf Número Não Informar 1 incluir informação de cheques sem fundos desta empresa. incluirccfoutrasempresas Número Não Informar 1 para incluir informação de cheques sem fundos das empresas que esta empresa participa. incluirccfsocios Número Não Informar 1 para incluir informação de cheques sem fundos dos sócios e administradores. incluirccfsociosoutrasempresas Número Não Informar 1 para incluir informação de cheques sem fundos das empresas em que os sócios e administradores participam Método: consultarfiscalbasicopf Este produto consulta informações fiscais de uma pessoa física. Informação Cadastral de Empresas com base nos bancos de dados da Receita Federal, Sintegra (Fazenda Estadual), QSA (Quadro de sócio e administrado- Documentação do Webservice ATK 20

22 res) e responsáveis legais. Cada opcional acrescentado será cobrado de acordo com o Pacote de Serviços contratado. cpf Texto Sim Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. incluirparticipacao Número Não Informar 1 para incluir informação de participação deste CPF em outras empresas. incluirccf Número Não Informar 1 para incluir informação de cheques sem fundos deste CPF. incluiccfparticipacoes Número Não Informar 1 para incluir informação de cheques sem fundos das empresas que este CPF participa Método: consultarintegrada Este produto fornece informações comerciais de consumidores (pessoa física) para as empresas que trabalham com operações de crédito e vendas a prazo. cpf Texto Sim Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. tipocredito Texto Não Tipo de Crédito para PF. Ver Tabela 9. valorcredito Texto Não Valor do crédito. Usar ponto ou vírgula para separar os decimais. Não usar separador de milhares. Parâmetros para consulta de cheque pelo CMC7 Realize uma consulta agregadora de cheque através do código do CMC7 localizando na parte inferior da folha. cmc7 Texto Não As 30 posições (os 3 blocos de números juntos, 8, 10 e 12 caracteres respectivamente) qtdecheques Número Não Quantidade de cheques a ser verificado (sequencia superior ao do informado), permitido até 24 cheques. databoa Texto Não Data para desconto do primeiro cheque Parâmetros para consulta de cheque pelos dados bancários Realize uma consulta agregadora de cheque através das informações de número do cheque, banco, agência e conta. Documentação do Webservice ATK 21

23 cheque Texto Não Número do cheque com o dígito. Está localizado na parte superior da folha, nos campos C2 e C3, exemplo: qtdecheques Número Não Quantidade de cheques a ser verificado (sequencia superior ao do informado), permitido até 24 cheques. databoa Texto Não Data para desconto do primeiro cheque, no formado DD/MM/AAAA. banco Número Não Número do banco com até 3 algarismos agencia Número Não Número da agência com até 4 algarismos mais o dígito verificador (a posição mais à direita será considerada o dígito da agência). conta Número Não Número da conta corrente com o dígito (a posição mais à direita será considerada o dígito da conta). Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. telefone Texto Não Informar o DDD entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente Método: consultarconsumidores Este produto fornece informações de identificação e localização, dados comportamentais e restritivos de pessoa físicas. cpf Texto Sim Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. tipocredito Texto Não Tipo de Crédito para PF. Ver tabela 33. valorcredito Texto Não Valor do crédito. Usar ponto ou vírgula para separar os decimais. Não usar separador de milhares. Parâmetros para consulta de cheque pelo CMC7 Realize uma consulta agregadora de cheque através do código do CMC7 localizando na parte inferior da folha. cheque Texto Não As 30 posições (os 3 blocos de números juntos, 8, 10 e 12 caracteres respectivamente) Documentação do Webservice ATK 22

24 qtdecheques Número Não Quantidade de cheques a ser verificado (sequencia superior ao do informado), permitido até 24 cheques. databoa Texto Não Data para desconto do primeiro cheque Parâmetros para consulta de cheque pelos dados bancários Realize uma consulta agregadora de cheque através das informações de número do cheque, banco, agência e conta. cheque Texto Não Número do cheque com o dígito. Está localizado na parte superior da folha, nos campos C2 e C3, exemplo: qtdecheques Número Não Quantidade de cheques a ser verificado (sequencia superior ao do informado), permitido até 24 cheques. databoa Texto Não Data para desconto do primeiro cheque, no formado DD/MM/AAAA. banco Número Não Número do banco com até 3 algarismos agencia Número Não Número da agência com até 4 algarismos mais o dígito verificador (a posição mais à direita será considerada o dígito da agência). conta Número Não Número da conta corrente com o dígito (a posição mais à direita será considerada o dígito da conta). Parâmetros para consulta de telefone Realize uma consulta agregadora de confirmação de titularidade do telefone. telefone Texto Não Informar o DDD entre parênteses, seguido o número do telefone. Formato (9999) Pode conter traços e espaços, pois será retirado arbitrariamente Método: consultarlocalizacaocpf Este produto fornece informações de identificação e localização de pessoa físicas, ideal para empresas que realizam ações de prospecção, marketing e cobrança. cpf Texto Sim Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. detalhamento Texto Sim Informar analitica ou sintetica. Texto Não da pessoa física. Documentação do Webservice ATK 23

25 Método: consultarlocalizacaocnpj Este produto fornece informações de identificação e localização de pessoa físicas, ideal para empresas que realizam ações de prospecção, marketing e cobrança. cnpj Texto Sim Número do Cadastro Nacional de Pessoa Jurídica. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. razao Texto Não Razão social da empresa, para registrar passagens. detalhamento Texto Sim Ver tabela 35. Tabela 35 - Valores possíveis para o parâmetro "detalhamento" Valor cadastro capitalsocial ramosatividade participantes participacoes Descrição Informações cadastrais e de localização. Informações de percentual de quotas ou ações de cada sócio dentro da empresa, seja ela LTDA ou sociedade anônima. Informações dos ramos de atividade secundários a empresa está inscrita. Informações dos sócios da empresa, data de adesão e percentual de participação no capital social da empresa. Informações se a empresa participa em outras sociedades Método: consultarpendenciasfinanceiras Este produto fornece informações de identificação e localização de pessoa físicas, ideal para empresas que trabalham com operações de crédito e vendas a prazo aos consumidores pessoa físicas. Toda informação adicional será registrada como passagem. cpf Texto Sim Número do Cadastro Nacional de Pessoa Física. Pode conter pontos, traços e barras porque serão retirados arbitrariamente. nome Texto Não Nome da pessoa endereco Texto Não Endereço completo da pessoa rg Texto Não Número do documento RG (Registro Geral) outrodocumentotipo Texto Não Ver Tabela 11. outrodocumento Texto Não Número do outro documento. datanascimento Texto Não Data de nascimento, no formato DDMMAAA. tipocredito Texto Não Tipo de Crédito para PF. Ver tabela 33. valorcredito Texto Não Valor do crédito. Usar ponto ou vírgula para separar os decimais. Não usar separador de milhares. Documentação do Webservice ATK 24

26 Tabela 11 - Valores possíveis para o parâmetro "outrodocumentotipo" Valor Descrição CIE Carteira de Estrangeiro CF Carteira Funcional CNH Carteira Habilitação CP Carteira Profissional CR Certificado de Reservista CRC Conselho Regional de Contabilidade CRM Conselho Regional de Medicina RE Força Militar IMA Identificação Militar da Aeronáutica IMM Identificação Militar da Marinha IME Identificação Militar do Exército OAB Ordem dos Advogados do Brasil PAS Passaporte RNE Registro Nacional de Estrangeiro TE Título de Eleitor 5. Resposta Todos os métodos devolvem as seguintes informações: Parâmetro Tipo Presente Descrição consulta Número Sempre Identificação numérica da consulta realizada. html Texto Sempre Informações da consulta em formato HTML¹. ¹ As respostas retornam em formato HTLM padrão, porém sua empresa pode ter um formato de HTML personalizado e previamente negociado ou contratado junto ao Departamento Comercial. Nesse caso é obrigatório enviar o parâmetro FORMATOHTML com o código que foi passado pelo Departamento Comercial quanto a essa negociação. Documentação do Webservice ATK 25

27 6. Exemplo de Utilização 6.1. Em PHP Para realizar uma consulta ao Webservice através de linguagem de programação PHP, é necessário ter a classe NuSoap. Nós estendemos esta classe para criar o método call() que é mais fácil de usar. <?php require(',global-nusoap.php'); $webservice = new Nusoap_pesonalizado(' $params = Array(); $params['usuario'] = 12345; $params['senha'] = 'suasenha'; $params['consulta'] = 5304; $resposta = $webservice->call('consultarrecupera', $params); if(isset($resposta['faultcode'])) { print '<font color="red">erro '.$resposta['faultcode'].' - '.$registro['faulttext'].'</font>'; }else{ }?> print $resposta['html']; 6.2. Em Delphi Criar: File New Other aba WebService, e abra WSDL importer, no box que abriu, informei só o endereço do WDSL como: " e salvar com o nome "server_atk" por exemplo. No exemplo foi criado um projeto com uma única unit com um campo para informar o número de referencia, um botão para chamar a consulta, e um campo memo para exibir a resposta, incluir um objeto do Delphi: (webserver) HTTPRIO (SOAPTPClient), no exemplo foi trocado o nome para "pri1" e nada mais, permanecem os parâmetros default. Abaixo toda a codificação note o botão que faz a consulta: procedure TForm1.Button1Click(Sender: TObject); A resposta esta num objeto memo, no entanto a resposta é um html e tem que ser tratado num objeto específico para essa finalidade (TWebBrowser ou similar). Documentação do Webservice ATK 26

28 unit Unit1; interface uses Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, Dialogs, InvokeRegistry, StdCtrls, Rio, SOAPHTTPClient, OleCtrls, SHDocVw, UThread, ExtCtrls; type TForm1 = class(tform) pri1: THTTPRIO; ed_numero: TEdit; Label1: TLabel; Button1: TButton; mostra: TMemo; procedure Button1Click(Sender: TObject); private { Private declarations } public { Public declarations } end; var Form1: TForm1; implementation {$R *.dfm} uses server_atk; procedure TForm1.Button1Click(Sender: TObject); var ser: webservice_atk_integracaoporttype; envia: consultarrecupera_inputdatatype; retorno: consultarrecupera_outputdatatype; xx, yy : string; begin ser:= Getwebservice_atk_integracaoPortType(false, '',pri1); retorno:= consultarrecupera_outputdatatype.create; envia:= consultarrecupera_inputdatatype.create; envia.usuario:='seucodigo'; envia.senha:='suasenha'; envia.consulta:=strtoint(ed_numero.text); try retorno:= ser.consultarrecupera(envia); except Documentação do Webservice ATK 27

29 on E: ERemotableException do begin // Metodo xx:=e.faultactor; // codigo do erro interno - sem efeito xx:=e.faultcode; // codigo do erro cliente xx:=e.message; // tag da descricao do erro xx:=e.faultdetail; // retirando as tags yy:= copy(xx,pos('>',xx)+1,length(xx)); xx:= copy(yy,1,pos('</d',yy)-1); showmessage('erro no metodo : '+ e.faultactor + ' - Codigo: '+ e.message + ' - ' + xx ); end; end; mostra.text:=retorno.html; end; end. 7. Contato Para questões técnicas, entre em contato com suporte@atk.com.br. Documentação do Webservice ATK 28