Renovaciones API Documentación

Esta API permite gestionar la información de Renovaciones en Contratos mediante diferentes parámetros de filtrado. Antes de utilizar cualquier endpoint, es necesario autenticarse y obtener un token Bearer.

Paso 1: Obtener el Token Bearer

POST /api/suscripciones/autenticar?usuario={Usuario}&clave={Clave}

Este endpoint permite obtener un token de autenticación que deberá incluirse en los encabezados de las solicitudes a los demás endpoints.

Parámetros:

usuario: Nombre de usuario (texto).
clave: Contraseña del usuario (texto).

Respuesta:

{
    "respuesta": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Incluye el token en el encabezado Authorization de las solicitudes posteriores:

Authorization: Bearer {token}

Paso 2: Usar los Endpoints

Una vez adquirido el token, utiliza los siguientes endpoints para interactuar con la API.

Parámetros de la URL (/api/suscripciones/renovaciones?)

Resumen (string, obligatorio): * 1 = Devolverá la cantidad de registros encontrados en base a los parámetros que le fueron enviados * 0 = Devolverá el detalle de registros encontrados en base a los parámetros que le fueron enviados
Producto (string, obligatorio): Debe enviar el tipo de producto (Impreso,Digital).
FechaFinDesde (string, obligatorio): Desde Fecha de inicio del contrato (formato YYYY-MM-DD).
FechaFinHasta (string, obligatorio): Hasta Fecha de inicio del contrato (formato YYYY-MM-DD).
TipoContratoID (numérico, opcional): Código de tipo de contrato.
TipoContrato (string, opcional): Descripcion del tipo de contrato.

Ejemplo de solicitud

GET /api/suscripciones/renovaciones?resumen=1&Producto=Impreso&FechaFinDesde=2025-08-01&FechaFinHasta=2025-09-30

En caso de error se devolverá un json conteniendo un unico tag, ampliando el motivo del error

Ejemplo:

"{"respuesta":"Usuario o Clave, Incorrecta"}"

Si la consulta devuelve información se retorna en formato JSON con la siguiente estructura.

Ejemplo JSON de Datos:

{ "Datos": [ { "ClienteUnico": 22466, "ClienteID": 85441, "NombreCompleto": "SILVIA NOELIA LOPEZ", "RazonSocial": "SILVIA NOELIA LOPEZ", "Telefonos": "56618443 22449999", "Correos": "slopez@YAHOO.ES;", "TipoCliente": "INDIVIDUAL", "Genero": "Femenino", "FechaNacimiento": "1982-12-14T00:00:00", "ContratoID": 764420, "TipoContratoID": 54, "TipoContrato": "adulto Mayor", "Producto": "Impreso", "FechaInicio": "2024-10-01T00:00:00", "FechaFin": "2025-09-30T00:00:00", "Estado_Contrato": "ALTA ", "Tarifa": "ADULTO MAYOR IMPRESO 1 AÑO Q459 + 1TL", "DuracionID": 90, "Meses": 12, "Duración": "12 MESES DE SERVICIO", "Renovado": "NO", "IdTipo_Suscripcion": 3, "Tipo_Suscripcion": "Impreso" }, ...] }