Volver al blog

Documentación API Catastro sin SOAP ni XML

Documentación API Catastro sin SOAP ni XML

Buscar `documentacion api catastro` suele llevar a equipos técnicos a servicios oficiales con operaciones SOAP, respuestas XML extensas y reglas de integración poco evidentes. El problema no es consultar un inmueble una vez: es construir una función fiable de búsqueda, validación o enriquecimiento que siga funcionando cuando entren miles de direcciones, referencias catastrales y usuarios.

Para una plataforma proptech, un CRM inmobiliario o una herramienta GIS, la documentación no es un recurso secundario. Define cuánto tarda el primer prototipo, cuántos errores llegan a producción y si el equipo puede mantener la integración sin depender de una persona que conozca cada particularidad del Catastro. Una API moderna debe convertir esa complejidad en decisiones técnicas claras: qué endpoint usar, qué datos devuelve, cómo interpretar cada campo y qué hacer cuando no hay resultados.

Qué debe resolver la documentación de una API de Catastro

La documentación útil empieza por los casos de uso, no por un inventario de métodos. Un desarrollador necesita saber si puede localizar un municipio, autocompletar una calle, resolver una dirección, recuperar la referencia catastral de una finca o transformar coordenadas antes de escribir una sola línea de código.

En los servicios heredados, esas acciones pueden estar repartidas entre operaciones con nombres poco descriptivos, parámetros opcionales y estructuras XML anidadas. La documentación de una API REST debe presentar el recorrido de forma explícita: primero el contexto territorial, después la vía, luego el número o el identificador del inmueble. No hay magia ni campos implícitos.

También debe separar dos conceptos que a menudo se mezclan. Una búsqueda de dirección sirve para encontrar coincidencias y guiar al usuario. Una consulta por referencia catastral busca identificar un inmueble concreto. Si una aplicación de tasación trata ambas operaciones como equivalentes, acabará generando resultados ambiguos o perdiendo casos válidos.

Empiece por el flujo que verá el usuario

Antes de revisar cada recurso, dibuje el flujo de datos de su producto. Un formulario de alta de inmueble, por ejemplo, puede requerir provincia, municipio, calle y número. Una vez resuelta la dirección, la aplicación puede guardar la referencia catastral, las coordenadas y los atributos disponibles para no repetir consultas innecesarias.

La documentación debe permitir implementar ese flujo de principio a fin. Un patrón comprensible podría ser este:

```http GET /municipalities?province=28 GET /streets?municipality=079&query=Alcala GET /addresses?street_id=12345&number=25 GET /properties/{cadastral_reference} ```

Los nombres exactos de las rutas pueden variar, pero la idea debe mantenerse: recursos previsibles, filtros claros y respuestas JSON consistentes. Si para averiguar un identificador territorial hay que inspeccionar un XML o consultar tablas auxiliares sin documentar, la capa API no ha eliminado la fricción.

Una buena referencia técnica acompaña cada endpoint con ejemplos de petición y respuesta. No basta con indicar que un campo se llama `reference`. Hay que explicar si corresponde a una referencia catastral completa, si puede faltar, en qué formato se entrega y si es seguro usarlo como clave de negocio.

Por ejemplo, una respuesta de dirección orientada a producto debería ser fácil de leer y de mapear:

```json { "address": "Calle de Alcalá 25, Madrid", "municipality": { "code": "079", "name": "Madrid" }, "cadastral_reference": "0000000VK4700A0000XX", "coordinates": { "latitude": 40.42, "longitude": -3.68 } } ```

El valor no está solo en usar JSON. Está en que el equipo sepa qué campos son identificadores, cuáles son etiquetas para la interfaz y cuáles dependen de la calidad o disponibilidad de la fuente. Esa distinción evita errores habituales, como usar el texto de una calle como clave permanente o asumir que todos los inmuebles incluirán los mismos atributos.

Autenticación y pruebas sin pasos ocultos

La primera petición debería tardar minutos, no días. Por eso la documentación tiene que explicar la autenticación con un ejemplo que se pueda copiar, incluyendo el encabezado, el formato de la clave y una respuesta correcta esperada.

```bash curl -X GET "https://api.ejemplo.es/properties/0000000VK4700A0000XX" \ -H "X-API-Key: TU_CLAVE_API" \ -H "Accept: application/json" ```

La clave API debe mantenerse en el servidor o en una función segura, nunca embebida en el código público de una aplicación web o móvil. Es una precaución sencilla, pero la documentación debe mencionarla porque muchos productos empiezan con una prueba de frontend y esa prueba acaba llegando a producción.

Swagger UI y una colección de Postman reducen todavía más el tiempo de validación. Swagger permite inspeccionar parámetros y probar peticiones desde el navegador. Postman ayuda a guardar entornos, automatizar comprobaciones y compartir una colección reproducible entre desarrollo, QA y producto. Son dos herramientas distintas: una es excelente para entender rápidamente la superficie de la API; la otra encaja mejor en pruebas de equipo y regresiones.

