README

BrasilAPI 的 PHP SDK。

需求

• PHP ^8.0

注意：此软件包需要 php:^8.0。对于 php:7.4，请查看版本 1.0。

注意：此软件包需要 php:^8.0。对于 php:7.4，请查看版本 1.0。

安装

您可以通过 composer 安装此软件包

composer require gutocf/brasil-api-php-sdk

用法

首先，您需要获取 BrasilAPI 类的一个实例

use Gutocf\BrasilAPI\BrasilAPI;

$BrasilAPI = new BrasilAPI();

之后，您可以使用以下方式使用服务方法。所有服务方法都返回来自 spatie/data-transfer-object 库的 DataTransferObject 对象或对象数组。

CEP (V1)

//Gets a bank by its code.
$cep = $BrasilAPI->cepV1()->get('88045540');

CEP (V2)

//Gets a bank by its code.
$cep = $BrasilAPI->cepV2()->get('88045540');

银行

//Gets all banks.
$banks = $BrasilAPI->banksV1()->getAll();

//Gets a bank by its code.
$bank = $BrasilAPI->banksV1()->get(1);

假日

//Gets holidays by year
$banks = $BrasilAPI->holidaysV1()->getByYear(2022);

CNPJ

//Gets information about a CNPJ
$banks = $BrasilAPI->cnpjV1()->get('39729684000100');

DDD

//Gets information about a DDD
$ddd = $BrasilAPI->dddV1()->get(48);

FIPE

参考表

use Gutocf\BrasilAPI\Entity\V1\Fipe\Enum\VehicleType;

//Gets all reference tables
$referenceTables = $BrasilAPI->fipeV1()->getAllReferenceTables();

车辆

//Gets vehicle price information by FIPE code
$vehicles = $BrasilAPI->fipeV1()->getAllVehicleByCode('003281-6');
//Gets vehicle price information by FIPE code for a specific table
$vehicles = $BrasilAPI->fipeV1()->getAllVehicleByCode('003281-6', 123);

品牌

use Gutocf\BrasilAPI\Entity\V1\Fipe\Enum\VehicleType;

//Gets all brands
$brands = $BrasilAPI->fipeV1()->getAllBrandsByType();
//Gets all brands by vehicle type
$brands = $BrasilAPI->fipeV1()->getAllBrandsByType(VehicleType::CARS());
//Gets all brands by vehicle type for a specific table
$brands = $BrasilAPI->fipeV1()->getAllBrandsByType(VehicleType::CARS(), 123);

IBGE

各州城市

$cities = $BrasilAPI->ibgeV1()->getCitiesByState('SC');

各州

$states = $BrasilAPI->ibgeV1()->getAllStates();

按首字母或代码查找州

$state = $BrasilAPI->ibgeV1()->getState('sc');
//OR
$state = $BrasilAPI->ibgeV1()->getState(42);

错误处理

与 Brasil API 通信时发生的 HTTP 错误将抛出以下异常