corviz/brasilapi-php

A PHP SDK for BrasilAPI

Maintainers

Details

github.com/Corviz/brasilapi-php

Source

Issues

Installs: 37

Dependents: 0

Suggesters: 0

Security: 0

Stars: 8

Watchers: 1

Forks: 1

Open Issues: 0

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

Requires

MIT 093132c8f7c2c93193aa6d1cc9ab99fad3862f2d

This package is auto-updated.

Last update: 2024-12-04 21:00:24 UTC

README

A PHP SDK for BrasilAPI project (PHP 8.1+)

Install with composer

composer require corviz/brasilapi-php

How to use

  • Every api segment (or sub-path) is represented by a class in this SDK. Eg:
    • /banks/ -> BanksApi
    • /cep/ -> CepApi
    • /cnpj/ -> CnpjApi
    • And so on...
  • Each api response is stored into a data transfer object (BankData, CnpjData, etc...)
  • Every unsuccessful request will throw an GuzzleException
  • All indexes have the same name as documented in the official api docs.
  • Indexes that are composed by two or more words, are formatted as lowerSnakeCase

Environment variables

BRASILAPI_TIMEOUT - maximum request time in seconds

BRASILAPI_PROXY - Proxy configuration for guzzle (ip)

Usage examples

Example 1. Listing all banks:

use Corviz\BrasilAPI\BankApi;

$banks = BankApi::all();

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

Example 2. Show address data by CEP (ZIP code)

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...