cotapreco/postmon

It's just another client for Postmon API

1.1.0 2015-06-13 23:24 UTC

This package is not auto-updated.

Last update: 2024-11-09 16:48:09 UTC


README

use CotaPreco\Postmon\Cep;
use CotaPreco\Postmon\Postmon;

$postmon = new Postmon();

/* @var CotaPreco\Postmon\PartialAddress $address */
$address = $postmon->findAddressByCep(Cep::fromString('<cep>'));

Qualquer requisição na API sempre irá retornar um PartialAddress, independente de conter todos os campos para um endereço na resposta da API do Postmon.

  • PartialAddress é serializável para JSON implements JsonSerializable, então: json_encode($address) é absolutamente possível;
  • Campos com o valor null (campos que não estão presentes na resposta da API) são omitidos da serialização para JSON;
  • @throws CepNotFoundException para qualquer resposta da API que o código de status HTTP seja diferente de 200talvez você queira melhorar isso.

Sim, o composer!

$ composer require cotapreco/postmon dev-master

License

MIT © Cota Preço, 2015.