Guía de API web de TMAS: exportación y gestión de datos
Exportación de tráfico
Table of Contents
Descripción general
Este artículo explica cómo usar el sistema de exportación bajo demanda de API web de SMS para acceder y exportar rápidamente datos de tráfico TMS desde una interfaz web en formato XML. La API WEB es una herramienta poderosa ya que permite el acceso directo e instantáneo a los datos de la base de datos sin necesidad de una exportación personalizada o generación de informes. Una vez exportados, los datos se pueden personalizar fácilmente para permitir la integración con una multitud de herramientas, software o bases de datos de terceros.
Se encuentra en Administrar ubicaciones bajo administración, se debe seleccionar Encadenar / Facturar a (Nivel superior del árbol de ubicaciones).
El usuario debe tener el tipo de permiso Cadena y Usuario y apuntar al nivel superior del árbol de ubicación para poder acceder.
MÁS INFORMACIÓN >> Sobre la gestión de permisos de usuario
Cómo crear una CLAVE API | |
|
Edición y eliminación de claves API existentes
- Haga clic en el ícono del lápiz junto a la fila de la clave API para editar (utilice para deshabilitar al desmarcar el permiso)
- Haga clic en el ícono de la papelera al lado de la fila de la clave API para eliminar
*NOTA* Las claves eliminadas no se pueden volver a usar.
Uso de la(s) clave(s) API para el tráfico de llamadas
Se llama a la API WEB mediante una URL estándar personalizada para su empresa, ubicación, rango de fechas, intervalo, filtro de horario comercial y tipo de exportación. La estructura básica de la URL se muestra en el siguiente enlace:
https://www.smssoftware.net/tms/manTrafExp?fromDate= [1] &toDate= [2] &interval= [3] &hours= [4] &reqType= [5] & apiKey= [6 ] & ID de ubicación = [7 ] & ID de grupo = [8]
Cada uno de los números resaltados entre paréntesis representa un área que se puede personalizar:
- [1] La fecha de inicio del intervalo de fechas desde el que desea exportar los datos. El formato completo es MM/dd/YYYY-HH|mm pero HH y mm no son obligatorios y pueden ignorarse si se selecciona tráfico solo por horas o por día. agregar I al final de fromDate devolverá el tráfico para las ubicaciones donde el día estuvo incompleto. Ejemplo: si una ubicación que acaba de abrir solo comenzó a informar tráfico en la tarde del día, no aparecerá a menos que esté al final de fromDate=02/26/2020 i
- [2] La fecha final del intervalo de fechas desde el que desea exportar los datos. El formato es exactamente el mismo que el de la fecha de inicio descrita anteriormente.
-
[3] El intervalo en el que se generarán los datos de tráfico.
- 0 = Intervalo no aplicable (Tráfico sin procesar)
- 15 = 15 minutos
- 30 = 30 minutos
- 60 = Por hora
- 1440 = Diario
- 10080 = Semanal
- 32767 = Información del panel de ocupación
-
[4] Si tiene un horario comercial definido para su empresa en TMAS, puede usar esta opción para filtrar fácilmente los rangos de horas. Nota* Se aplica SOLO a Tipo=T* con intervalo >0
- 0 = Usar horario comercial (si se especifican horas en la Llamada API, esto se anula a 1)
- 1 = Utilice únicamente las horas proporcionadas en los campos [1] e ignore la hora de finalización en [2]; sin embargo, la hora de finalización aún debe estar presente.
- Se utiliza mejor para llamadas de tráfico en tiempo real para actualizar datos y no para llamar a datos históricos.
- 2 = Horas personalizadas durante varios días: use las horas proporcionadas en los campos [1] y [2]
- Usa las horas como un rango
-
[5] El tipo de exportación de la exportación de datos.
-
td = Datos de tráfico (Devuelve un total resumido del tráfico para la ubicación y las sububicaciones donde la ubicación es principal y donde los sensores del dispositivo están marcados como visibles en los informes TMAS) . Los valores devueltos incluyen (TrafficData, TrafficValue, StoreID).
-
tdd = Datos de tráfico recursivos o datos de tráfico sin procesar - (La salida es similar a TD, sin embargo, muestra cada ubicación individual sumada y no los totales por cadena, distrito o región)
- Los valores devueltos incluyen (TrafficData, TrafficValue, StoreID).
-
tdl = Datos de tráfico recursivo por dispositivo (el intervalo debe establecerse en 15 o más)
- Los valores devueltos incluyen (TrafficData, TrafficValue, StoreID|Etiqueta del dispositivo). Nota: Este tipo de salida NO considera los dispositivos_sensores marcados como NO visibles en los informes y devuelve la suma del tráfico de todos los dispositivos activos asignados a una ubicación.
-
tds = Datos de tráfico recursivos por sensores (el intervalo debe establecerse en 15 o más)
- Los valores devueltos incluyen (TrafficData, TrafficValue, StoreID|Sensor Label|Unique Sensor ID) Nota: este tipo de salida NO considera los sensores marcados como NO visibles en los informes y devuelve sumas individuales de todos los sensores activos asignados a una ubicación. Ver tipo=tdv
-
tdv = Datos de tráfico recursivos Datos de tráfico recursivos por sensores (el intervalo debe establecerse en 15 o más)
- Los valores devueltos incluyen (TrafficData, TrafficValue, StoreID|Sensor Label|Unique Sensor ID) Nota: este tipo de salida tiene en cuenta los sensores marcados como NO visibles en los informes y devuelve sumas individuales de todos los sensores activos asignados a una ubicación. Consulte type=tds si desea incluir sensores marcados como NO visibles en los informes de la llamada.
-
tdo = Información del panel de ocupación con recuentos ajustados
- Los valores devueltos incluyen (storeId, color, occDate, occLevelNow, occLevel-1, occLevel-2, occLevel-3, occLevel-4, occLevelMax, occLevelPct. Nota: se debe usar Interval=32767 en la llamada
-
tdor = Información sin procesar del panel de ocupación con recuentos no ajustados
- Los valores devueltos incluyen (storeId, color, occDate, occLevelNow, occLevel-1, occLevel-2, occLevel-3, occLevel-4, occLevelMax, occLevelPct. Nota: se debe usar Interval=32767 en la llamada
-
tdd = Datos de tráfico recursivos o datos de tráfico sin procesar - (La salida es similar a TD, sin embargo, muestra cada ubicación individual sumada y no los totales por cadena, distrito o región)
-
qd = Datos de cola
- qdd = recursivo
-
qdc = últimos tres
- También puede agregar & queuename= para especificar un solo nombre de cola
-
dw = Datos de la vivienda
- dwc = Agregado
-
td = Datos de tráfico (Devuelve un total resumido del tráfico para la ubicación y las sububicaciones donde la ubicación es principal y donde los sensores del dispositivo están marcados como visibles en los informes TMAS) . Los valores devueltos incluyen (TrafficData, TrafficValue, StoreID).
- [6] apiKey= proporcionada por la aplicación TMAS
- [7] El ID de ubicación TMAS de la ubicación desde la que desea exportar los datos de tráfico. Puede usar el tipo de ubicación Cadena, Región o ID de nivel de tienda. Se encuentra en la sección administrar ubicaciones en configurar.
-
[8] groupid= (opcional) (Devuelve valores solo para ubicaciones que forman parte del grupo. Cuando se combinan con un distrito o región, los valores devueltos son solo ubicaciones que forman parte de ese distrito o región y miembros del grupo).
-
El ID de grupo se puede encontrar en la función de gestión de grupos.
- Seleccione el grupo creado previamente en el cuadro desplegable de administración de grupos
- Haga clic en el botón editar
- ID está resaltado en la imagen de abajo.
-
El ID de grupo se puede encontrar en la función de gestión de grupos.
Limitaciones de llamadas API
• El rango de fechas no puede exceder un mes.
• La API web de TMAS tiene un límite de frecuencia de una llamada cada dos segundos.
• Para acceder a los datos de tráfico en intervalos de un minuto o menos, es necesario configurar Fast Push para la cadena en TMAS Nota: Esto SÓLO está disponible con el paquete LIVE DATA TMAS.
Ejemplos en vivo (enlace de demostración)
Corrección de errores
Preguntas más frecuentes
P: ¿ Se requiere un rango de fechas al hacer una llamada de ocupación?
R: No , no se requiere para llamadas de Type=tdo o Type=tdor ya que se devolverá occDate= indicando cuándo se realizó la llamada. Todos los demás tipos de llamadas para el intervalo de fechas (hasta/desde) son obligatorios.
_______
P: ¿ Cómo afecta el parámetro "horas" a la ocupación?
R: Los mostradores reportan 24/7 a TMAS y los conteos son filtrados por horario comercial, para evitar la inclusión de conteo de personas que llegan antes y después de la apertura.
- 0 = Usar horario comercial (si se especifican horas en la Llamada API, esto se anula a 1)
- 1 = Usar solo las horas proporcionadas en los campos [1] e ignorar la hora de finalización en [2]; sin embargo, la hora de finalización aún debe estar presente.
- Se utiliza mejor para llamadas de tráfico en tiempo real para actualizar datos y no para llamar a datos históricos.
- 2 = Horas personalizadas durante varios días: use las horas proporcionadas en los campos [1] y [2]
- Usa las horas como un rango
_______
P: Comprensión: occLevelNow, occLevel-1, occLevel-2, occLevel-3, occLevel-4, occLevelMax, occLevelPct
A:
occLevelNow = Valor de ocupación a la hora de la llamada
occLevel-1, occLevel-2, occLevel-3, occLevel-4 = Últimos 4 intervalos de ocupación para tendencias.
occLevelMax = Umbral de ocupación máxima establecido en TMAS para la ubicación.
occLevelPct = occLevelNow/occLevelMax para el porcentaje de ubicación utilizado en función del umbral de ocupación.
_______
P: ¿ Cuál es la diferencia entre ajustado y no ajustado?
R: Type=TDO son los valores brutos de ocupación no ajustados sin alteraciones manuales a lo largo del día,
Type=TDOR incluye cualquier ajuste manual realizado a lo largo del día (se recomienda este tipo) .
Solución de problemas
Problema: Error 400 - Sitio web no encontrado
Solución: Verifique la URL de la API: asegúrese de que tenga el formato correcto según el ejemplo de este artículo y que tenga la clave de API completa generada a partir de la aplicación TMAS.
_____________________________________________________
Problema: los datos de tráfico muestran 0
Solución: asegúrese de que haya datos para este intervalo de fechas ejecutando un informe de totalización en TMAS
_____________________________________________________
Problema: los datos de tráfico muestran valores de -1.0
Solución: -1.0 Los datos de tráfico devueltos indican que el contador no informó tráfico para este intervalo de tiempo. Verifique la fecha / hora solicitada y/o Verifique si el hardware del contador funcionó correctamente durante este tiempo y siga el proceso de resolución de problemas correspondiente.
_____________________________________________________
Problema: mensaje de error: "Los parámetros de fecha dados en (RANGO DE FECHAS) tienen un formato incorrecto, están en el futuro o no tienen sentido para el sistema"
Solución:
- ✓ Asegúrese de haber ingresado una fecha válida y que el último intervalo no sea en el futuro.
- ✓ Asegúrese de que el rango de fechas no exceda un mes
_____________________________________________________
Problema: Mensaje de error: “Los parámetros (intervalo y/u horas) dados no respetan los valores autorizados”
Solución: asegúrese de que el intervalo sea válido, como se explica en la sección Uso
_____________________________________________________
Problema: mensaje de error: "Un problema de base de datos subyacente impide que el servidor muestre datos, comuníquese con el administrador de la base de datos".
Solución: Verifique que el formato de su intervalo de fechas (DESDE Y HASTA) sea MM/DD/AAAA en la URL de la llamada a la API
- Incorrecto: &fromDate=6/12/18&toDate=6/12/18
- Correcto: &fromDate=6/12/2018&toDate=6/12/2018
_____________________________________________________
Problema: Mensaje de error: "La ubicación dada no tiene ninguna cola".
Solución: asegúrese de que la ubicación que ingresa esté configurada con funciones de ocupación
_____________________________________________________
Problema: Mensaje de error: "Acceso prohibido"
Solución: Verifique que la clave API y/o el ID de ubicación sean correctos y existan
_____________________________________________________