PHPackages                             bipbop/api - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. bipbop/api

ActiveLibrary[API Development](/categories/api)

bipbop/api
==========

Library for communicating with BIPBOP

3.1.0(4y ago)617.8k↓33.3%3GPL-2.0-onlyPHPPHP >=7.3

Since Aug 12Pushed 4y ago6 watchersCompare

[ Source](https://github.com/bipbop/bipbop-php)[ Packagist](https://packagist.org/packages/bipbop/api)[ RSS](/packages/bipbop-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

Bipbop PHP
==========

[](#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.

Buscando o nome através do CPF/CNPJ
===================================

[](#buscando-o-nome-através-do-cpfcnpj)

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:

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

Como utilizar
=============

[](#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.

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:

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

```
$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:

```
$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**.

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

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

Esse método retorna um [DOMDocument](http://php.net/manual/en/class.domdocument.php) que pode ser manipulado utilizando a [DOMXPath](http://php.net/manual/en/class.domxpath.php) ambas as classes nativas do PHP.

```
// 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
================

[](#mais-informações)

Para mais informações e aquisição de uma chave de api acesse .

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity30

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~107 days

Total

3

Last Release

1525d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/1204f9fde08431526f84a04cb3e94c435b59e53c5b167958a4026ce0fd096581?d=identicon)[lfamorim](/maintainers/lfamorim)

---

Top Contributors

[![jpaulobneto](https://avatars.githubusercontent.com/u/1436946?v=4)](https://github.com/jpaulobneto "jpaulobneto (5 commits)")[![lfamorim](https://avatars.githubusercontent.com/u/195014?v=4)](https://github.com/lfamorim "lfamorim (5 commits)")[![felipensp](https://avatars.githubusercontent.com/u/773947?v=4)](https://github.com/felipensp "felipensp (1 commits)")[![helsinque](https://avatars.githubusercontent.com/u/7644786?v=4)](https://github.com/helsinque "helsinque (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/bipbop-api/health.svg)

```
[![Health](https://phpackages.com/badges/bipbop-api/health.svg)](https://phpackages.com/packages/bipbop-api)
```

###  Alternatives

[algolia/algoliasearch-client-php

API powering the features of Algolia.

69433.0M114](/packages/algolia-algoliasearch-client-php)[swisnl/json-api-client

A PHP package for mapping remote JSON:API resources to Eloquent like models and collections.

211473.2k12](/packages/swisnl-json-api-client)[php-heroku-client/php-heroku-client

A PHP client for the Heroku Platform API

24404.8k4](/packages/php-heroku-client-php-heroku-client)[yoti/yoti-php-sdk

Yoti SDK for quickly integrating your PHP backend with Yoti

27539.9k1](/packages/yoti-yoti-php-sdk)[trycourier/courier

Courier PHP SDK

16643.9k](/packages/trycourier-courier)[commercetools/commercetools-sdk

The official PHP SDK for the commercetools Composable Commerce APIs

19281.5k](/packages/commercetools-commercetools-sdk)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)