Última Actualización:
 
 
 
 
  Total de Registros:

Inicio

---

     En API Consulta de Códigos Postales, queremos ofrecemos un Servicio que puedas incorporar a tus proyectos de la manera mas sencilla posible; donde podrás hacer diferentes tipos de consulta sobre Códigos Postales de México, como son:
 

• Consulta las Entidad Federativa del País con su IDentificador oficial
• Consulta las Localidades de cada Entidad Federativa con su IDentificador oficial
• Obtienes todos los CP por Entidad Federativa
• Obtienes todos los CP por Localidad
• Obtienes todas los CP por coincidencia de Colonia o Asentamiento
• Obtienes todas las Colonias por CP

     Todos los métodos disponibles de la API reciben la petición por GET, por lo que podrás probar directo en tu navegador, utilizar gestores de consumo como Insomnia y podras integrar facilmente en tu código fuente.
 
     Puedes hacer consultas de modo gratuido pero existe un límite de consumo en esta modalidad, por lo que recomendamos adquirir una licencia de uso y realizar consultas ilimitadas, consulta nuestra sección de Licencias.
 

 

EndPoint

---

     Para hacer uso de la API, se deberá ingresar al siguiente ENDPOINT:
 

 

• En donde {metodo} será alguno de los métodos de consulta disponibles abajo.
• En donde {token} será una variable tipo GET obligatoria, con el que se dara acceso al servicio.
• En donde {salida} será una variable tipo GET opcional, con el que indicará si el retorno de la información será en JSon, XML o Texto Plano, Valores: JSon (esta por default), XML, TXT.
• En donde {valor} será una variable tipo GET obligatoria, con el que se define el criterio de busqueda.

 

Respuesta del Servidor

---

     Una vez que se haya hecho el request, el servidor retornará código 200 http si todo esta correctoa, o retornará código 400 http si hubo un error en el envío de los parámetros al endpoint. En cualquier caso devolverá un json con el siguiente formato:
 

 

Respuesta de Consulta OK

---

• En donde {IdEnt} será una variable tipo string. Indica el ID oficial de la Entidad Federativa.
• En donde {Entidad} será una variable tipo string. Indicará el nombre de la Entidad Federativa.
• En donde {IdMun} será una variable tipo string. Indicará el ID oficial de la Ciudad/Localidad.
• En donde {Municipio} será una variable tipo string. Indicará el nombre de la Ciudad/Localidad.
• En donde {Colonia} será una variable tipo string. Indicará el nombre de la Colonia/Asentamiento.
• En donde {CP} será una variable tipo string. Indicará el Código Postal que le corresponde.
• en donde {tipoAsentamiento} será una variable tipo string. Indicará el Tipo de Asentamiento que es.

 

 

Respuesta de Consulta con Error 400

---

• En donde {strErr} será una variable tipo string. Si es igual a 1 indicará que se genero un error.
• En donde {strErrId} será una variable tipo string. Indicará el número de error que podrá ser identificado en esta documentación.
• En donde {strErrMsg} será una variable tipo string. Indicará un detalle del error que hubo al momento de mandar la solicitud al servidor.

 

 

Métodos de Consulta

---