Download the PHP package omsoft/postalcodemex-client without Composer
On this page you can find all versions of the php package omsoft/postalcodemex-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download omsoft/postalcodemex-client
More information about omsoft/postalcodemex-client
Files in omsoft/postalcodemex-client
Package postalcodemex-client
Short Description Client for PostalCodeMex API
License MIT
Informations about the package postalcodemex-client
PostalCodeMex Client
PostalCodeMex Client es una librería para Laravel que permite consumir la API de PostalCodeMex. Esta API proporciona información detallada sobre códigos postales, colonias, estados y más.
Instalación
Requisitos
- Laravel 9.x, 10.x o superior
- PHP 8.1 o superior
1. Instalar el paquete
Puedes instalar el paquete a través de Composer. Ejecuta el siguiente comando en tu proyecto Laravel:
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:
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
Agrega las siguientes variables a tu archivo .env con la URL y el token de la API de PostalCodeMex:
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:
Métodos disponibles
5. Testing
Si deseas ejecutar las pruebas incluidas en la librería, usa el siguiente comando: