API Predial

Descripción general

La API Predial expone servicios REST/JSON que permiten consultar información catastral y calcular el adeudo del Impuesto Predial de los municipios incorporados al esquema de interoperabilidad con la SPFA.

El servicio opera en la ruta base /api/predial/ y utiliza autenticación JWT Bearer para todos los endpoints excepto el de inicio de sesión.

Inicio rápido

  1. Obtén un token iniciando sesión con tus credenciales en POST /api/predial/login.
  2. Incluye el token en el encabezado Authorization: Bearer <token> de cada petición.
  3. Consulta el predio con GET /api/predial/consulta-predio indicando municipio, tipo y número de cuenta.
  4. Consulta el adeudo con POST /api/predial/consulta-adeudo para obtener los conceptos a pagar.

Endpoints disponibles

MétodoRutaDescripción
POST/api/predial/loginIniciar sesión y obtener JWT
GET/api/predial/consulta-predioDatos catastrales del predio
GET/api/predial/consulta-propietarioDatos del propietario/contribuyente
POST/api/predial/consulta-adeudoConceptos de adeudo vigentes
POST/api/predial/confirma-pagoConfirmar pago realizado

Envelope de respuesta

Todas las respuestas incluyen los campos de control:

CampoTipoDescripción
estatus_ejecucionint1 = éxito, cualquier otro valor = error
mensaje_ciudadanostringMensaje legible para el usuario final
mensaje_tecnicostringDetalle técnico del error (vacío en éxito)

id_tipo_predio

ValorDescripción
1Urbano
2Rústico
3Suburbano

clase_pago (en adeudos)

ValorDescripción
1Anual
2Bimestral

concepto (en adeudos)

ValorDescripción
1Impuesto
2Actualizaciones
3Recargos
4Reducción 50 %