Download the PHP package ricardomartins/brazilzipcode without Composer
On this page you can find all versions of the php package ricardomartins/brazilzipcode. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ricardomartins/brazilzipcode
More information about ricardomartins/brazilzipcode
Files in ricardomartins/brazilzipcode
Package brazilzipcode
Short Description Magento 2 module to use brazil zipcode search services. Forked from magedev/brazilzipcode
License GPL-3.0-or-later
Homepage https://github.com/r-martins/BrazilZipCode
FAQ
Example:
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 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.
Informations about the package brazilzipcode
BrazilZipCode
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.
Módulo originalmente criado por m2-magedev/BrazilZipCode.
Como instalar
Instalar via Composer (recomendado)
Configurações
Para configurar o módulo acesse: Lojas > Configurações > MageDev > Brazil ZipCode
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:
Payload de retorno
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
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
- 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
- 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
Doe agora e ajude a manter o trabalho! ;)
Pode por PicPay através do usuário @walisson-ferreira ou via github para r-martins.