No todas las integraciones requieren el mismo nivel de control. Para un formulario de búsqueda, una prueba manual puede bastar al principio. Para un proceso de enriquecimiento masivo, conviene crear tests que cubran direcciones con abreviaturas, números duplicados, municipios homónimos, inmuebles sin coincidencia y referencias con formato inválido.

La documentación API Catastro debe explicar los casos límite

Los datos catastrales trabajan con una realidad territorial que no siempre es limpia. Una dirección introducida por un usuario puede incluir un nombre comercial de calle, una abreviatura local, un bloque, una escalera o un código postal erróneo. El comportamiento ante estas entradas forma parte del contrato de la API.

La documentación debe aclarar la diferencia entre una respuesta vacía, un error de validación y un fallo temporal del servicio. Un `400` indica que la petición no cumple el formato requerido. Un `404` puede significar que no existe una coincidencia para el recurso solicitado. Un `429` obliga a reducir el ritmo de llamadas. Los errores `5xx` requieren reintentos controlados, con espera progresiva y un límite razonable.

No conviene reintentar todo automáticamente. Repetir una petición mal formada solo incrementa el tráfico y oculta un defecto de integración. En cambio, una indisponibilidad transitoria sí puede justificar dos o tres reintentos escalonados. La documentación debe indicar si existen límites de uso, cómo se comunican en las cabeceras y cuál es la estrategia recomendada para consultas por lotes.

Otro punto crítico es la normalización. Una API puede aceptar búsquedas flexibles, pero su aplicación debería almacenar tanto el texto original proporcionado por el usuario como los identificadores normalizados devueltos por el servicio. Así podrá mostrar una dirección legible sin sacrificar la precisión necesaria para relacionar registros, detectar duplicados o actualizar información.

Del endpoint al producto: diseñe una integración mantenible

Una integración rápida no tiene por qué ser frágil. La práctica más rentable es encapsular las llamadas catastrales en un módulo propio, en lugar de dispersarlas por controladores, componentes de interfaz y scripts de importación. Ese módulo puede centralizar autenticación, tiempos de espera, registro de errores y transformación de campos.

Para una aplicación de valoración, el módulo puede exponer una función `buscarInmueblePorReferencia()`. Para un CRM, otra función puede resolver y normalizar direcciones. Para un visor GIS, puede transformar coordenadas y devolver geometría preparada para el mapa. El resto del producto trabaja con objetos internos estables, aunque cambie un detalle de la respuesta externa.

También merece la pena decidir qué se consulta en tiempo real y qué se guarda. El autocompletado de calles necesita baja latencia y llamadas bajo demanda. Una referencia catastral confirmada puede persistirse con fecha de consulta. Un catálogo interno de municipios quizá se pueda actualizar de forma programada. Depende del volumen, de la frecuencia de cambio y de la experiencia que espera el usuario.

El seguimiento en tiempo real de las peticiones aporta una ventaja práctica durante el lanzamiento. Permite detectar una clave mal configurada, filtros que no devuelven resultados o un formulario que está generando más consultas de las previstas. No es solo observabilidad: es una forma de conectar el comportamiento de la API con decisiones de interfaz y costes operativos.

Documentar para que producto y desarrollo hablen el mismo idioma

La mejor documentación no está escrita únicamente para quien consume endpoints. También ayuda a producto, operaciones y soporte a entender qué se puede prometer al usuario final. Si la API devuelve coincidencias de vías pero no garantiza una única finca, esa condición debe reflejarse en el diseño del flujo. Si una consulta depende de provincia y municipio, el formulario debe pedir o inferir esos datos antes de llamar al servicio.

Los widgets de búsqueda embebibles pueden acelerar una primera integración cuando el objetivo es incorporar consulta de direcciones o referencias en una web existente. Aun así, no sustituyen una integración de backend si el resultado debe alimentar procesos internos, reglas de negocio o auditorías. Elegir entre widget, API directa o ambos depende del nivel de control que necesite el producto.

CatastroAPI plantea esta capa de trabajo con REST, JSON, claves API, documentación interactiva y activos de prueba preparados para flujos modernos. El objetivo no es disfrazar los datos catastrales, sino hacerlos utilizables por software que necesita avanzar sin cargar con SOAP y XML legado.

Antes de poner la integración en producción, pruebe diez direcciones reales de su mercado, no solo el ejemplo perfecto de la documentación. Incluya edificios, parcelas, municipios pequeños y entradas escritas como las introduce un usuario. Ese pequeño ejercicio revela rápido si su modelo de datos, sus mensajes de error y su experiencia de búsqueda están listos para trabajar con el territorio real.