Parámetros de configuración

Hay varios parámetros de configuración que indican a la API cómo debe actuar, así como los datos de usuario que debe usar.

• url - Indica la URL del endpoint. http://apiv1.geoapi.es/ por defecto.
• type - Indica el tipo de respuesta, a elegir entre JSON o XML. Si no se indica nada, se usará JSON.
• key - La API Key que se usará para hacer las peticiones. Puede tener un valor nulo ('') si se activa el modo sandbox. Si no se especifica, se enviara ''.
• sandbox - Puede ser 0 (desactivado, por defecto) o 1 (activado). En caso de activar el modo sandbox, no se requerirá una API Key. De ser enviada una API Key, no se descontarán peticiones de la misma. Ten en cuenta que en modo sandbox las letras de los resultados pueden estar mezcladas.

Dichos parámetros se establecen con el método setConfig de cada librería.

var GeoAPI = require("@geoapi.es/nodejs")();
GeoAPI.setConfig("key", "...");
GeoAPI.setConfig("sandbox", 0);

$geoapi = new GeoAPI();
$geoapi->setConfig("key", "...");
$geoapi->setConfig("sandbox", 0);

Parámetros de consultas

Además de los parámetros de configuración, la API permite el uso de varios parámetros a mayores, que especifican qué tipo de resultado se desea obtener.

Estos parámetros se usan con los métodos de consultas de cada librería.

Orden de los datos

Cada método de cada una de las librerías ofrece acceso rápido a ciertas partes de la base de datos. Todos los datos están ordenados de tal manera para que sea posible acceder a cualquier información almacenada, sin conocer previamente ningún ID.

Así por ejemplo, para obtener una lista de todas las comunidades y sus IDs, haremos una consulta a la API sin especificar parámetros.

Una vez obtenidos los IDs de las comunidades, podemos enviar otra petición a la API, pasando como parámetro solo el ID de aquella comunidad cuyas provincias queramos obtener.

De la misma manera procederemos con los municipios, poblaciones, núcleos y códigos postales hasta llegar a las calles, que es el nivel de detalle más alto.