PHPackages                             omsoft/postalcodemex-client - 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. [API Development](/categories/api)
4. /
5. omsoft/postalcodemex-client

ActiveLibrary[API Development](/categories/api)

omsoft/postalcodemex-client
===========================

Client for PostalCodeMex API

0.0.3(1y ago)0450↓33.3%MITPHP

Since Sep 5Pushed 1y ago1 watchersCompare

[ Source](https://github.com/systemEDOM/postalcodemex-client)[ Packagist](https://packagist.org/packages/omsoft/postalcodemex-client)[ RSS](/packages/omsoft-postalcodemex-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)DependenciesVersions (4)Used By (0)

PostalCodeMex Client
====================

[](#postalcodemex-client)

[![Latest Stable Version](https://camo.githubusercontent.com/b6fff9d9a806319e4e585fc7f9f182c216f98c370a52942577e49821d1ee1e50/68747470733a2f2f706f7365722e707567782e6f72672f73797374656d45444f4d2f706f7374616c636f64656d65782d636c69656e742f762f737461626c65)](https://packagist.org/packages/systemEDOM/postalcodemex-client)[![License](https://camo.githubusercontent.com/012eeabb1d4eab3c1a4ae1c0005399d3cc8841bf211b65fc771c638b516c4237/68747470733a2f2f706f7365722e707567782e6f72672f73797374656d45444f4d2f706f7374616c636f64656d65782d636c69656e742f6c6963656e7365)](https://packagist.org/packages/systemEDOM/postalcodemex-client)

**PostalCodeMex Client** es una librería para Laravel que permite consumir la API de [PostalCodeMex](http://postalcodemex.omsoft.com.mx). Esta API proporciona información detallada sobre códigos postales, colonias, estados y más.

Instalación
-----------

[](#instalación)

### Requisitos

[](#requisitos)

- Laravel 9.x, 10.x o superior
- PHP 8.1 o superior

### 1. Instalar el paquete

[](#1-instalar-el-paquete)

Puedes instalar el paquete a través de Composer. Ejecuta el siguiente comando en tu proyecto Laravel:

```
composer require omsoft/postalcodemex-client
```

### 2. Configuración

[](#2-configuración)

Una vez instalado, el paquete se registrará automáticamente en Laravel (gracias al soporte de Laravel 11+ para el descubrimiento automático de paquetes). No necesitas añadir manualmente el ServiceProvider.

Publicar configuración (opcional) Si deseas personalizar los valores predeterminados, puedes publicar el archivo de configuración:

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

Esto creará el archivo config/postalcodemex.php, donde podrás definir la URL base de la API y tu token de acceso.

### 3. Configurar las variables de entorno

[](#3-configurar-las-variables-de-entorno)

Agrega las siguientes variables a tu archivo .env con la URL y el token de la API de PostalCodeMex:

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

### 4. Uso

[](#4-uso)

Una vez configurado, puedes usar el cliente para consultar información relacionada con códigos postales, colonias, estados, etc.

Ejemplo: Obtener colonias por código postal En cualquier controlador, servicio o componente de tu aplicación, puedes hacer lo siguiente:

```
use PostalCodeMexClient;

try {
    $colonias = PostalCodeMexClient::getNeighborhoods('12345');
} catch (Exception $ex) {
    // Manejar excepciones
}
```

Métodos disponibles

```
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. Testing

[](#5-testing)

Si deseas ejecutar las pruebas incluidas en la librería, usa el siguiente comando:

```
composer test
```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance49

Moderate activity, may be stable

Popularity13

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity31

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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

Every ~125 days

Total

3

Last Release

369d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/6041a8684788b458e6ef7cbf1f97cf66a19de1d53ca7d9431ab8b24b64a39d76?d=identicon)[systemEDOM](/maintainers/systemEDOM)

---

Top Contributors

[![systemEDOM](https://avatars.githubusercontent.com/u/10385109?v=4)](https://github.com/systemEDOM "systemEDOM (10 commits)")

### Embed Badge

![Health badge](/badges/omsoft-postalcodemex-client/health.svg)

```
[![Health](https://phpackages.com/badges/omsoft-postalcodemex-client/health.svg)](https://phpackages.com/packages/omsoft-postalcodemex-client)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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