PHPackages                             magedev/brazilzipcode - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. magedev/brazilzipcode

ActiveMagento2-module[Utility & Helpers](/categories/utility)

magedev/brazilzipcode
=====================

Magento 2 module to use brazil zipcode search services.

1.1.5(5y ago)1119.1k↓50%9[2 PRs](https://github.com/m2-magedev/BrazilZipCode/pulls)1GPL-3.0-or-laterPHP

Since Nov 18Pushed 3y ago3 watchersCompare

[ Source](https://github.com/m2-magedev/BrazilZipCode)[ Packagist](https://packagist.org/packages/magedev/brazilzipcode)[ Docs](https://github.com/m2-magedev/BrazilZipCode)[ RSS](/packages/magedev-brazilzipcode/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)DependenciesVersions (2)Used By (1)

BrazilZipCode
=============

[](#brazilzipcode)

Sobre o Módulo
--------------

[](#sobre-o-módulo)

Módulo criado para utilização de serviços de consulta de CEP, já contendo de forma básica consulta pelo ViaCep e Correios.

### Como instalar

[](#como-instalar)

#### Instalar via Composer (recomendado)

[](#instalar-via-composer-recomendado)

```
composer require magedev/brazilzipcode
php bin/magento module:enable MageDev_BrazilZipCode
php bin/magento setup:upgrade

```

### Configurações

[](#configurações)

Para configurar o módulo acesse: Lojas > Configurações > MageDev > Brazil ZipCode

### Como usar a consulta

[](#como-usar-a-consulta)

Em seu javascript (seja para qualquer área da loja que deseja consultar um CEP), faça uma chamada GET para o endpoint abaixo utilizando o cep com ou sem formatação:

```
URL_DA_LOJA/rest/V1/magedev-brazil-zipcode/search/CEP_A_SER_CONSULTADO
https://minhaloja.com.br/rest/V1/magedev-brazil-zipcode/search/08226-021
https://minhaloja.com.br/rest/V1/magedev-brazil-zipcode/search/08226021

```

### Payload de retorno

[](#payload-de-retorno)

```
{
    "zip_code": "08226021",
    "street": "Rua 18 de Abril",
    "neighborhood": "Cidade Antônio Estevão de Carvalho",
    "additional_info": "",
    "city": "São Paulo",
    "state": "SP",
    "code": "3550308",
    "data_source": "ViaCep",
    "is_valid": true
}

```

#### Observações:

[](#observações)

- Caso a funcionalidade de persistência no banco de dados esteja ativa, os dados serão armazenados no banco de dados e, em uma consulta posterior ao mesmo CEP, o dado será retornado do banco.
- Caso a funcionalidade de cache esteja ativa, o CEP sejá armazenado no cache, e em uma posterior consulta ao mesmo CEP, o dado será retornado do cache.

### Limpando o cache apenas do módulo

[](#limpando-o-cache-apenas-do-módulo)

```
php bin/magento cache:clean config_zipcode_search_api

```

### Uso da consulta de CEP por serviços externos (Outras plataformas, sistemas ou postman)

[](#uso-da-consulta-de-cep-por-serviços-externos-outras-plataformas-sistemas-ou-postman)

Criar uma chave de integração no Magento e fazer uso do header de Authorization.

Adicionando novos serviços através do seu módulo
------------------------------------------------

[](#adicionando-novos-serviços-através-do-seu-módulo)

- Crie seu módulo
- Crie sua classe de serviço estendendo da classe MageDev\\BrazilZipCode\\Gateway\\AbstractZipCodeService
- Sobrescreva os métodos getAddressData e validate
- Declare o xml brazil\_zipcode\_services.xml no etc de seu módulo com o seguinte conteúdo

```

       NOME_DO_SEU_SERVICO
       VENDOR_DO_MODULO\NOME_DO_MODULO\Services\NOME_DA_CLASSE_SO_SEU_SERVICO

```

- Instale seu módulo e limpe o cache.
- Obs: Caso deseje priorizar seu serviço, acesse as configurações do módulo BrazilZipCode no admin e adicione seu serviço como o primeiro da lista, assim seu serviço será o primeiro a ser acessado quando o CEP não for localizado no cache ou banco de dados.

Doações
-------

[](#doações)

Doe agora e ajude a manter o trabalho! ;)

No momento estou recebendo doações apenas via PicPay através do usuário @walisson-ferreira

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 83.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

2007d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/68076636?v=4)[m2-magedev](/maintainers/m2-magedev)[@m2-magedev](https://github.com/m2-magedev)

---

Top Contributors

[![m2-magedev](https://avatars.githubusercontent.com/u/68076636?v=4)](https://github.com/m2-magedev "m2-magedev (15 commits)")[![feeh27](https://avatars.githubusercontent.com/u/13547485?v=4)](https://github.com/feeh27 "feeh27 (1 commits)")[![r-martins](https://avatars.githubusercontent.com/u/191149?v=4)](https://github.com/r-martins "r-martins (1 commits)")[![robsoned](https://avatars.githubusercontent.com/u/18008565?v=4)](https://github.com/robsoned "robsoned (1 commits)")

---

Tags

zipcodemagento 2brazil zipcodecep brasilmagento2 cepmagento 2 cep

### Embed Badge

![Health badge](/badges/magedev-brazilzipcode/health.svg)

```
[![Health](https://phpackages.com/badges/magedev-brazilzipcode/health.svg)](https://phpackages.com/packages/magedev-brazilzipcode)
```

###  Alternatives

[magepal/magento2-googletagmanager

Google Tag Manager (GTM) for Magento 2 with Advance Data Layer

2671.5M4](/packages/magepal-magento2-googletagmanager)[yireo/magento2-webp2

Magento 2 module to add WebP support to the Magento frontend

2091.2M7](/packages/yireo-magento2-webp2)[mageplaza/magento-2-blog-extension

Magento 2 Blog extension

123708.2k5](/packages/mageplaza-magento-2-blog-extension)[mageplaza/magento-2-seo-extension

Magento 2 SEO extension

138506.6k2](/packages/mageplaza-magento-2-seo-extension)[magepal/magento2-reindex

Reindex your Magento2 store quickly and easily from backend/admin, instead of command line.

112649.7k1](/packages/magepal-magento2-reindex)[tig/postnl-magento2

TIG Magento 2 PostNL extension

58544.2k4](/packages/tig-postnl-magento2)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)