chico-rei/correios-php

correios-php

0.1.2 2025-10-02 12:31 UTC

Requires

• php: >=7.4
• ext-json: *
• cache/array-adapter: ^1.2
• guzzlehttp/guzzle: ^6.0||^7.0
• nesbot/carbon: ^1.16||^2.0

Requires (Dev)

• php-coveralls/php-coveralls: ^2.2
• phpunit/phpunit: ^9.0
• squizlabs/php_codesniffer: 3.*

MIT

• Chico Rei

• correios api
• Correios Web Service

README

This is a PHP client wrapper for Correios Web Service.

Install

Via Composer

$ composer require chico-rei/correios-php "dev-master"

Requires PHP 7.4 or newer.

Features

• Token
  • POST /v1/autentica getClient()->getToken()
  • POST /v1/autentica/contrato getClient()->getToken()
  • POST /v1/autentica/cartaopostagem getClient()->getToken()
• CEP
  • GET /v2/enderecos/{cep} cepHandler()->get()
  • ...
• Pré-Postagem
  • GET /v2/prepostagens prePostagemHandler()->query()
  • POST /v1/prepostagens prePostagemHandler()->create()
  • DELETE /v1/prepostagens/objeto/{codigoObjeto} prePostagemHandler()->deleteByCode()
  • ...
• ...

Usage

use \ChicoRei\Packages\Correios\Correios;
use \ChicoRei\Packages\Correios\Account;

try {
    $correios = new Correios(
        Account::create([
            'username' => '',
            'password' => '',
            'contract' => '',
            'postcard' => '',
        ])
    );

    $response = $correios->cepHandler()->get('36033-007');
    
    echo $response->getLogradouro() . PHP_EOL;
    echo $response->getUf() . PHP_EOL;
} catch (Exception $e) {
    echo 'Code: ' . $e->getCode() . PHP_EOL;
    echo 'Message: ' . $e->getMessage() . PHP_EOL;
}

See examples for more.

Testing

$ composer test

License

The MIT License (MIT). Please see License File for more information.