Journey API Documentación

Esta API permite gestionar la información del Journey de Clientes 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/journey?)

TipoCliente (string, opcional): Tipo de cliente asociado al contrato.(INDIVIDUAL,EMPRESA)
TipoContratoID (string, opcional): Identificador único del tipo de contrato (1-Suscripción Estandar,2-Suscripción Web).
Producto (string, opcional): Nombre del producto asociado. (Impreso Digital)
FechaInicioDesde (string, opcional): Desde Fecha de inicio del contrato (formato YYYY-MM-DD).
FechaInicioHasta (string, opcional): Hasta Fecha de inicio del contrato (formato YYYY-MM-DD).
FechaFinDesde (string, opcional): Desde Fecha de finalización del contrato (formato YYYY-MM-DD).
FechaFinHasta (string, opcional): Hasta Fecha de finalización del contrato (formato YYYY-MM-DD).
Estado_Contrato (string, opcional): Estado actual del contrato (ALTA, etc.).
Meses (string, opcional): Duración del contrato en meses (12,24,...etc).
Renovado (string, opcional): Indica si el contrato ha sido renovado.
IdTipoSuscripcion (int, opcional): Indica el tipo se suscripción, impresa, digital,impresa+digital etc.

Ejemplo de solicitud

GET /api/suscripciones/journey?TipoCliente=EMPRESA&Estado_Contrato=ALTA

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": [ { "ClienteID": 423, "NombreCompleto": "PEDRO PEREZ.", "RazonSocial": "LA CHAPINA,S.A.", "Telefonos": "3232-34343", "Correos": "micorreo@lachapina.com;;jperez@lachapina.com;", "TipoCliente": "EMPRESA", "Genero": null, "FechaNacimiento": null, "ContratoID": 454634, "TipoContratoID": 1, "TipoContrato": "Suscripción Estandar", "Producto": "Impreso", "FechaInicio": "2025-03-25T00:00:00", "FechaFin": "2026-03-24T00:00:00", "Estado_Contrato": "ALTA ", "Tarifa": "ADULTO MAYOR IMPRESO 1 AÑO + 1TL", "DuracionID": 40, "Meses": 12, "Duración": "12 MESES DE SERVICIO", "Renovado": "NO" },... ] }