bipbop

Documentação BIPBOP JS

Introdução

Esta é uma documentação prática que visa orientar a como usar todas as informações que a BIPBOP API possibilita. É um manual para programadores e clientes que desejam tornar a experiência de seus usuários melhor através das informações objetivas que oferecemos, recomendamos que também leia nosso eBook, Guia de Personalização - BIPBOP. Aqui você vai encontrar informações acerca de nossos documentos XML, formatos de consulta e principais implementações.

A BIPBOP API é a maneira mais fácil de você se conectar, toda a implementação que será aqui descrita terá como foco interfaces HTML5, JavaScript e retrocompatibilidade. Não se assuste, este documento pode ser lido por desde um programador sênior até um entusiasta da área, temos como objetivo uma informação acessível e igualmente rica a todos os públicos. Estamos também a disposição para sanar quaisquer dúvidas e o convidámos a lêr nosso blog, que certamente pode auxiliar você a explorar melhor as possibilidades que a informação oferece.

Índice

Sobre a BIPBOP

A BipBop é uma empresa que, desde a sua origem, se declarou uma forte inimiga da Internet obsoleta e acomodada. Para nós, o mais importante é utilizar toda a Tecnologia da Informação disponível para que o seu negócio possa se destacar com propriedade dentre os demais. Como lema, levantamos o estandarte de uma rede de informações acessíveis, onde dados circulem sem barreiras e dificuldades.

E sim, queremos evitar que o comodismo chegue até você, inovando, cada vez mais, com nossas soluções de Web Crawling e inteligência de negócio para que você possa usufruir da melhor forma do Big Data (direcionando milhares de informações a seu favor e encaminhando sua empresa rumo à evolução). Desta forma, nosso principal interesse é garantir que o nosso objetivo, assim como o seu, seja alcançado.

Exemplos de Uso

A maneira mais prática para implementar o BIPBOP é sem dúvida através de nossos exemplos em JavaScript, utilizamos para isso uma biblioteca que realiza automáticamente as requisições AJAX em nossos servidores que pode ser encontrada no endereço abaixo, é altamente recomendado seu uso principalmente nos planos gratuitos, onde a chave de acesso para essa modalidade é oferecida apenas através. Outra vantagem de nossa biblioteca é a facilidade na interpretação do XML de retorno.

<script src="//code.jquery.com/jquery-1.10.2.min.js"></script>
<script src="//irql.bipbop.com.br/js/jquery.bipbop.min.js"></script>

Os exemplos da BIPBOP seguem todos com sintaxe de consulta, XML e snippet no JSFiddle de exemplo, porém para as consultas pagas é necessário trocar a chave de acesso. No exemplo abaixo é possível verificar uma boa implementação e nossa biblioteca documentada.

Consulta a CEP

A consulta de CEP permite ganho de agilidade no preenchimento de formulários que possuam endereço, com o CEP a maioria das informações podem ser preenchidas automáticamente. Essa consulta é gratuita, até 20 consultas por endereço de IP, nos planos comerciais podemos também descobrir dados faltantes no CEP através de informações complementares, como CPF, endereço de IP e pontos de redes Wi-Fi, para saber mais consulte-nos.

O exemplo acima retorna informações gerais acerca de um determinado CEP no plano gratuito, recomendamos que ao se implementar esse código se leve em consideração as exceções que podem ser retornadas.

Exemplo de XML

Este é um exemplo de consulta a CEP através da BIPBOP em XML, onde pode se observar os retornos para consumo, é importante salientar que nossos exemplos não mudam, novas versões de documento são adicionadas através de novas fontes.

Consulta CPF/CNPJ

A consulta de CPF/CNPJ permite um ganho ainda maior de performance para preenchimento de formulários, sendo assim maior conversão, essa consulta é gratuita e limitada a 20 requisições dia por endereço de IP. Nos planos gratuitos apenas os nomes de empresa e pessoa física são retornados, nos planos comerciais é possível retornar a última situação verificada no Fisco e no caso das empresas, endereço e telefones públicos para contato.

O exemplo acima retorna informações gerais acerca de um determinado CPF ou CNPJ no plano gratuito, recomendamos que ao se implementar esse código se leve em consideração as exceções que podem ser retornadas.

Exemplo de XML

Este é um exemplo de consulta a CPF ou CNPJ através da BIPBOP em XML, onde pode se observar os retornos para consumo, é importante salientar que nossos exemplos não mudam, novas versões de documento são adicionadas através de novas fontes.

Influência Social

