API Predial
Documentación del Servicio Web 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
- Obtén un token iniciando sesión con tus credenciales en
POST /api/predial/login. - Incluye el token en el encabezado
Authorization: Bearer <token>de cada petición. - Consulta el predio con
GET /api/predial/consulta-predioindicando municipio, tipo y número de cuenta. - Consulta el adeudo con
POST /api/predial/consulta-adeudopara obtener los conceptos a pagar.
Endpoints disponibles
| Método | Ruta | Descripción |
|---|---|---|
| POST | /api/predial/login | Iniciar sesión y obtener JWT |
| GET | /api/predial/consulta-predio | Datos catastrales del predio |
| GET | /api/predial/consulta-propietario | Datos del propietario/contribuyente |
| POST | /api/predial/consulta-adeudo | Conceptos de adeudo vigentes |
| POST | /api/predial/confirma-pago | Confirmar pago realizado |
Envelope de respuesta
Todas las respuestas incluyen los campos de control:
| Campo | Tipo | Descripción |
|---|---|---|
estatus_ejecucion | int | 1 = éxito, cualquier otro valor = error |
mensaje_ciudadano | string | Mensaje legible para el usuario final |
mensaje_tecnico | string | Detalle técnico del error (vacío en éxito) |
Códigos de catálogo
id_tipo_predio
| Valor | Descripción |
|---|---|
1 | Urbano |
2 | Rústico |
3 | Suburbano |
clase_pago (en adeudos)
| Valor | Descripción |
|---|---|
1 | Anual |
2 | Bimestral |
concepto (en adeudos)
| Valor | Descripción |
|---|---|
1 | Impuesto |
2 | Actualizaciones |
3 | Recargos |
4 | Reducción 50 % |