README

关于模块

创建模块以使用CEP查询服务，已包含基本的ViaCep和Correios查询。

原始模块由 m2-magedev/BrazilZipCode 创建。

如何安装

通过Composer安装（推荐）

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

配置

要配置模块，请访问：商店 > 配置 > MageDev > Brazil ZipCode

如何使用查询

在您的javascript（无论是要查询CEP的任何商店区域）中，对以下端点进行GET调用，使用带或不含格式的CEP

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

返回的负载

{
    "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
}

注意事项

• 如果数据库持久性功能已激活，数据将被存储在数据库中，并在随后对同一CEP的查询中，数据将从数据库返回。
• 如果缓存功能已激活，CEP将被存储在缓存中，并在随后对同一CEP的查询中，数据将从缓存返回。

仅清理模块的缓存

php bin/magento cache:clean config_zipcode_search_api

通过外部服务使用CEP查询（其他平台、系统或Postman）

在Magento中创建一个集成密钥并使用Authorization头。

通过您的模块添加新服务

• 创建您的模块
• 创建您的服务类，继承自MageDev\BrazilZipCode\Gateway\AbstractZipCodeService
• 重写getAddressData和validate方法
• 在模块的etc目录中声明brazil_zipcode_services.xml，内容如下

<?xml version="1.0" ?>
<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="brazil_zipcode_services.xsd">
   <service id="ID_UNICO_PARA_SEU_SERVICO">
       <name>NOME_DO_SEU_SERVICO</name>
       <class>VENDOR_DO_MODULO\NOME_DO_MODULO\Services\NOME_DA_CLASSE_SO_SEU_SERVICO</class>
   </service>
</services>

• 安装模块并清理缓存。
• 注意：如果您希望优先使用服务，请访问管理员界面中的BrazilZipCode模块配置，并将服务作为列表中的第一个添加，这样当CEP未在缓存或数据库中找到时，您的服务将是第一个被访问的。

捐赠

现在捐赠，帮助维持这项工作！ ;)

可以通过PicPay通过用户@walisson-ferreira或通过GitHub为r-martins捐赠。