Code Monkey home page Code Monkey logo

api-codigos-postales's Introduction

API para los códigos postales de México

Code Climate

Deploy

Dado un código postal, regresa un arreglo con las colonia, municipio y estado perteneciente al código postal. Además se pueden realizar búsquedas de códigos postales usando los números iniciales.

Sube la app a heroku

  1. Da click en el botón Deploy to Herkou y sigue los pasos.
  2. Al terminar corre heroku run rake sepomex:update.
  3. Agrega el task de rake sepomex:update en el addon de Heroku Scheduler para que se corra cada día.

Ejemplos de uso

#### Liga a la API

https://api-codigos-postales.herokuapp.com

Consultar la información de un código postal

https://api-codigos-postales.herokuapp.com/v2/codigo_postal/66436

Respuesta del servidor

{
  "codigo_postal": "66436",
  "municipio": "San Nicolás de los Garza",
  "estado": "Nuevo León",
  "colonias": [
    "Praderas de Santo Domingo",
    "Las Nuevas Puente"
  ]
}

Buscar códigos postales

 https://api-codigos-postales.herokuapp.com/v2/buscar

parametros necesarios

  codigo_postal=# codigo a buscar, parcial o total

Ejemplo de busqueda para códigos que inicien con 66, con 664 y con 6641

https://api-codigos-postales.herokuapp.com/v2/buscar?codigo_postal=66
https://api-codigos-postales.herokuapp.com/v2/buscar?codigo_postal=664
https://api-codigos-postales.herokuapp.com/v2/buscar?codigo_postal=6641

** Para el codigo postal 6641 el servidor regresa **

{
  "codigos_postales": [
    "66410",
    "66412",
    "66413",
    "66414",
    "66415",
    "66417",
    "66418"
  ]
}

Rake task

Ejecuta el rake task rake sepomex:update para descargar todos los códigos postales de méxico y actualizar tu base de datos.

Colabora

Errores y pull requests son bienvenidos en Github: https://github.com/Munett/API-Codigos-Postales. Para bajar en tu BD todos los códigos postales corre el rake script rake sepomex:update.

Los datos se obtuvieron de http://www.correosdemexico.gob.mx/lservicios/servicios/CodigoPostal_Exportar.aspx

TODO

  • Pruebas automatizadas minitest

Los datos se actualizan cada domingo.

Licencia

MIT License

api-codigos-postales's People

Contributors

acrogenesis avatar ebratb avatar everblut avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.