ivansabik / ubicajeros-api

API with info for ATMs (cajeros) in Mexico

Ubicajeros API

HTTP API for getting ATMs (Cajeros) available in Mexico. If gets the information from calls to the ubicajeros app from Banco de Mexico (BANXICO). There's a bunch of wrong lat/lon but those need to be reported in the BANXICO app and fixed from there.

Dependencies:

• flask
• pynamodb
• zappa for serverless deployment

Installation

Docker

git clone https://github.com/ivansabik/ubicajeros-api.git
cd ubicajeros-api
source .venv/bin/activate
pip install -r requirements-deploy.txt
zappa deploy dev

In AWS using zappa

git clone https://github.com/ivansabik/ubicajeros-api.git
cd ubicajeros-api
zappa deploy

Manual

git clone https://github.com/ivansabik/ubicajeros-api.git
cd ubicajeros-api
virtualenv .venv #optional
source .venv/bin/activate #optional
pip install -r requirements.txt
python ubicajeros/api.py

To update the db:

python bin/update_db.py -h
usage: update_db.py [-h] [-r RADIUS] [-l LATLON]

Update db with Cajeros

optional arguments:
  -h, --help            show this help message and exit
  -r RADIUS, --radius RADIUS
                        Search radius (this is in km.)
  -l LATLON, --latlon LATLON
                        Latitude/Logitude separated by comma

You can run a demo client app at /cajeros.html

Endpoints

• /cajeros
• /cajero/ID_CAJERO

/cajero/J16621

{
  "address": "FRANCISCO_I_MADERO, 20, CENTRO, Cuauht\u00e9moc, Distrito Federal",
  "id": "A00044",
  "lat": 19.433838,
  "lon": -99.138858,
  "open_hours": "06:00-14:00",
  "org_code": 40042,
  "org_name": "MIFEL",
  "updated_at": "Sun, 16 Jul 2017 05:14:36 GMT",
  "zip_code": "6000"
}

/cajeros

{
  "cajeros": [
    {
      "address": "BOLIVAR No 38, 38, CENTRO, Venustiano Carranza, Distrito Federal",
      "id": "2775",
      "lat": 19.431813,
      "lon": -99.138561,
      "open_hours": "00:00-24:00",
      "org_code": 40012,
      "org_name": "BBVA BANCOMER",
      "updated_at": "Sun, 16 Jul 2017 05:14:36 GMT",
      "zip_code": "15000"
    },
    {
      "address": "Francisco I. Madero, No 6, Centro, Cuauht\u00e9moc, Distrito Federal",
      "id": "QMXS75",
      "lat": 19.434148,
      "lon": -99.138034,
      "open_hours": "08:00-22:00",
      "org_code": 40036,
      "org_name": "INBURSA",
      "updated_at": "Sun, 16 Jul 2017 05:14:36 GMT",
      "zip_code": "6500"
    }
  ]
}

/cajeros?estado=tabasco

Returns only values for this state

ubicajeros-api's Issues

Zappatize!

Usar zappa para serverless con AWS, schedule actualizaciones, dynamodb o archivo JSON a s3 para persistencia

Handle zipped response

The API started returning a zipped response, currently module is broken until it handles that appropriately

Change unqlite for tinydb

To read from a JSON file instead of a binary file (.db)
https://github.com/msiemens/tinydb

Add TTL or expiration for sample client app

Currently it stores locally results by state, ideally only keep those for 1 day

Client app add state dropdown and table/map

Some kind of wizard style:

1. Which state?
2. Show in map or as table?

Flag as inactive/deleted or delete ATMs not found in source

For example if we have Cajero X and it gets deleted in source, we don't want to show it as active so we need to delete or flag as deleted/inactive in our db

Add flask profiler support

muatik/flask-profiler#66