README

使用ViaCEP API REST (https://viacep.com.br) 通过CEP搜索地址。

安装

通过Composer

$ composer require kseven/phpviacep

用法

findByZipCode (无回调)

通过邮政编码找到地址。

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000')->toArray();

/*
Deve retornar algo assim:

[
    'zipCode' => '01001-000',
    'street' => 'Praça da Sé',
    'complement' => 'lado ímpar',
    'neighborhood' => 'Sé',
    'city' => 'São Paulo',
    'state' => 'SP',
    'ibge' => '3550308',
]
*/

$Address = $ViaCEP->findByZipCode('01001-000')->toJson();

/*
Deve retornar algo assim:

{
    "zipCode": "01001-000",
    "street": "Praça da Sé",
    "complement": "lado ímpar",
    "neighborhood": "Sé",
    "city": "São Paulo",
    "state": "SP",
    "ibge": "3550308"
}
*/

findByZipCode (带回调)

通过邮政编码找到地址，带有回调。

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Address = $ViaCEP->findByZipCode('01001-000', 'callback_name')->withCallback();

/*
Deve retornar algo assim:

callback_name({
    "cep": "01001-000",
    "logradouro": "Praça da Sé",
    "complemento": "lado ímpar",
    "bairro": "Sé",
    "localidade": "São Paulo",
    "uf": "SP",
    "ibge": "3550308",
    "gia": "1004",
    "ddd": "11",
    "siafi": "7107"
});
*/

findByStreetName

使用州、城市和街道名称搜索地址。

use KSeven\ViaCEP\VCRun AS ViaCEP;

$ViaCEP = new ViaCEP;

$Addresses = $ViaCEP->findByStreetName('SP', 'São Paulo', 'Gomes de Carvalho');

/*
Deve retornar algo assim:

[
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ],
    [
        'zipCode' => '01001-000',
        'street' => 'Praça da Sé',
        'complement' => 'lado ímpar',
        'neighborhood' => 'Sé',
        'city' => 'São Paulo',
        'state' => 'SP',
        'ibge' => '3550308',
    ]
]
*/

变更日志

查看 CHANGELOG 了解最近更改的信息。

贡献者

查看 CONTRIBUINDO 和 CONDUTA 获取详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件发送至 contato@kseven.dev.br，而不是使用问题跟踪器。

鸣谢

• K'Seven
• 所有贡献者

许可

MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。