• Tabla de Contenido
• Acerca de MXZIPCODES
• Requerimientos
• Instalación
• API Endpoints
  • GET /api/zip-codes/{zipcode}
  • GET /api/{name}
  • GET /api/test
• Problemas con backbonesystems API

MXZIPCODES es un REST API construido en Laravel, el cual importa desde un Excel todos los datos para popular la Base de Datos y poder generar los endpoints necesarios.

Estos son los requerimientos para poder correr el proyecto:

• PHP ^8.0.2
• Node
• Composer

Clonamos el repositorio:

$ git clone https://github.com/angelleger/mxzipcodes.git

Entramos a la carpeta y instalamos las dependencias:

$ cd mxzipcodes && composer install

Debemos ejecutar el comando sail: install Artisan. Este comando publicará el archivo docker-compose.yml de Sail en la raíz de su aplicación:

$ php artisan sail:install

te aparecera el siguiente prompt, procedemos a elegir mysql y redis son los valores 0,3:

Which services would you like to install? [mysql]:
[0] mysql
[1] pgsql
[2] mariadb
[3] redis
[4] memcached
[5] meilisearch
[6] minio
[7] mailhog
[8] selenium   

Corremos el ambiente:

$ ./vendor/bin/sail up

Finalmente, creamos las tablas y agregamos los datos, el valor sail debe imperar al principio del comando ya que estaremos creando y populando los datos en el contenedor de sail:

$ sail php artisan migrate --seed  

points allow you to handle Stripe subscriptions for Publish and Analyze.

Este endpoint esta diseñado para obetenr toda la información relacionada con un zipcode en especifico.

Parameters

Respuesta

{
   "zip_code":"47078",
   "locality":"SAN JUAN DE LOS LAGOS",
   "federal_entity":{
      "key":14,
      "name":"JALISCO",
      "code":null
   },
   "settlements":[
      {
         "key":1752,
         "name":"SAN NICOLAS",
         "zone_type":"RURAL",
         "settlement_type":{
            "name":"Colonia"
         }
      }
   ],
   "municipality":{
      "key":73,
      "name":"SAN JUAN DE LOS LAGOS"
   }
}

Con este endpoint aceleramos la velocidad de respuesta de todos y cada unos de los zipcodes por medios de un cache usando redis, como por igual podemos eliminar el cache ya almacenado.

Parameters

Response

// CACHE
{
   "status":"success cached",
   "message":{
      "10000":"CACHED ALREADY",
      "10010":"CACHED ALREADY",
      "10020":"CACHED ALREADY",
      "10130":"CACHED ALREADY",
      "10200":"CACHED ALREADY",
      "10300":"CACHED ALREADY",
      "10320":"CACHED NOW",
      "10330":"CACHED NOW"
   }
}

// UNCACHE

{
   "status":"success",
   "message":"uncached",
   "redis_keys":[
      
   ]
}

Este enpoint esta destinado a hacer una con 10 endpoints tomados de manera aleatoria a estos dos endpoints.

https://159.223.116.118/api/zip-codes/

https://jobs.backbonesystems.io/api/zip-codes/

Response

{
   "30674":{
      "equal":true
   },
   "36310":{
      "equal":true
   },
   "47368":{
      "equal":true
   },
   "50945":{
      "equal":true
   },
   "58067":{
      "equal":true
   },
   "60556":{
      "equal":true
   },
   "61367":{
      "equal":true
   },
   "64120":{
      "equal":true
   },
   "68103":{
      "equal":true
   },
   "87949":{
      "equal":true
   }
}

Probando los endpoints note que algunos muestran diferencias, tomemos de ejemplo este en especifico el 29904

al ver las diferencias note que el de backbonesystems tenia 75 items en settlements:

pero el de MXZIPCODES tiene 76:

al consultar el excel como pueden ver el numero correcto es 76:

asi que el API Rest de backbonesystems al parecer en varios zipcodes le faltan settlements por ende muchas veces no seran iguales en las comparaciones.

Otro problema es por ejemplo el zipcode 99640 da un 404, cuando en realidad si existe en el documento.

https://jobs.backbonesystems.io/api/zip-codes/99640