README

PostalCodeMex 客户端 是一个用于 Laravel 的库，允许您消费 PostalCodeMex API。该 API 提供有关邮政编码、街区、州和其他信息的详细信息。

安装

要求

Laravel 9.x, 10.x 或更高版本
PHP 8.1 或更高版本

1. 安装包

您可以通过 Composer 安装此包。在您的 Laravel 项目中执行以下命令

composer require systemedom/postalcodemex-client

2. 配置

安装后，包将自动在 Laravel 中注册（得益于 Laravel 11+ 对包自动发现的支持）。您无需手动添加 ServiceProvider。

发布配置（可选）如果您想自定义默认值，您可以发布配置文件

php artisan vendor:publish --tag=postalcodemex-config

这将创建 config/postalcodemex.php 文件，您可以在其中定义 API 的基本 URL 和您的访问令牌。

3. 配置环境变量

将以下变量添加到您的 .env 文件中，包括 PostalCodeMex API 的 URL 和令牌

POSTALCODEMEX_API_URL=https://postalcodemex.omsoft.com.mx #Opcional
POSTALCODEMEX_API_TOKEN=tu-token-aqui

4. 使用

配置完成后，您可以使用客户端查询与邮政编码、街区、州等相关信息。

示例：按邮政编码获取街区在您的任何控制器、服务或组件中，您可以执行以下操作

use PostalCodeMexClient;

$colonias = PostalCodeMexClient::getNeighborhoods('12345');

if ($colonias->successful()) {
    $data = $colonias->json();
    // Maneja los datos de las colonias
} else {
    // Manejar error
}

可用方法

getNeighborhoods(string $cp): PromiseInterface|Response
getStates(): PromiseInterface|Response
getTownByState(string $state): PromiseInterface|Response
getPostalCodesByTown(string $town): PromiseInterface|Response
getSettlements(): PromiseInterface|Response
getZones(): PromiseInterface|Response

5. 测试

如果您想运行库中包含的测试，请使用以下命令

composer test

omsoft / postalcodemex-client

维护者

详细信息