Referencia de Endpoints

Referencia rápida de todos los endpoints de la API REST del Sistema A3.

Formato de URL

https://www.sistemaa3.com/api/{recurso}/

Recursos Disponibles

Inventario

Método	Endpoint	Descripción
GET	/api/inventario/casas/	Listar casas
POST	/api/inventario/casas/	Crear casa
GET	/api/inventario/casas/{id}/	Detalle de casa
PUT	/api/inventario/casas/{id}/	Actualizar casa
PATCH	/api/inventario/casas/{id}/	Actualizar parcial
DELETE	/api/inventario/casas/{id}/	Eliminar casa

Apartados

Método	Endpoint	Descripción
GET	/api/apartados/	Listar apartados
POST	/api/apartados/	Crear apartado
GET	/api/apartados/{id}/	Detalle
PUT	/api/apartados/{id}/	Actualizar
POST	/api/apartados/{id}/solicitar-obra/	Solicitar obra
POST	/api/apartados/{id}/iniciar-cierre/	Iniciar cierre

Clientes

Método	Endpoint	Descripción
GET	/api/clientes/	Listar clientes
POST	/api/clientes/	Crear cliente
GET	/api/clientes/{id}/	Detalle
PUT	/api/clientes/{id}/	Actualizar

Tickets

Método	Endpoint	Descripción
GET	/api/tickets/	Listar tickets
POST	/api/tickets/	Crear ticket
GET	/api/tickets/{id}/	Detalle
PUT	/api/tickets/{id}/	Actualizar
POST	/api/tickets/{id}/comentar/	Agregar comentario
POST	/api/tickets/{id}/completar/	Marcar completado

Acuerdos

Método	Endpoint	Descripción
GET	/api/acuerdos/	Listar acuerdos
POST	/api/acuerdos/	Crear acuerdo
GET	/api/acuerdos/{id}/	Detalle
POST	/api/acuerdos/{id}/agregar-subtarea/	Agregar subtarea

Comprobaciones

Método	Endpoint	Descripción
GET	/api/comprobaciones/	Listar comprobaciones
POST	/api/comprobaciones/	Crear comprobación
GET	/api/comprobaciones/{id}/	Detalle
POST	/api/comprobaciones/{id}/aprobar-contabilidad/	Aprobar contabilidad
POST	/api/comprobaciones/{id}/aprobar-tesoreria/	Aprobar tesorería

Recursos Humanos

Método	Endpoint	Descripción
GET	/api/ch/ausencias/	Listar ausencias
POST	/api/ch/ausencias/	Registrar ausencia
POST	/api/ch/checador/entrada/	Registrar entrada
POST	/api/ch/checador/salida/	Registrar salida
GET	/api/ch/horarios/	Consultar horarios

Usuarios

Método	Endpoint	Descripción
GET	/api/users/perfil/	Mi perfil
PUT	/api/users/perfil/	Actualizar perfil
GET	/api/users/notificaciones/	Mis notificaciones
POST	/api/users/notificaciones/marcar-leidas/	Marcar leídas

Anexos

Método	Endpoint	Descripción
POST	/api/anexos/upload/	Subir archivo
GET	/api/anexos/{id}/	Obtener anexo
GET	/api/anexos/{id}/download/	Descargar
DELETE	/api/anexos/{id}/	Eliminar

Reportes

Método	Endpoint	Descripción
GET	/api/reportes/ventas/	Reporte de ventas
GET	/api/reportes/inventario/	Reporte de inventario
GET	/api/reportes/comisiones/	Reporte de comisiones

Query Parameters Comunes

Filtrado

?plaza=MONTERREY
?estatus=DISPONIBLE
?fecha_inicio=2024-01-01&fecha_fin=2024-12-31

Búsqueda

?search=hacienda

Paginación

?page=2
?page_size=50

Ordenamiento

?ordering=-fecha_creacion
?ordering=precio_venta

Respuestas Estándar

Éxito (200)

{
  "count": 100,
  "next": "https://api.example.com/?page=2",
  "previous": null,
  "results": [...]
}

Creado (201)

{
  "id": 123,
  "clave": "MTY-001",
  ...
}

Error de Validación (400)

{
  "error": "Validation error",
  "details": {
    "clave": ["Este campo es requerido"],
    "precio": ["Debe ser mayor a 0"]
  }
}

No Autorizado (401)

{
  "detail": "Authentication credentials were not provided."
}

Sin Permisos (403)

{
  "detail": "You do not have permission to perform this action."
}

No Encontrado (404)

{
  "detail": "Not found."
}

---

Ver también: - API REST - Autenticación