Manual de Usuario - API de Reportes de Clipping

Bienvenido a la documentación oficial. Esta API le permite acceder a reportes detallados de monitoreo de medios de comunicación de forma programática e integrarlos directamente en sus sistemas.

🔐 Requisitos Previos

1. Obtener Credenciales

Contacte al equipo de soporte para iniciar el proceso:

• 📧 Email: soporte.clientes@diuniversalcheck.net
• 📞 Teléfono: +593 98 494 8766

El equipo de soporte le proporcionará:

• ID de Usuario (Ejemplo: 123)
• Token de Empresa (Ejemplo: ABC123XYZ456)

2. Herramientas Recomendadas

Para probar la API durante el desarrollo, recomendamos:

• Postman (Recomendado para principiantes)
• Insomnia
• cURL (Línea de comandos)

🔑 Autenticación (JWT)

La API utiliza JSON Web Tokens (JWT) para asegurar las peticiones. El proceso consta de dos pasos:

{
  "idUsuario": 123,
  "token": "ABC123XYZ456"
}

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjMiLCJuYW1laWQiOiIxMjMi...",
  "expiration": "2025-11-20T16:45:00",
  "idUsuario": 123,
  "codigoEmpresa": 5
}

Paso 2: Usar el Token en Peticiones

Todas las peticiones a los endpoints de reportes deben incluir el token obtenido en el header Authorization.

Formato del Header:

Authorization: Bearer {pegar_token_aqui}

Ejemplo:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

📡 Endpoints Disponibles

El recurso principal es el Reporte General. Puede acceder a él mediante POST (para consultas que requieran un cuerpo más complejo en el futuro).

{
  "pFechaInicial": "2025-11-20",
  "pFechaFinal": "2025-11-20",
  "pTipoMedio": "1,2,3"
}

📊 Parámetros y Valores Referenciales

Formato de Fechas

El formato requerido para todas las fechas es YYYY-MM-DD (ISO 8601).

Tipos de Medio (pTipoMedio)

Utilice los siguientes IDs para filtrar por tipo de medio. Puede combinar varios separándolos por comas (ej: 1,3).

Validaciones y Reglas de Negocio

• ✅ Rango Máximo: El periodo entre fecha inicial y final no puede exceder los 7 días.
• ✅ Lógica de Fechas: La fecha inicial no puede ser posterior a la fecha final.

💻 Ejemplos de Integración

A continuación, se presentan ejemplos prácticos en los lenguajes de programación más comunes.

cURL (Terminal)

1. Login y obtención del token

curl -X POST https://clp.diuniversalcheck.net/api/Auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "idUsuario": 123,
    "token": "ABC123XYZ456"
  }'

2. Obtener Reporte (Usando el token obtenido)

curl -X GET "https://clp.diuniversalcheck.net/api/v1/Reporte/reporte-general?pFechaInicial=2025-11-20&pFechaFinal=2025-11-20&pTipoMedio=1" \
  -H "Authorization: Bearer {pegar_token_aqui}"

JavaScript / Node.js (Fetch API)

// 1. Función para hacer Login
async function login() {
  const response = await fetch('https://clp.diuniversalcheck.net/api/Auth/login', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({
      idUsuario: 123,
      token: 'ABC123XYZ456' // SUS CREDENCIALES
    })
  });
  const data = await response.json();
  return data.token;
}

// 2. Función para Obtener Reporte
async function obtenerReporte(jwtToken) {
  const params = new URLSearchParams({
    pFechaInicial: '2025-11-20',
    pFechaFinal: '2025-11-20',
    pTipoMedio: '1'
  });
  
  const response = await fetch(
    `https://clp.diuniversalcheck.net/api/v1/Reporte/reporte-general?${params}`,
    {
      headers: {
        'Authorization': `Bearer ${jwtToken}` // Inyectar el token
      }
    }
  );
  return await response.json();
}

// Uso del flujo
const token = await login();
const reportes = await obtenerReporte(token);
console.log(reportes);

Python (Requests)

import requests

# 1. Login
def login():
    url = 'https://clp.diuniversalcheck.net/api/Auth/login'
    data = { 'idUsuario': 123, 'token': 'ABC123XYZ456' }
    response = requests.post(url, json=data)
    return response.json()['token']

# 2. Obtener Reporte
def obtener_reporte(jwt_token):
    url = 'https://clp.diuniversalcheck.net/api/v1/Reporte/reporte-general'
    headers = { 'Authorization': f'Bearer {jwt_token}' }
    params = {
        'pFechaInicial': '2025-11-20',
        'pFechaFinal': '2025-11-20',
        'pTipoMedio': '1'
    }
    response = requests.get(url, headers=headers, params=params)
    return response.json()

# Uso
token = login()
print(f"Token obtenido: {token[:20]}...")
reportes = obtener_reporte(token)
print(reportes)

(Nota: Se han omitido los ejemplos de C# y PHP por brevedad en esta vista, pero deberían seguir la misma estructura visual en la implementación final).

📋 Códigos de Respuesta HTTP

✅ Respuestas Exitosas

200 OK: La petición fue procesada correctamente. Devuelve un array JSON con los reportes.

[
  {
    "id": 1,
    "fecha": "2025-11-20T10:30:00",
    "medio": "Canal 1",
    "tipoMedio": "Televisión",
    "titulo": "Noticia de ejemplo",
    "contenido": "Resumen de la noticia...",
    "url": "https://ejemplo.com/noticia",
    ...
  }
]

❌ Respuestas de Error

⚠️ Límites y Restricciones (Rate Limiting)

Para asegurar la estabilidad del servicio, la API implementa límites de uso estrictos.

¿Qué pasa si excedo el límite?

Recibirá una respuesta 429 Too Many Requests. El cuerpo de la respuesta indicará cuánto tiempo debe esperar.

{
  "error": "Límite de peticiones excedido",
  "message": "Has superado el límite. Intenta nuevamente en 45 segundos.",
  "retryAfter": 45
}

🔧 Solución de Problemas Comunes

📞 Soporte y Preguntas Frecuentes

FAQ Rápido