Lista todas las colonias de un municipio de México
La consulta de código postal responde «qué colonias hay bajo estos cinco dígitos». Esta responde la pregunta grande que está encima: todo lo que hay dentro de un municipio, con el código postal al que pertenece cada fila.
Cuando el municipio es lo que ya sabes
Este es el último paso de una cascada, y también la forma que tiene la mayor parte del trabajo masivo contra el catálogo.
-
El tercer desplegable.
Estado, municipio, colonia. Para cuando alguien llega al tercer campo ya tienes el id del municipio, y la lista de colonias sale de ahí sin pedir antes un código postal.
-
Revisar lo que ya guardas.
Trae la lista real de un municipio y compárala con los nombres de colonia de tus propias tablas. Lo que no cuadre es la parte de tus direcciones que nunca estuvo bien.
-
Definir dónde entregas de verdad.
La cobertura se decide casi siempre municipio por municipio y después se expresa en colonias y códigos postales. Esta es la llamada que convierte lo uno en lo otro.
Entra el id de un municipio, salen las colonias
Alfabético, paginado, y cada fila trae el código postal en el que está esa colonia, que es lo que hace que la respuesta sirva por sí sola en vez de ser una lista de nombres que hay que volver a consultar.
Solicitud
curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.postalkit.mx/v1/municipalities/6/settlements
Respuesta
{
"data": [
{
"id": 532,
"name": "Juárez",
"zone": "Urbano",
"settlement_type": { "id": 1, "name": "Colonia" },
"postal_code": { "id": 384, "code": "06600" }
}
],
"links": { "first": "...", "last": "...", "prev": null, "next": "..." },
"meta": { "current_page": 1, "total": 230, "per_page": 20 }
}
Hay una segunda ruta a la misma lista, anidada bajo el estado, para cuando vas bajando por la jerarquía y tienes los dos ids:
Solicitud
curl -H "Authorization: Bearer YOUR_API_KEY" \ https://api.postalkit.mx/v1/states/1/municipalities/6/settlements
El mismo contenido. La forma anidada verifica que el municipio de verdad pertenezca a ese estado, así que falla de manera visible ante un par mal formado en lugar de responder en silencio sobre otro lugar.
Antes de publicarlo
Un municipio es más grande de lo que parece
-
Cientos de colonias es lo normal.
A veinte por página eso son muchas solicitudes para un solo desplegable. Si va en un formulario, tráelo una vez de forma programada y sírvelo desde tu propio almacén; si va en un reporte, lee meta.total antes de arrancar el ciclo.
-
Un mismo nombre puede aparecer más de una vez.
Un municipio grande puede tener varias colonias con el mismo nombre bajo códigos postales distintos. Usa el id como llave del desplegable y muestra el código junto al nombre, o la gente va a elegir la equivocada y nunca te vas a enterar.
-
Lee settlement_type, no solo el nombre.
La lista mezcla Colonia, Fraccionamiento, Barrio, Pueblo, Unidad habitacional y más. Llamarle «colonia» a todo en tu interfaz es lo que la gente espera; guardarlo así pierde información que el catálogo ya te había dado.
-
zone te distingue urbano de rural.
Es el campo que hay que mirar si las reglas de entrega, de precio o de cobertura cambian entre uno y otro, y ya viene en la respuesta que estás leyendo.