Skip to main content

Endpoint base

La API productiva disponible para consumo esta en:
  • Base URL: https://api.raul.ugps.io
  • Health check: https://api.raul.ugps.io/api/health
  • OpenAPI JSON: https://api.raul.ugps.io/api/openapi.json

Autenticacion

Los endpoints protegidos usan autenticacion Bearer con token JWT. La referencia de API indica que operaciones requieren autenticacion y los esquemas de request y response asociados.

Fuente de referencia

La pestaña de API renderiza automaticamente los endpoints definidos en el esquema OpenAPI expuesto por el backend. Este documento no replica manualmente los contratos; consume la definicion publicada por la API.

Modulos disponibles

ModuloDescripcion
AuthLogin, refresh, logout, gestion de usuarios, avatar, password reset
ClientsCRUD de clientes, paginacion, logo
Client FatherClientes padre con suscripciones
Client AddressesDirecciones agrupadas por ciudad
ContactContactos, leads, functional roles, merge, fotos
Vehicle / AssetVehiculos, filtros, tipos de vehiculo
ActivitiesTimeline por cliente/contacto/visita, archivos, tipos
GPS DetailsEquipos GPS con paginacion offset/cursor, IMEI, resumen
GPS CatalogosModelos, plataformas, inventario, marcas, categorias, estados, historial
SubscriptionsSuscripciones, planes, estados, monedas, transferencias
CatalogosRubro, ciudad, tipo de contrato, cargo, comunicacion, lifecycle

Rutas recomendadas

  • Prefiere rutas RESTful cuando exista una alternativa legacy equivalente.
  • En modulos con gran volumen de datos, prefiere endpoints paginados o cursor-based.
  • Algunos endpoints tienen alias (ej: /gps_details/... y /gps/...); ambos son equivalentes.
  • Usa esta documentacion junto con la guia de consumo para IA cuando el cliente sea un agente o automatizacion.

Abrir JSON OpenAPI

Ver definicion completa de endpoints y esquemas

Ver health check

Confirmar disponibilidad operativa del backend

Guia para IA

Criterios para agentes, automatizaciones y consumo programatico