corviz/brasilapi-php

BrasilAPI 的 PHP SDK

维护者

详细信息

github.com/Corviz/brasilapi-php

源代码

问题

安装: 33

依赖项: 0

建议者: 0

安全: 0

星标: 9

关注者: 1

分支: 1

开放问题: 0

v1.1.1 2023-09-04 18:16 UTC

Requires

MIT 093132c8f7c2c93193aa6d1cc9ab99fad3862f2d

This package is auto-updated.

Last update: 2024-09-04 20:19:25 UTC

README

BrasilAPI 项目 PHP SDK (PHP 8.1+)

使用 composer 安装

composer require corviz/brasilapi-php

如何使用

  • 在此 SDK 中，每个 API 段（或子路径）都由一个类表示。例如
    • /banks/ -> BanksApi
    • /cep/ -> CepApi
    • /cnpj/ -> CnpjApi
    • 等等...
  • 每个 API 响应都存储在数据传输对象（BankData、CnpjData 等）中
  • 每个失败的请求都将抛出 GuzzleException
  • 所有索引的名称与在 官方 API 文档 中记录的相同。
  • 由两个或多个单词组成的索引格式为 lowerSnakeCase

环境变量

BRASILAPI_TIMEOUT - 请求最大时间（秒）

BRASILAPI_PROXY - Guzzle 的代理配置（ip）

使用示例

示例 1. 列出所有银行

use Corviz\BrasilAPI\BankApi;

$banks = BankApi::all();

foreach ($banks as $bank) {
    echo $bank->code, ' - ', $bank->name;
}

示例 2. 通过 CEP（邮编）显示地址数据

use Corviz\BrasilAPI\CepApi;

$address = CepApi::get('13087901');

echo $address->street; //Avenida Guilherme Campos
echo $address->neighborhood; //Jardim Santa Genebra
echo $address->city; //Campinas

//and so on...