Download the PHP package andreoneres/brasilapi-php without Composer

On this page you can find all versions of the php package andreoneres/brasilapi-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of andreoneres/brasilapi-php

Informations about the package brasilapi-php

Logo da BrasilAPI

Vamos transformar o Brasil em uma API?

Introdução

Esse SDK foi construído com o intuito de ser flexível, de forma que todos possam utilizar todas as features e versões da BrasilAPI.

Você pode acessar a documentação oficial da BrasilAPI acessando esse link.

Índice

Requisitos

Instalação

Para instalar o SDK, você deve utilizar o Composer com o seguinte comando:

Utilização

O uso mais simples da biblioteca seria o seguinte:

Endpoints

Abaixo você pode ver todos os endpoints disponíveis, por padrão, na biblioteca:

Bancos

Buscando todos os bancos disponíveis na API.

Buscando um banco específico pelo seu código.

CEP

Buscando um CEP específico.

CEP V2

Buscando um CEP específico.

CNPJ

Buscando um CNPJ específico.

Corretoras

Buscando uma corretora específica pelo CNPJ.

Buscando todas as corretoras listadas pela CVM.

CPTEC

Buscando uma cidade pelo nome.

Buscando todas as cidades disponíveis.

Buscando as informações meteorológicas em todas as capitais dos estados brasileiros.

Buscando as informações meteorológicas em um aeroporto específico através do seu código ICAO.

Buscando as informações meteorológicas de uma cidade específica pelo seu código.

Buscando as informações meteorológicas de uma cidade específica no período de X dias.

Obs.: O primeiro parâmetro se refere ao código da cidade e o segundo parâmetro refere-se a quantidade de dias. Lembrando que só é possível buscar informações entre 1 a 6 dias.

Buscando a previsão oceânica em uma cidade específica.

Buscando a previsão oceânica em uma cidade específica no período de X dias.

Obs.: O primeiro parâmetro se refere ao código da cidade e o segundo parâmetro refere-se a quantidade de dias. Lembrando que só é possível buscar informações entre 1 a 6 dias.

DDD

Buscando o estado e cidades que possuem determinado DDD.

Feriados

Buscando todos os feriados nacionais em determinado ano.

FIPE

Buscando todas as marcas de veículos referente a um tipo de veículo.

Buscando o preço de um veículo específico pelo seu código FIPE.

Buscando as tabelas de referência existentes.

IBGE

Buscando todos os municípios de um estado específico pela sua sigla.

Buscando informações de todos os estados brasileiros.

Buscando informações de um estado específico pela sua sigla.

ISBN

Buscando informações sobre um livro específico pelo seu código ISBN.

NCM

Buscando informações sobre todos os NCMs.

Buscando informações sobre um NCM específico.

Buscando informações de um NCM a partir de um código ou descrição.

Pix

Buscando informações de todos os participantes do PIX no dia atual ou anterior.

Registro BR

Buscando informações de um domínio específico.

Taxas

Buscando as taxas de juros e alguns índices oficiais do Brasil.

Buscando informações de uma taxa a partir do seu nome/sigla.

Criando endpoints

Para adicionar novos ou sobreescrever os já existentes endpoints, você deve seguir os seguintes passos:

  1. Crie uma classe que extenda a classe BrasilApi\Endpoints\Abstracts\Endpoint;

  2. Nesta classe, você pode implementar todos os métodos que desejar e utilizar o método $this->client->request() para enviar as requisições para a API. Lembre-se que a base URL da API já está embutido no 'Client', portanto na uri do método você precisa adicionar apenas o complemento da rota.

Exemplo:

URL: https://brasilapi.com.br/api/cep/v2/01001000
BASE_URI: https://brasilapi.com.br/api
URI: /cep/v2/01001000

  1. Para incorporá-lo ao SDK, você deve possuir uma instância de BrasilApi\Client e utilizar o método addEndpoint, passando como parâmetro o nome do endpoint e a classe criada no passo 1.

Exemplo:

  1. Para utilizar este novo endpoint, você deve chamá-lo da seguinte forma:

Obs.: A chamada do método do endpoint deve ser feito com o mesmo nome que foi definido no método addEndpoint, pois ele será utilizado na busca dinâmica do endpoint através do método mágico __call.

Obs.2: Além de criar, você pode sobrescrever endpoints existentes e atualizar os seus métodos. Isso pode ser útil caso seja lançada uma nova versão de algum endpoint e você queira utilizá-lo imediatamente. Dessa forma, você pode sobrescrever o endpoint existente e alterar a sua URI.

Tratando exceções

Caso a API retorne um erro, a biblioteca irá lançar uma exceção do tipo BrasilApi\Exceptions\BrasilApiException. Para capturar esta exceção, você deve utilizar o bloco try/catch e tratar o erro da forma que desejar.

Exemplo:

Testes

Neste projeto é utilizado o Pest para a implementação de testes automatizados. Para executá-los, instale as dependências de desenvolvimento, caso não tenha instalado, e execute o seguinte comando:

Contribuindo

Para contribuir com o projeto, você deve seguir os seguintes passos:

  1. Faça um fork do projeto;
  2. Crie uma branch para sua alteração: git checkout -b feat-fix-refactor/my-changes;
  3. Faça commit das suas alterações: git commit -m 'feat-fix-refactor: My changes';
  4. Faça push para a sua branch: git push origin feat-fix-refactor/my-changes;
  5. Abra um pull request.
  6. Aguarde a análise do seu pull request.
  7. Se seu pull request for aceito, ele será mesclado com a branch main.

Obs.: Não se esqueça de criar testes para o seu código.

Licença

Veja em LICENSE.md.

All versions of brasilapi-php with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
guzzlehttp/guzzle Version ^7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package andreoneres/brasilapi-php contains the following files

Loading the files please wait ....