Saltar al contenido principal

API – Guía de Primeros Pasos

API – Guía de Primeros Pasos​

Objetivo​

Esta guía te presenta los pasos esenciales para comenzar a consumir datos de la API de KSI.
Aprenderás cómo generar un token de autenticación, cómo enviar solicitudes autenticadas y cómo acceder a endpoints clave como indicadores de tráfico, métricas de colas y grupos de tiendas.

Requisitos​

Antes de realizar solicitudes a la API, asegúrate de contar con:

  • Una cuenta válida en la plataforma KSI
  • Permisos para generar tokens de API
  • Acceso a la documentación oficial de la API

👉 Documentación de la API:

1. Genera tu Token de API​

Para autenticarte en la API de KSI, debes generar un token Bearer.

Sigue estos pasos:

  1. Ve a “Mi Perfil” en la plataforma KSI
  2. Selecciona “Generar nuevo token”
  3. Copia el token y guárdalo de forma segura

Debes incluir tu token en el header HTTP de cada solicitud.

Ejemplo de Header de Autenticación​

Authorization: Bearer <tu_token_aquí>

Si el header está ausente o es inválido, la API devolverá un error de autenticación.

2. Ejemplos de Endpoints de la API​

A continuación se muestran ejemplos de rutas comúnmente utilizadas.

Obtener Grupos de Tiendas (locations_groups)​

Devuelve la lista de grupos de tiendas disponibles para tu cuenta.

GET https://app.ksivision.com/api/locations_groups

Indicadores de Tráfico​

Obtiene KPIs de tráfico para un grupo de tiendas específico, filtrados por rango horario y tamaño del bucket.

GET https://app.ksivision.com/api/locations_group/<locations_group_id>/kpis/traffic-total?timeBucket=1%20hour&fromTime=2024-10-01T00:00:00-03:00&toTime=2024-10-01T23:59:59-03:00&isEntrance=true&page=0&size=50

Parámetros:

  • timeBucket → intervalo de agregación
  • fromTime / toTime → timestamps en formato ISO 8601
  • isEntrance → filtrar por accesos
  • page y size → paginación

Obtener Configuración de Colas​

Devuelve las colas configuradas para un grupo de tiendas.

GET https://app.ksivision.com/api/locations_group/<locations_group_id>/bot-groups?bot_type=queueManagement

Indicadores de Colas​

Obtiene KPIs relacionados a colas, como tiempos de espera, longitud de cola o velocidad de atención.

GET https://app.ksivision.com/api/locations_group/<locations_group_id>/kpis/queue-management?timeBucket=1%20minutes&fromTime=2024-09-01T15:00:00-03:00&toTime=2024-09-01T15:05:00-03:00&page=0&size=50

3. Checklist Antes de Usar la API​

  • Has generado un token de API válido
  • Confirmaste acceso a la documentación
  • Probaste una solicitud simple (ej.: locations_groups)
  • Validaste los formatos de zona horaria y timestamps
  • Verificaste la paginación (page, size)

Soporte​

Si necesitas ayuda con autenticación, uso de endpoints o resolución de problemas:

📧 ksi.support@ksivision.com

El equipo de soporte de KSI puede ayudarte con asistencia técnica y mejores prácticas.