2017 © Pedro Peláez
 

library api

Library for communicating with BIPBOP

image

bipbop/api

Library for communicating with BIPBOP

  • Friday, July 27, 2018
  • by lfamorim
  • Repository
  • 6 Watchers
  • 5 Stars
  • 4,751 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 3 Forks
  • 0 Open issues
  • 14 Versions
  • 0 % Grown

The README.md

Bipbop PHP

Biblioteca em PHP para interação com a Bipbop API. Com ela você pode fazer consulta de dados cadastrais, consulta do Perfil Consumidor para SAC, Correios, placas de veículos entre outras bases. Tudo que você precisa é adquirir uma chave de API válida entrando em contato com a Bipbop., (*1)

Buscando o nome através do CPF/CNPJ

Existe uma classe especial chamada NameByCPFCNPJ cujo método estático evaluate pode ser usado para consultar o nome através do CPF/CNPJ, passando-se o CPF/CNPJ como string e opcionalmente a data de nascimento como DATETIME ou Inteiro:, (*2)

printf(\BIPBOP\Client\NameByCPFCNPJ::evaluate($cpf, $nasc));

Como utilizar

Com uma chave de API válida em mãos você pode interagir com bancos os quais sua chave tem acesso. Nesse repositório você encontrará o arquivo example.php com o codigo a abaixo., (*3)

O primeiro passo é saber quais são esses bancos. Para isso temos a classe ServiceDiscovery que usa uma instância de WebService, criada a partir de sua chave:, (*4)

require "vendor/autoload.php";

$webService = new \BIPBOP\Client\WebService(/* Coloque sua chave de API aqui */);
$serviceDiscovery = \BIPBOP\Client\ServiceDiscovery::factory($webService);

printf("\n\n== Listando todos os databases ==\n\n");
foreach ($serviceDiscovery->listDatabases() as $databaseInformation) {
    /* @var $database \BIPBOP\Client\Database */
    $database = $serviceDiscovery->getDatabase($databaseInformation["name"]);
    printf("Available Database: %s\nDescription: %s\nURL: %s\n\n", $database->name(), $database->get("description"), $database->get("url"));
}

Vamos tomar como exemplo o database PLACA e descobrir quais tabelas podemos consultar e com quais campos:, (*5)

$databasePlaca = $serviceDiscovery->getDatabase("PLACA");
printf("\n== Listando tabelas de PLACA ==\n\n");
foreach ($databasePlaca->listTables() as $tableInformation) {
    /* @var $database \BIPBOP\Client\Database */
    $table = $databasePlaca->getTable($tableInformation["name"]);
    printf("Available Table: %s\nDescription: %s\nURL: %s\n\n", $table->name(), $table->get("description"), $table->get("url"));
}

Nossa listagem retornou a tabela CONSULTA mas quais serão os campos que podemos usar como parâmetros em nossa consulta? Vamos descobrir:, (*6)

$tableConsulta = $databasePlaca->getTable("CONSULTA");
printf("\n== Listando campos de CONSULTA ==\n\n");
foreach ($tableConsulta->getFields() as $field) {
    printf("Available Field: %s\n\n", $field->name());
}

Nossa busca retornou o campo placa., (*7)

Com esses dados em mãos torna-se simples montar nossa consulta. Basta utilizarmos o método post de WebService da seguinte forma:, (*8)

$dom = $webService->post("SELECT FROM 'PLACA'.'CONSULTA'", [
    "placa" => "XXX9999"
]);

Esse método retorna um DOMDocument que pode ser manipulado utilizando a DOMXPath ambas as classes nativas do PHP., (*9)

// Visualizando as tags do documento retornado
printf($dom->saveXML());

// Recuperando a marca do veículo
$xpath = new \DOMXpath($dom);
printf($xpath->evaluate("string(/BPQL/body/marca/.)"));

Mais informações

Para mais informações e aquisição de uma chave de api acesse http://api.bipbop.com.br., (*10)

The Versions

27/07 2018

dev-master

9999999-dev

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

27/07 2018

2.1.2

2.1.2.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

07/12 2017

2.1.1

2.1.1.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

02/05 2017

2.1.0

2.1.0.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

14/08 2016

2.0.1

2.0.1.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

31/07 2016

2.0.0

2.0.0.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

30/07 2016

1.0.2

1.0.2.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

15/07 2016

1.0.1

1.0.1.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

15/07 2016

dev-feature/cpfcnpj

dev-feature/cpfcnpj

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

11/07 2016

1.0.0

1.0.0.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

The Requires

 

by Desenvolvimento

23/05 2016

0.0.10

0.0.10.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

by Desenvolvimento

05/02 2016

0.0.9

0.0.9.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

by Desenvolvimento

11/10 2015

0.0.2

0.0.2.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

by Desenvolvimento

06/10 2015

0.0.1

0.0.1.0

Library for communicating with BIPBOP

  Sources   Download

GPL-2.0

by Desenvolvimento