Clientes y Contratos API Documentación

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.

1. Obtener todos los clientes (Top 50)

GET /api/suscripciones/clientes

Devuelve todos los clientes sin aplicar filtros.

2. Filtrar por teléfono

GET /api/suscripciones/clientes?telefono={Telefono}

Busca clientes por su número de teléfono.

Parámetro:

• telefono: Número de teléfono del cliente (texto).

3. Filtrar por correo electrónico

GET /api/suscripciones/clientes?correo={Correo}

Busca clientes por su dirección de correo electrónico.

Parámetro:

• correo: Dirección de correo del cliente (texto).

4. Filtrar por NIT

GET /api/suscripciones/clientes?nit={NIT}

Busca clientes por su número de identificación tributaria (NIT).

Parámetro:

• nit: NIT del cliente (texto o número).

5. Filtrar por nombre del cliente

GET /api/suscripciones/clientes?nombreCliente={NombreCliente}

Busca clientes por su nombre completo.

Parámetro:

• nombreCliente: Nombre completo del cliente (texto).

7. Filtrar por ID del contrato

GET /api/suscripciones/clientes?contratoId={ContratoID}

Busca clientes por el identificador único del contrato.

Parámetro:

• contratoId: ID del contrato (entero).

8. Filtrar por ID del cliente

GET /api/suscripciones/clientes?clienteId={ClienteID}

Busca clientes por su identificador único.

Parámetro:

• clienteId: ID del cliente (entero).

9. Filtrar por combinación de parámetros

GET /api/suscripciones/clientes?telefono={Telefono}&correo={Correo}&nit={NIT}&nombreCliente={NombreCliente}

Permite combinar varios filtros en una única solicitud.

Ejemplo:

/api/suscripciones/clientes?correo=example@correo.com&nit=123456789

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": 123456, "NombreCompleto": "JUAN PEREZ", "RazonSocial": "LA EMPRESA, S.A", "Telefonos": "1234-4566 5444530", "Correos": "JPEREZ@GMAIL.COM;;prueba@laempresa.com.gt;", "DocumentoIdentificacion": "9999885880369", "NIT": "107702-9", "CodigoAX": "PL-CL-000873099", "TipoCliente": "INDIVIDUAL", "Genero": "Femenino", "FechaNacimiento": "1987-09-22T00:00:00", "ContratoID": 757453, "TipoContratoID": 9, "TipoContrato": "Suscripción Web", "Producto": "Digital", "FechaInicio": "2024-07-24T00:00:00", "FechaFin": "2025-08-23T00:00:00", "Estado_Contrato": "ALTA", "Tarifa": "DIGITAL NUEVA DELUX (CONTENIDO PL + E-PAPER) CA", "Nombre_Contrato": "JULIA DE PEREZ" },... ] }