cp_validator

Códigos Postales Españoles

Este programa es un ejercicio práctico de REST API basado en Flask para validación y consulta de Códigos Postales españoles.

Los ficheros fuente de muestra están publicados por Correos España en la url.

⚠️ IMPORTANTE ⚠️: la BD completa es privativa y de pago 💔. Su uso exige la suscripción un contrato.

Instalación y ejecución

Es recomendable generar un entorno de pruebas mediante virtualenv preferiblemente bajo python3.

Obtenemos e instalamos el paquete:

pip install virtualenv

Generamos el entorno:

virtualenv -p python3 vp3

Lo activamos:

source vp3/bin/activate

Clonamos el repo:

git clone https://github.com/klashxx/cp_validator.git

Nos situamos en la carpeta del proyecto:

cd cp_validator/

Exportamos las variables de entorno asociadas a Flask

export FLASK_APP=cp_validator
export FLASK_DEBUG=true

Instalamos la aplicación:

pip install -e .

Y listos para lanzar el servicio !!

flask run

Métodos

Toda la información se recibe como JSON.

/codigos

/codigos/{codigo}

Códigos

Devuelve todos los códigos postales contenidos en el fichero POSTAL.txt.

$ curl -i http://localhost:5000/cp/api/v1.0/codigos

Código

Devuelve los datos específicos para un código concreto.

$ curl -i http://localhost:5000/cp/api/v1.0/codigos/29190
HTTP/1.0 200 OK
Content-Type: application/json
Content-Length: 663
Server: Werkzeug/0.11.13 Python/3.5.2
Date: Fri, 30 Dec 2016 23:03:27 GMT

{
  "29190": {
    "data": [
      {
        "cod_ine": "0000000000000000",
        "cod_localidad": "2900",
        "cod_municipio": "00000",
        "estado": "",
        "id_registro": "29009484",
        "impar_inferior": "0001",
        "impar_superior": "9999",
        "inf_impar_inferior": null,
        "inf_impar_superior": null,
        "inf_par_inferior": null,
        "inf_par_superior": null,
        "localidad": "MALAGA",
        "nombre_via": "AGAPANTO",
        "par_inferior": "0002",
        "par_superior": "9998",
        "tipo_via": "CALLE"
      }
    ],
    "uri": "http://127.0.0.1:5000/cp/api/v1.0/codigos/29190"
  }
}