Información general

Tabla de contenidos

Guía de inicio rápido

Para los desarrolladores que quieran empezar a trabajar con la API de Goolzoom, estos son los pasos a seguir para hacer su primera llamada a la API.

  1. Crea una clave de acceso desde el menú de Credenciales
  2. Haz una consulta GET usando la clave anteriormente creada. Añade a la consulta la cabecera x-api-key=clave_de_acceso. 
    curl -H "x-api-key: your_api_key" -G https://api.goolzoom.com/v1/cadastre/provinces
  3. Ahora que has confirmado que tu clave de API funciona, sigue leyendo el resto de esta documentación y comienza a construir tu aplicación.

Autenticación

Todas las solicitudes HTTP realizadas a la API de Goolzom deben ser validadas con una clave API. Si aún no tienes una clave de la API, puedes crear una desde el menú de Credenciales.

Advertencia de seguridad: es importante proteger la clave de la API del acceso público. El usuario es responsable de que la clave no quede expuesta a terceros que puedan hacer uso de ella. La clave de acceso permite contabilizar los costes asociados a cada consulta, por lo que es importante que la mantengas en privado.

Para autenticarse en la API, añade en cada consulta HTTP la cabecera x-api-key=clave_de_acceso. La API informará en caso de que la clave sea incorrecta.

Límites

El acceso a la API tiene ciertas limitaciones. Dependiendo del tipo de credencial que uses, se aplicarán los siguientes:

Límite Máximo
Solicitudes por segundo 10
Solicitudes por ráfaga 5
Solicitudes al mes 100.000

Conjuntos de datos

La API de Goolzoom se estructura en los siguientes conjuntos de datos:

Conjunto Ruta Descripción
Catastro https://api.goolzoom.com/v1/cadastre/ Contiene datos del Catastro español de Hacienda. Estos datos son los mismos que se proporcionan en la herramienta de Catastro PRO.
Registro de la Propiedad https://api.goolzoom.com/v1/landregistry/ Conjunto de datos del Registro de la Propiedad. Estos datos se facilitan también en la herramienta de Registro Fácil
Delimitaciones https://api.goolzoom.com/v1/delimitations/ Conjunto de delimitaciones de España: provincias, municipios, distritos, etc.
Datos estadísticos https://api.goolzoom.com/v1/statistics/ Conjunto de estadísticas de España. Son los mismos que se encuentran en la herramienta de Datos.
Urbanismo https://api.goolzoom.com/v1/urbanplanning/ Conjunto de datos urbanísticos de España. Estos datos son los mismos que se facilitan en la herramienta de Urbanismo

Errores

La API puede devolver mensajes de error en formato JSON que contienen información sobre errores en las solicitudes. A continuación se presentan los errores más frecuentes:

HTTP Status Descripción del error
400 Solicitud incorrecta. Revisar los parámetros de la consulta.
401 Recurso no autorizado.
403 Solicitud incorrecta. Revisar la cabecera x-api-key de la consulta.
404 No se ha encontrado el recurso. Revisar los parámetros.

Convenciones

Todas las respuestas de la API siguen el formato JSON. En el caso de los datos de geometría como, por ejemplo, parcelas catastrales, el formato de respuesta es GeoJSON.

La API acepta el parámetro callback=your_function para devolver los resultados en formato JSONP.

Referencia

Hemos preparado una página de acceso público escrita en inglés con toda la especificación completa.

Ir a la página de la referencia

Descargar

Descarga la referencia para probar la API en cualquier plataforma.

Versiones

La API de Goolzoom está sujeta a versiones para garantizar que las nuevas funciones y actualizaciones no perjudiuqen a las anteriores. La última versión de esta API es /v1/.