andrebian/correios-php

Uma maneira fácil de interagir com as principais funcionalidades dos Correios.

dev-master / 2.0.x-dev 2023-05-12 21:54 UTC

This package is auto-updated.

Last update: 2024-10-13 01:01:39 UTC


README

Latest Version on Packagist CircleCI Codecov Software License Total Downloads

Uma maneira fácil de interagir com as principais funcionalidades dos Correios.

Funcionalidades

Instalação

Via Composer

$ composer require flyingluscas/correios-php

Uso

Consultar CEP

Encontrar endereço pelo CEP consultando diretamente o WebService dos Correios.

use FlyingLuscas\Correios\Client;

require 'vendor/autoload.php';

$correios = new Client;

$correios->zipcode()
    ->find('01001-000');

/*

Resultado:

[
    'zipcode' => '01001-000',
    'street' => 'Praça da Sé',
    'complement' => [
        'lado ímpar',
    ],
    'district' => 'Sé',
    'city' => 'São Paulo',
    'uf' => 'SP',
]
*/

Calcular Preços e Prazos

Calcular preços e prazos de serviços de entrega (Sedex, PAC e etc), com suporte a multiplos objetos na mesma consulta.

use FlyingLuscas\Correios\Client;
use FlyingLuscas\Correios\Service;

require 'vendor/autoload.php';

$correios = new Client;

$correios->freight()
    ->origin('01001-000')
    ->destination('87047-230')
    ->services(Service::SEDEX, Service::PAC)
    ->item(16, 16, 16, .3, 1) // largura, altura, comprimento, peso e quantidade
    ->item(16, 16, 16, .3, 3) // largura, altura, comprimento, peso e quantidade
    ->item(16, 16, 16, .3, 2) // largura, altura, comprimento, peso e quantidade
    ->calculate();

/*

Resultados:

[
    [
        'name' => 'Sedex',
        'code' => 40010,
        'price' => 51,
        'deadline' => 4,
        'error' => [],
    ],
    [
        'name' => 'PAC',
        'code' => 41106,
        'price' => 22.5,
        'deadline' => 9,
        'error' => [],
    ],
]
*/

Change log

Consulte CHANGELOG para obter mais informações sobre o que mudou recentemente.

Testando

$ composer test

Contribuindo

Consulte CONTRIBUTING para obter mais detalhes.

Segurança

Se você descobrir quaisquer problemas relacionados à segurança, envie um e-mail para lucas.pires.mattos@gmail.com em vez de usar as issues.

Créditos

Licença

A Licença MIT (MIT). Consulte o arquivo de licença para obter mais informações.