api-postal-code-spain/README.md

89 lines
1.7 KiB
Markdown
Raw Normal View History

2018-04-24 16:02:00 +02:00
# API para Códigos postales de España
2018-04-05 09:27:43 +02:00
2018-04-24 16:02:00 +02:00
Sencilla API para obtener información de los códigos postales de España. Obteniendo información como:
2018-04-05 09:27:43 +02:00
2018-04-24 16:02:00 +02:00
- Código postal.
- Población.
- Latitud.
- Longitud.
2018-04-05 09:27:43 +02:00
2018-04-24 16:02:00 +02:00
## Llamadas
2018-04-05 09:27:43 +02:00
2022-09-07 16:42:12 +02:00
Lamentablemente Heroku [anunció que eliminaría sus planes gratuitos](https://help.heroku.com/RSBRUH58/removal-of-heroku-free-product-plans-faq) provocando que los ejemplos de esta lección no estén disponibles para probarlos con `curl`, ya que estaba desplegado en un Dyno gratutito. Puedes testearlo directamente en tu equipo.
2018-04-24 16:02:00 +02:00
### Obtener todos los datos de un código postal
2018-04-05 09:27:43 +02:00
2018-04-24 16:02:00 +02:00
``` bash
https://hidden-sierra-35586.herokuapp.com/api/v1/postal_code/{numero}
```
Ejemplo
``` bash
https://hidden-sierra-35586.herokuapp.com/api/v1/postal_code/46017
```
``` json
[
{
"index": 461021,
"postal_code": 46017,
"poblacion": "Santa Margarida de Montbui",
"lat": 41.55659597,
"lng": 1.60489809
},
{
"index": 461022,
"postal_code": 46017,
"poblacion": "Pampliega",
"lat": 42.20619881,
"lng": -3.98797885
},
{
"index": 461023,
"postal_code": 46017,
"poblacion": "Villanueva de Guadamejud",
"lat": 40.22470982,
"lng": -2.50703229
},
...
]
```
### Obtener por index (indice)
``` bash
https://hidden-sierra-35586.herokuapp.com/api/v1/index/{indice}
```
Ejemplo
``` bash
https://hidden-sierra-35586.herokuapp.com/api/v1/index/461021
```
``` json
[
{
"index": 461021,
"postal_code": 46017,
"poblacion": "Santa Margarida de Montbui",
"lat": 41.55659597,
"lng": 1.60489809
}
]
```
2018-04-05 09:27:43 +02:00
2018-04-24 16:02:00 +02:00
## Instalación
2018-04-05 09:27:43 +02:00
```bash
pipenv install
pipenv shell
```
2018-04-24 16:02:00 +02:00
Después solo debes arrancarlo.
2018-04-05 09:27:43 +02:00
```bash
python3 app.py
```