A BIPBOP é capaz de mensurar a influência social de uma pessoa na internet se valendo de informações de redes sociais, essa informação é de interesse para empresas que queiram descobrir quais clientes seriam os melhores embaixadores de seus produtos, melhorar a experiência social em interfaces para pessoas nativas desse meio, entre outras possibilidades. Essa consulta é exclusiva para os planos comerciais da BIPBOP.

O exemplo acima retorna informações gerais acerca de uma determinada pessoa no plano comercial, recomendamos que ao se implementar esse código se leve em consideração as exceções que podem ser retornadas.

Exemplo de XML

Este é um exemplo de consulta a pessoa em perfis sociais através da BIPBOP em XML, onde pode se observar os retornos para consumo, é importante salientar que nossos exemplos não mudam, novas versões de documento são adicionadas através de novas fontes.

Geolocalização

Determinar onde um cliente está é crucial para quem deseja vender melhor, a BIPBOP oferece uma tecnologia que permite que você altere sua vitrine de forma a oferecer o produto mais próximo do cliente. Além disso a localização pode ser um importante recurso anti-fraude, uma vez que as informações sobre localização agora podem ser verificadas.

O exemplo acima retorna informações gerais acerca de uma determinada localização no plano comercial, recomendamos que ao se implementar esse código se leve em consideração as exceções que podem ser retornadas.

Exemplo de XML

Este é um exemplo de consulta a localização através da BIPBOP em XML, onde pode se observar os retornos para consumo, é importante salientar que nossos exemplos não mudam, novas versões de documento são adicionadas através de novas fontes.

Poder Aquisitivo

Através de algoritmos sofisticados de presença na internet, localização e outras informações, a BIPBOP oferece nos planos comerciais um valor aproximado sobre o poder aquisitivo de um determinado internauta, justamente para que você possa oferecer produtos mais adequados ao cliente que acessa a plataforma ou ter um conhecimento maior a respeito de quem já comprou.

O exemplo acima retorna informações gerais acerca de um determinado documento no plano comercial, recomendamos que ao se implementar esse código se leve em consideração as exceções que podem ser retornadas.

Exemplo de XML

Este é um exemplo de consulta ao poder aquisitivo através da BIPBOP em XML, onde pode se observar os retornos para consumo, é importante salientar que nossos exemplos não mudam, novas versões de documento são adicionadas através de novas fontes.

Documento IRQL

O documento IRQL é o retorno da BIPBOP, é um XML válido que possui cabeçalho (header) e corpo (body), que visa universalizar os retornos possíveis da maneira menos complexa possível, se valendo de uma linguagem clara e altamente objetiva para que você possa rapidamente consumir qualquer gênero de informação. No cabeçalho são inseridas as informações no que diz respeito a performance e detalhes a respeito da consulta em si, quanto no corpo são retornadas as informações da consulta.

Os retornos da BIPBOP não são mutáveis, mudanças são realizadas apenas em novas fontes ou parâmetrizadas a pedido do cliente, na consulta acima podemos identificar com clareza o tempo de execução, a data em que a consulta foi realizada, a consulta que foi solicitada, o logradouro, o bairro, o cep, a cidade e o estado.

Exceções

O modelo do IRQL de exceções é pautado na exibição em interface e erros internos, exceções ExceptionDatabase por natureza devem ser exibidas ao usuário, quanto exceções de outras categorias devem ser guardadas e verificadas junto ao suporte técnico.

Sintaxe de Consulta IRQL

A consulta IRQL é inspirada no SQL (Structured Query Language, ou Linguagem de Consulta Estruturada), utilizamos dessa maneira para que no futuro possamos aumentar a gama de possibilidades oferecidas aos nossos clientes e também para tornar mais humana e compreensível as informações que são acessadas.

No IRQL todos os valores, nome do database, da tabela e argumentos devem ser escapados por aspas simples, conforme modelo abaixo.

SELECT FROM '[DATABASE]'.'[TABELA]' (WHERE '[ARGUMENTO]' = '[VALOR]' (AND '[ARGUMENTO2]' = '[VALOR2]'))

É muito importante salientar que os argumentos não precisam necessáriamente serem enviados através da sintaxe IRQL, que não suporta valores escapados, para isso recomendamos que os parâmetros sejam encaminhados via HTTP (GET ou POST).

Melhores Práticas no Uso da API

Para bem utilizar o BIPBOP deve se ter em mente as seguintes virtudes e regras.

Contato e Suporte Técnico

Nosso suporte técnico cumpre um SLA de 3 horas para qualquer chamado no e-mail [email protected], você deve nos informar contudo se é um usuário gratuito, ou não, qual a modalidade de seu contrato, detalhar o máximo o máximo possível o problema, o que inclue exceções exibidas, cabeçalhos HTTP e dados da sua empresa.