Skip to content

Latest commit

 

History

History
460 lines (356 loc) · 9.5 KB

README.md

File metadata and controls

460 lines (356 loc) · 9.5 KB
Raw

Sepomex

Sepomex is a REST API that maps all the data from the current zip codes in Mexico. You can get the CSV or Excel files from the official site

We build this API in order to provide a way to developers query the zip codes, states and municipalities across the country.

Table of contents

Quick start

The base URI to start consuming the JSON response is under:

http://sepomex.icalialabs.com/api/v1/zip_codes

There are currently 145,481 records on the database which were extracted from the CSV file included in the project.

Records are paginated with 15 records per page.

Running the project

Pending. Here will be the instructions to run the project with Docker. TBD

Querying the API

We currently provide 4 kind of resources:

Items per page

The 4 resources you can query are paginated with 15 items per page by default. You can change the number of items per page by adding the per_page parameter to the query string.

### ZipCodes

In order to provide more flexibility to search a zip code, whether is by city, colony, state or zip code you can now send multiple parameters to make the appropiate search. You can fetch the:
### ZipCodes
```bash
curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?per_page=200

You can't request more than 200 items per page, if you do so, the API will return 15 items per page.

Also, you can mix the per_page parameter with the page parameter to get the desired page, even with the search parameters.

curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?per_page=200&page=2
Response
{
  "zip_codes": [
    {
      "id": 1,
      "d_codigo": "01000",
      "d_asenta": "San Ángel",
      "d_tipo_asenta": "Colonia",
      "d_mnpio": "Álvaro Obregón",
      "d_estado": "Ciudad de México",
      "d_ciudad": "Ciudad de México",
      "d_cp": "01001",
      "c_estado": "09",
      "c_oficina": "01001",
      "c_cp": null,
      "c_tipo_asenta": "09",
      "c_mnpio": "010",
      "id_asenta_cpcons": "0001",
      "d_zona": "Urbano",
      "c_cve_ciudad": "01"
    },
    ...
  ],
  "meta": {
    "pagination": {
      "per_page": 15,
      "total_pages": 9728,
      "total_objects": 145906,
      "links": {
        "first": "/zip_code?page=1",
        "last": "/zip_code?page=9728",
        "next": "/zip_code?page=2"
      }
    }
  }
}

by city

curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?city=monterrey

by state

curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?state=nuevo%20leon

by colony

curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?colony=punta%20contry

by cp

curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?zip_code=67173

all together

curl -X GET https://sepomex.icalialabs.com/api/v1/zip_codes?colony=punta%20contry&state=nuevo%20leon&city=guadalupe

States

The states resources can be fetch through several means:

all

curl -X GET https://sepomex.icalialabs.com/api/v1/states
Response
{

  "states": [
    {
      "id": 1,
      "name": "Ciudad de México",
      "cities_count": 16
    },
    ...
  ],
  "meta": {
    "pagination": {
      "per_page": 15,
      "total_pages": 3,
      "total_objects": 32,
      "links": {
        "first": "/state?page=1",
        "last": "/state?page=3",
        "next": "/state?page=2"
      }
    }
  }
}

by id

curl -X GET https://sepomex.icalialabs.com/api/v1/states/1
Response
{
  "state": {
    "id": 1,
    "name": "Ciudad de México",
    "cities_count": 16
  }
}

states municipalities

curl -X GET https://sepomex.icalialabs.com/api/v1/states/1/municipalities
Response
{
  "municipalities": [
    {
      "id": 1,
      "name": "Álvaro Obregón",
      "municipality_key": "010",
      "zip_code": "01001",
      "state_id": 1
    },
    ...
    {
      "id": 16,
      "name": "Xochimilco",
      "municipality_key": "013",
      "zip_code": "16001",
      "state_id": 1
    }
  ]
}

Municipalities

all

curl -X GET https://sepomex.icalialabs.com/api/v1/municipalities
Response
{
  "municipalities": [
    {
      "id": 1,
      "name": "Álvaro Obregón",
      "municipality_key": "010",
      "zip_code": "01001",
      "state_id": 1
    },
    ...
  ],
  "meta": {
    "pagination": {
      "per_page": 15,
      "total_pages": 155,
      "total_objects": 2318,
      "links": {
        "first": "/municipality?page=1",
        "last": "/municipality?page=155",
        "next": "/municipality?page=2"
      }
    }
  }
}

by id

curl -X GET https://sepomex.icalialabs.com/api/v1/municipalities/1
Response
{
  "municipality": {
    "id": 1,
    "name": "Álvaro Obregón",
    "municipality_key": "010",
    "zip_code": "01001",
    "state_id": 1
  }
}

Cities

all

curl -X GET https://sepomex.icalialabs.com/api/v1/cities
Response
{
  "cities": [
    {
      "id": 1,
      "name": "Ciudad de México",
      "state_id": 1
    },
  ...
  ],
  "meta": {
    "pagination": {
      "per_page": 15,
      "total_pages": 45,
      "total_objects": 669,
      "links": {
        "first": "/city?page=1",
        "last": "/city?page=45",
        "next": "/city?page=2"
      }
    }
  }
}

by id

curl -X GET https://sepomex.icalialabs.com/api/v1/cities/1
Response
{
  "city": {
    "id": 1,
    "name": "Ciudad de México",
    "state_id": 1
  }
}

About pagination

The structure of a paged response is:

"meta": {
    "pagination": {
      "per_page": 15,
      "total_pages": 9728,
      "total_objects": 145906,
      "links": {
        "first": "/zip_code?page=1",
        "last": "/zip_code?page=9728",
        "prev": "/zip_code?page=1",
        "next": "/zip_code?page=3"
      }
    }
  }

Where:

  • per_page is the amount of elements per page.
  • total_pages is the total number of pages.
  • total_objects is the total objects of all pages.
  • links contains links for pages.
    • firstis the url for the first page.
    • last is the url for the last page.
    • prev is the url for the previous page.
    • next is the url for the next page.

Development

Setup the project

To setup the project please follow this simple steps:

  1. Clone this repository into your local machine:
$ git clone [email protected]:IcaliaLabs/sepomex.git
  1. Change directory into the project folder:
$ cd sepomex
  1. Run the web service in bash mode to get inside the container by using the following command:
$ docker-compose run web bash
  1. Inside the container you need to migrate the database:
$ rails db:migrate
  1. Next you should populate the database:
$ rake data:load

This operation will take some time, due to the number of records. Rake data load will load the data from the csv files into the database, like seed does. Also, it will create the indexes for the database.

  1. Close the container
$ exit

Running the project

  1. Fire up a terminal and run:
$ docker-compose up

Once you see an output like this:

web_1        | The Gemfile's dependencies are satisfied
web_1        | 2020/08/04 17:40:21 Waiting for: tcp://postgres:5432
web_1        | 2020/08/04 17:40:21 Connected to tcp://postgres:5432
web_1        | => Booting Puma
web_1        | => Rails 6.0.3.2 application starting in development
web_1        | => Run `rails server --help` for more startup options
web_1        | Puma starting in single mode...
web_1        | * Version 3.12.6 (ruby 2.7.1-p83), codename: Llamas in Pajamas
web_1        | * Min threads: 5, max threads: 5
web_1        | * Environment: development
web_1        | * Listening on tcp://0.0.0.0:3000
web_1        | Use Ctrl-C to stop

This means the project is up and running.

Stop the project

  1. Use Ctrl-C to stop.

  2. If you want to remove the containers use:

$ docker-compose down

Running specs

To run specs, you can do:

$ docker-compose run test rspec

Contributing

Please submit all pull requests against a separate branch.

Code of conduct

This project adheres to the Contributor Covenant 1.2. By participating, you are expected to honor this code.

Copyright and license

Code and documentation copyright 2013-2020 Icalia Labs. Code released under the MIT license.