Documentación

Si estás leyendo esto significa que quieres saber con más detalles sobre cómo funciona el proyecto. Tranquilo, ¡nuestra documentación te aclarará todas las dudas que tengas! Y aunque te quedasen dudas, te animamos a que te pongas en contacto con nosotros para que te las resolvamos cuanto antes.

¿Qué es todo esto de GeoAPI?

GeoAPI es un proyecto que pretende facilitar el trabajo de los programadores a la hora de crear distintos componentes que requieren de datos relacionados con la geografía de España, como pueden ser nombres de calles, códigos postales, municipios, localidades, comunidades autónomas y un largo etcétera. Es decir, GeoAPI no ofrece nada al usuario final, sino a los programadores, que a su vez ofrecerán al usuario final una experiencia mejor.

Sigo sin entender que hace GeoAPI...

Pongamos un ejemplo práctico. Imaginemos el típico formulario de registro de usuarios, el cual contiene los campos de nombre, apellidos, edad, comunidad autónoma, población, dirección y código postal. Lo que GeoAPI ofrece al programador que crea dicho formulario es la posibilidad de hacer una petición a nuestra API, solicitando todas las comunidades autónomas (en vez de tener que escribirlas a mano). También le da la posibilidad de encontrar la provincia, población y municipio/localidad a partir del código postal que el usuario debe introducir en el formulario.
Además, teniendo el código postal, el programador podría obtener un listado de todas las calles que pertenecen a dicho código postal para que el usuario no tenga que escribirlo a mano, sino que pueda seleccionar su dirección desde un desplegable.

Otro ejemplo sería el de normalizar los datos en una base de datos. Pongamos de ejemplo una pagina web con perfiles de usuarios. Supongamos que cada usuario puede introducir, en un campo de texto libre, su calle y su provincia y que los demás usuarios pueden buscar por estos datos. Al ser los datos de entrada libre, cada usuario pondrá sus datos de la manera que él/ella crea mejor (p.e. 'Lleida' o 'Lérida'), lo cual supone un problema. GeoAPI ayudaría a solucionar este problema ya que obligaría a todos los usuarios a seleccionar datos concretos.

Esto es sólo un ejemplo, ¡las posibilidades son infinitas!
GeoAPI ofrece una herramienta perfecta para el control de datos geográficos de entrada, ahorrando trabajo a la hora de normalizar dichos datos dentro de la base de datos.

¿Es fácil de implementar?

No temas y olvídate de complicaciones y de documentación indescifrable; GeoAPI tiene un diseño muy simple y cuenta con ejemplos, librerías/wrappers para varios lenguajes de programación y un modo sandbox para que puedas hacer todas las pruebas que necesites sin coste alguno.

API, ejemplos y gráficos

El funcionamiento de nuestra API es extremadamente sencillo. Existe un endpoint al que se hacen consultas por GET y especificando que es lo que se desea obtener y en que formato.

El endpoint es http://apiv1.geoapi.es/ y los 3 argumentos básicos son:

key → es la clave que se obtiene al comprar uno de nuestros productos.
type → el tipo de respuesta que se desea obtener. JSON y XML son las posibles opciones.
sandbox → parametro que indica si estamos realizando pruebas. Los valores admitidos son 0 y 1. Cuando el modo sandbox está activado no se requiere una API key. Además, los datos devueltos por la API pueden ser ligeramente alterados o incompletos.

Recuerda, esto es un resumen de los puntos mas importantes de la API. La documentación completa se encuentra en nuestra documentación

Actualmente ofrecemos 3 librerías para facilitar las cosas a los programadores: una en Javascript (navegador), una en Javascript (NodeJS) y una en PHP. Sin embargo, estamos trabajando en ofrecer al menos 3 más: una en Python, una en Java y una en C#. Cada una de estas librerías está hecha para ser extremadamente sencilla de utilizar, ligera y rápida.

Sin embargo, y probablemente los programadores que han prestado atención se habrán dado cuenta, hay una pequeña diferencia entre la librería de Javascript y las demás librerías. Ésta está hecha para hacer peticiones directamente desde el cliente. Esto quiere decir que si se usa la librería de Javascript, todos los usuarios de la aplicación/página web que haga uso de GeoAPI tendrán acceso a la API key (ya que las peticiones se harán directamente desde el dispositivo del usuario). Por lo tanto, esta librería se debe usar únicamente cuando se tiene la certeza de que las personas que usan la aplicación/página no van a hacer un uso indebido a la API key (por ejemplo, aplicaciones internas de empresa, CRMs, etc...).