bipbop / api
BIPBOP通信库
3.1.0
2022-03-15 16:27 UTC
Requires
- php: >=7.3
- ext-curl: *
- ext-dom: *
- psr/http-message: ^1.0
Requires (Dev)
- mockery/mockery: ^1.4
- phpunit/phpunit: ^9.5
This package is auto-updated.
Last update: 2024-09-15 22:54:25 UTC
README
PHP库,用于与Bipbop API交互。使用它,您可以查询注册数据、消费者档案、邮局、车牌等数据库。您只需联系Bipbop获取有效的API密钥即可。
通过CPF/CNPJ搜索姓名
存在一个名为NameByCPFCNPJ
的特殊类,其静态方法evaluate可用于通过CPF/CNPJ查询姓名,传递CPF/CNPJ作为字符串,并可选地传递出生日期作为DATETIME或整数
printf(\BIPBOP\Client\NameByCPFCNPJ::evaluate($cpf, $nasc));
如何使用
有了有效的API密钥,您可以与您的密钥可以访问的银行进行交互。在这个存储库中,您将找到包含以下代码的example.php
文件。
第一步是了解有哪些银行。为此,我们有ServiceDiscovery
类,它使用从您的密钥创建的WebService
实例。
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")); }
让我们以数据库PLACA
为例,找出我们可以查询哪些表以及哪些字段。
$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")); }
我们的列表返回了表CONSULTA
,但我们能使用哪些字段作为查询参数呢?让我们来看看。
$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()); }
我们的搜索返回了字段placa
。
有了这些信息,构建查询变得简单。只需使用以下方式使用WebService
的post方法:
$dom = $webService->post("SELECT FROM 'PLACA'.'CONSULTA'", [ "placa" => "XXX9999" ]);
该方法返回一个DOMDocument,它可以使用DOMXPath进行操作,这两个类都是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/.)"));
更多信息
有关更多信息以及获取API密钥,请访问http://api.bipbop.com.br。