Webservice Documentación

15/11/23, 14:03 Webservice documentación
WEBSERVICE
Índice
1. Introducción
2. Acceso
3. Funciones
autenticacion
token
balizas
get_all_balizas
estados
get_eventos_posiciones
tacografos_estados
tacografos_normativas
conductores
get_conductores
informes
get_alertas
get_distancia_tiempo_dia
get_ruta
get_tacografos
get_ultima_posicion
get_ultima_posicion_balizas
pdis
get_pdis
usuario
get_all_vehiculos
get_carpetas
vehiculos
get_inputs
set_outputs
set_vehiculo_en_carpeta
4. Cliente y ejemplos
Ejemplo de conexión mediante navegador
Ejemplo conexión mediante PHP
Ejemplo conexión mediante Python
5. Versiones
https://profifleet.my-tutor.es/descargas/webservice/webservice-documentacion.php 1/26
1.- Introducción
Este documento contiene las características de funcionamiento del webservice de Gestión de Flotas. El contenido se estructura de la siguiente forma:
Acceso: autenticación de usuarios mediante sus claves.
Funciones: diferentes acciones disponibles para obtener información.
Cliente y ejemplos: muestra ejemplos para poder usar el webservice.
Versiones: histórico de versiones de las diferentes implementaciones realizadas.
El resultado de todas las peticiones es un archivo en formato json.
Se puede ver un ejemplo mediante nuestro cliente webservice en la web https://profifleet.my-tutor.es:803/api , y accediendo a la función autenticacion/token y el
botón try it out. Se genera una conexión de login donde pide los datos de usuario y clave.
Los datos de usuario y clave son de tipo webservice creados en la página https://profifleet.my-tutor.es por el usuario administrador.
A partir de este momento, una vez el login es válido, se puede acceder a las diferentes funciones disponibles del webservice (consultar la sección: Funciones:
diferentes acciones disponibles para obtener información).
2.- Acceso: autenticación de usuarios mediante sus claves
Para realizar la conexión al webservice hay que acceder mediante el link: https://profifleet.my-tutor.es:803/api
Mediante una conexión BA (Basic authentication o autenticación simple) se envía el usuario y la clave en un string con Base64 en el header:
Concatenar usuario y clave en un string: “usuario:clave”
Codificar el string anterior mediante Base64 (https://en.wikipedia.org/wiki/Base64).
El valor generado mediante los pasos anteriores es parecido a esto: QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Por ejemplo, si el usuario es Aladdin y la clave open sesame el valor será el siguiente:
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Para más información consultar: https://en.wikipedia.org/wiki/Basic_access_authentication
La forma más recomendada y segura de hacer la conexión y autenticación con el servidor webservice es el uso del token en todas las peticiones. Primero, se
genera un token mediante el usuario y clave, y a continuación, con ese token, se usa para hacer cualquier petición a las diferentes funciones:
Para obtener el token se deberá de ejecutar la función autenticacion/token.
Y se debería de enviar el código generado mediante usuario:clave en Base64, como en el paso anterior (QWxhZGRpbjpvcGVuIHNlc2FtZQ==).
El resultado del token es parecido al siguiente valor:
eyJhbGciOiJIUzI1NiIsImV4cCI6MTQ0ODQ0NTE5OSwiaWF0IjoxNDQ4NDQ0NTk5fQ.ey
JpZCI6MX0.CJZ_sVTHhrxipuJrtcZqF8OJM68Lsc9Ujc4B5jL38Rc
La duración de la sesión es de 15 días.
Para enviar el token, se tiene hacer mediante una conexión BA pero en vez de enviar el usuario y la contraseña enviamos solamente el token:
Concatenar token en un string: "token:"
Codificar el string anterior mediante Base64 (https://en.wikipedia.org/wiki/Base64).
Siguiendo el ejemplo del token anterior, se enviaría de la siguiente forma:
Authorization: Basic ZXlKaGJHY2lPaUpJVXpJMU5pSXNJbVY0Y0NJNk1UUTBPRFEwTlRFNU9Td2lhV0YwSW

pveE5EUTRORFEwTlRrNWZRLmV5SnBaQ0k2TVgw
LkNKWl9zVlRIaHJ4aXB1SnJ0Y1pxRjhPSk02OExzYzlVamM0QjVqTDM4UmM6
3.- Funciones: acciones disponbiles para obtener información

Las funciones se distribuyen en diferentes bloques. Cada bloque tiene diferentes funciones donde se especifican como obtener la información y el formato de su
resultado.
autenticacion
token: Obtención del token y acceso al webservice.
logoutElimina el token y restringe acceso al webservice.
balizas
get_all_balizas
estados
get_eventos_posicionesObtener la lista de eventos de cada posición que puede enviar el GPS.
tacografos_estadosIndica el código y estado del tacógrafo
tacografos_normativasIndica el código y estados de la normativa del tacógrafo.
conductores
get_conductoresObtener la lista de conductores del usuario
informes
get_alertas: Muestra las alertas de los vehículos seleccionados (opcional, por defecto se obtienen todos los vehículos o se le puede enviar un listado de
vehículos para obtener específicamente esos vehículos).
get_distancia_tiempo_dia: Muestra la distancia total en kms y el tiempo total en segundos, para cada día, entre una fecha de inicio y una fecha de fin de
los vehículos seleccionados (opcional, por defecto se obtiene todos los vehículos o se le puede pasar vehículos para obtener específicamente esos
vehículos).
get_ruta: Muestra la ruta entre una fecha de inicio y una fecha de fin de los vehículos seleccionados (limitado a 20 vehículos). El rango de fechas está
limitado a 30 días.
get_tacografosMuestra el informe de tacógrafo entre una fecha de inicio y una fecha de fin de los vehículos seleccionados. El rango de fechas está
limitado a 30 días
get_ultima_posicion: Muestra la última posición de los vehículos seleccionados (opcional, por defecto se obtienen todos los vehículos o se le puede enviar
un listado de vehículos para obtener específicamente esos vehículos).
pdis
get_pdis: Obtener la lista de pdis del usuario
usuario
get_all_vehiculos: Muestra el listado de todos los vehículos del usuario ordenados por carpeta y vehículo.
get_carpetas: Muestra el listado de todas las carpetas del usuario.
vehiculos
get_inputs: Obtiene la configuración de los cables de cada dispositivo con su evento correspondiente.
set_outputsActiva o desactiva durante unos segundos un cable output del dispositivo GPS.
set_vehiculo_en_carpeta: Modifica la carpeta del vehículo quitándolo de la que está y añadiendolo en la nueva.
A continuación se muestra el listado de funciones y un resumen de su uso:
autentication
token
Obtención del token y acceso al webservice
request headers :
Descripción Tipo Observaciones
Authorization string Basic Base64(token) (ver la sección acceso: autenticación de usuarios mediante sus claves)
response :
duration integer Valor en segundos. Duración de la sesión
token string Identificador de autenticación para realizar peticiones
logout
Elimina el token y restringe acceso al webservice
request headers :
response :
message string Descripción del estado ('Ok.', 'Token Not Found.' )
balizas
get_all_balizas
Lista de todas las balizas del usuario
request headers :
response :
id_baliza integer Id de la baliza
identificador string Texto identificativo del vehículo. Puede ser la matrícula, código, conductor..
referencia string Descripción impresa en el exterior de la baliza
grupo string Carpeta para agrupar las balizas (opcional)
tipo integer Indica el tipo de baliza: remolque, pdi o conductor
estados
get_eventos_posiciones
Obtener la lista de eventos de cada posición que puede enviar el GPS.
request headers :
response :
id_estado integer Código del estado
descripcion string Descripción del estado
color datetime Valor hexadecimal del código de color
tacografos_estados
Indica el código y estado del tacógrafo
request headers :
response :
tacografos_normativas
Indica el código y estados de la normativa del tacógrafo.
request headers :
response :
conductores
get_conductores
Obtener la lista de conductores del usuario.
request headers :
response :
id_conductor integer Código del conductor
identificador string Descripción del conductor
nombre string Nombre del conductor
apellidos string Apellidos del conductor
telefono string Teléfono del conductor
email string Email del conductor
cargo string Cargo del conductor
fecha_insert datetime Fecha de la creación del conductor
código1 string Código único del ibutton, rfid, tacógrafo (DNI)...
informes
get_alertas
Muestra las alertas de los vehículos seleccionados (opcional, por defecto se obtienen todos los vehículos o se le puede enviar un listado de vehículos
para obtener específicamente esos vehículos)
request headers :
request body :
fecha_inicio datetime Formato: aaaa-mm-dd
fecha_fin datetime Formato: aaaa-mm-dd
ids_vehiculos string Lista vehículos separados por comas. Opcional (por defecto se obtiene todos los vehículos)
fecha_inicio_servidor datetime Filtro por la fecha de inserción de las alertas en el servidor. Formato: aaaa-mm-dd hh:mm:ss
fecha_fin_servidor datetime Filtro por la fecha de inserción de las alertas en el servidor. Formato: aaaa-mm-dd hh:mm:ss
response :
id_vehiculo integer
fecha_hora datetime Formato: aaaa-mm-dd hh:mm:ss. UTC usuario.
latitud float Formato: -41.000000
longitud float Formato: -2.000000
altitud integer Indica la distancia desde el mar en metros
velocidad integer Indica la velocidad gps en km/h
orientacion integer Indica la dirección del vehículo en grados (º). Norte: 0; Este: 90; Sur: 180; Oeste: 270.
satelites integer Indica la cobertura GPS.
estado string Descripción del evento: Arrancada, parada, ...
codigo_evento integer Código de la descripción del evento: Arrancada: 1; Parada: 3, ...
tipo_evento integer Código cuando se produce la alerta: Siempre, Dentro/Fuera de zona, Dentro/fuera de horario, ...
get_distancia_tiempo_dia
Muestra la distancia total en kms y el tiempo total en segundos, para cada día, entre una fecha de inicio y una fecha de fin de los vehículos seleccionados
(opcional, por defecto se obtiene todos los vehículos o se le puede pasar vehículos para obtener específicamente esos vehículos).
request headers :
request body :
fecha_inicio date Formato: aaaa-mm-dd
fecha_fin date Formato: aaaa-mm-dd
response :
id_vehiculo integer
fecha date Formato: aaaa-mm-dd
distancia float Valor en kms. Distancia total
tiempo integer Valor en segundos. Tiempo total
get_jornadas_navision
Obtener el informe de las jornadas para exportación de navisión
request headers :
request body :
fecha_inicio date Formato: aaaa-mm-dd
fecha_fin date Formato: aaaa-mm-dd
empresa string Código de empresa para filtrar los datos
response :
fecha date Formato: aaaa-mm-dd
recurso string Descripción del vehículo
obra string Obra en la que se ha realizado la cantidad
cantidad float Valor en kms/horas
agr_coste string
actividad string Ejemplo: ASF-01
empresa string Ejemplo: 024
get_ruta
Muestra la ruta entre una fecha de inicio y una fecha de fin de los vehículos seleccionados (limitado a 20 vehículos). El rango de fechas está limitado a 30
días.
request headers :
request body :
fecha_inicio datetime Formato: aaaa-mm-dd hh:mm:ss
fecha_fin datetime Formato: aaaa-mm-dd hh:mm:ss
ids_vehiculos string Código de vehículos separados por comas (si sobrepasa de 20 vehículos sólo podrá seleccionar 1 día)
estado string Filtro por el estado separados por comas.
response :
id_vehiculo integer
Indica el valor de la sonda 1 de temperatura en grados (ºC). Si no dispone de este valor aparecerá el valor
temperatura1 float
null
temperatura2 float
null
temperatura3 float
null
input2 boolean Indica el valor del cable 2 (true: el cable está conectado; false: el cable está desconectado)
Indica el % de la posición del pedal de aceleración obtenido por el CANbus. Si no dispone de este valor
acelerador integer
aparecerá el valor null
contador_kms_canbus float Indica el contador de kms obtenidos por el CANbus. Si no dispone de este valor aparecerá el valor null
contador_kms_gps float Indica el contador de kms obtenidos por el GPS
contador_litros float Indica el contador de litros del vehiculo.
Indica el estado del freno de mano (0: no fijado; 1: fijado; 2: no definido; 3: no definido) obtenido por el
freno_mano integer
CANbus. Si no dispone de este valor aparecerá el valor null
rpm integer Indica las rpms del motor obtenido por el CANbus. Si no dispone de este valor aparecerá el valor null
Indica la temperatura ambiente (ºC) obtenido por el CANbus. Si no dispone de este valor aparecerá el valor
t_ambiente float
null
Indica la temperatura del motor (ºC) obtenido por el CANbus. Si no dispone de este valor aparecerá el valor
t_motor float
null
Fecha del servidor en la que se ha insertado la posición del GPS. Formato: aaaa-mm-dd hh:mm:ss. UTC+01
fecha_insert_servidor datetime
Madrid
id_pdi integer Código del PDI (ver pdis/get_pdis)
id_conductor integer Código del conductor (ver conductores/get_conductores)
estado_conductor String Indica el estado del conductor (conduciendo, descansando, trabajando o disponible)
estado_tarjeta Boolean Indica si la tarjeta está activada/desactivada en el tacógrafo
tiempo_normativa String Indica las conducciones y descansos
consumo_carga_kw float Indica el consumo de la batería(Kw)
consumo_carga_xciento float Indica el tanto por ciento consumo de la batería (%)
tacografo_estado_id integer Indica el id estado del tacógrafo. (ver estados/tacografos_estados)
tacografo_estado_desc string Indica la descripción del estado del tacógrafo (ver estados/tacografos_estados)
tacografo_tarjeta boolean Indica si la tarjeta está insertada (true) o no (false)
tacografo_tiempo_normativa_desc string Indica el tiempo de normativa del tacógrafo (ver estados/tacografos_normativas)
estado_maquina float Estado máquina
get_tacografos
Muestra el informe de tacógrafo entre una fecha de inicio y una fecha de fin de los vehículos seleccionados. El rango de fechas está limitado a 30 días
request headers :
request body :
fecha_inicio datetime Formato: aaaa-mm-dd hh:mm:ss
fecha_fin datetime Formato: aaaa-mm-dd hh:mm:ss
ids_vehiculos string Código de vehículos separados por comas (si sobrepasa de 20 vehículos sólo podrá seleccionar 1 día)
response :
id_vehiculo integer
fecha date Formato: aaaa-mm-dd hh:mm:ss. UTC usuario.
estado_id integer Indica el id estado del tacógrafo. (ver estados/tacografos_estados)
estado_desc string Indica la descripción del estado del tacógrafo (ver estados/tacografos_estados)
tarjeta boolean Indica si la tarjeta está insertada (true) o no (false)
tiempo integer Indica el tiempo en segundos durante ese estado.
get_ultima_posicion
Muestra la última posición de los vehículos seleccionados (opcional, por defecto se obtienen todos los vehículos o se le puede enviar un listado de
vehículos para obtener específicamente esos vehículos).
request headers :
request body :
Por defecto false (no mostrará valor en el odómetro para aumentar el rendimiento). En el caso de ser true
mostrar_odometro boolean
mostrará el odómetro pero aumentará el tiempo de ejecución
Por defecto false (no mostrará valor en el horómetro para aumentar el rendimiento). En el caso de ser true
mostrar_horometro boolean
mostrará el horómetro pero aumentará el tiempo de ejecución
fecha_inicio datetime Formato: aaaa-mm-dd hh:mm:ss Por defecto 0000-00-00 00:00:00
fecha_fin datetime Formato: aaaa-mm-dd hh:mm:ss Por defecto fecha de hoy
response :
id_vehiculo integer
temperatura1 float
null
temperatura2 float
null
temperatura3 float
null
odometro float Indica el total de kms que tiene el vehículo. En el caso de 'mostrar_odometro' sea false, mostrará null.
horometro integer Indica el total de segundos que tiene el vehículo. En el caso de 'mostrar_horometro' sea false, mostrará null.
Madrid
id_conductor integer Código del conductor (ver conductores/get_conductores)
filtro_horario_posicion boolean Indica si se está aplicando el filtro de horario (true) para la posición.
bateria_dispositivo float Voltaje batería del dispositivo en milivoltios (mV)
bateria_dispositivo_xciento float Porcentaje de batería restante del dispositivo.
bateria_vehiculo float Voltaje batería del vehículo en milivoltios (mV).
bateria_xciento float Porcentaje de batería restante del vehículo.
autonomia_km float Autonomía restante del vehículo en km.
salud_bateria_xciento float Porcentaje de salud de la batería (a más degradación menos salud).
peso float Peso del vehículo
estado_maquina float Estado máquina
Muestra la última posición de los balizas seleccionados (opcional, por defecto se obtienen todas las balizas o se le puede enviar un listado de balizas para
obtener específicamente esas balizas).
request headers :
request body :
ids_balizas string Lista balizas separadas por comas. Opcional (por defecto se obtiene todos las balizas)
fecha_inicio datetime Formato: aaaa-mm-dd hh:mm:ss Por defecto 0000-00-00 00:00:00
fecha_fin datetime Formato: aaaa-mm-dd hh:mm:ss Por defecto fecha de hoy
response :
id_baliza integer Id de la baliza
Madrid
pdis
get_pdis
Obtener la lista de pdis del usuario
request headers :
response :
latitud string Formato: -41.000000
longitud string Formato: -2.000000
direccion string
radio integer Distancia en metros que delimita una área circular. En el caso de ser polígono, el valor será null
descripcion string
color string Valor hexadecimal que indica el color
icono string Indica el tipo de icono
grupo string
poligono boolean Indica si es o no un polígono (true/false), en el caso de ser polígono, el radio será null.
coordenadas_poligono string Indica un listado de coordenadas del polígono
usuario
get_all_vehiculos
Muestra el listado de todos los vehículos del usuario ordenados por carpeta y vehículo.
request headers :
response :
carpeta string La carpeta donde se encuentra el vehículo.
id_carpeta integer Código de la carpeta.
id_vehiculo integer
tipo string Tipo del vehículo: turismo, moto, camión..
matricula string
marca string
modelo string
bastidor string
tiene_canbus boolean Indica si tiene canbus (true: tiene canbus; false: no tiene canbus)
tiene_tacografo boolean Indica si tiene tacógrafo (true: tiene tacógrafo; false: no tiene tacógrafo)
imei_all string Indica el imei del dispositivo
imei string Indica el imei que envía en la trama el dispositivo (normalmente coincide con imei_all
serie string Indica el número de serie del dispositivo
get_carpetas
Muestra el listado de todas las carpetas del usuario.
request headers :
response :
id_carpeta integer Código de la carpeta.
carpeta string 'Descripción de la carpeta donde se encuentra el vehículo.'
vehiculos
get_inputs
Obtiene la configuración de los cables de cada dispositivo con su evento correspondiente.
request headers :
request body :
response :
cable integer Indica el número de cable (1,2,3,4,5). El cable 1 está reservado para la ignición.
activado boolean Indica el estado del cable (true: cable on; false: cable off).
id_estado integer Código del evento. (1: arrancada; 3: parada, ...)
fecha_update datetime Fecha de la última modificación. Formato: aaaa-mm-dd hh:mm:ss.
id_vehiculo integer
set_outputs
Activa o desactiva durante unos segundos un cable output del dispositivo GPS.
request headers :
request body :
Lista vehículos separados por comas. Opcional (por defecto se obtiene todos los vehículos). (ver
ids_vehiculos integer
usuario/get_all_vehiculos)
cable integer Indica el número de cable (1,2,3,4,5).
activado boolean Indica el estado del cable (true: cable on; false: cable off).
tiempo integer Tiempo en segundos que permanece activo el output. (por defecto X segundos)
response :
message string Descripción del estado ('Ok.', ... ).
set_vehiculo_en_carpeta
Modifica la carpeta del vehículo quitándolo de la que está y añadiendolo en la nueva.
request headers :
request body :
Lista vehículos separados por comas. Opcional (por defecto se obtiene todos los vehículos). (ver
ids_vehiculos string
usuario/get_all_vehiculos)
id_carpeta_dest integer Código de la nueva carpeta. Si es 0, el vehículo no tendrá carpeta.
response :
message string Descripción del estado ('Ok.', ... ).
4.- Cliente y ejemplos

Ejemplo de conexión mediante navegador
Para ejecutar cualquier función disponible de nuestro webservice, simplemente se selecciona mediante el botón GET y pulsando el botón try it outpara ejecutarlo:
Ejemplo 1: establecer conexión con el servidor
Ejemplo 2: mostrar el listado de todos los vehículos del usuario.
Ejemplo 1: establecer conexión con el servidor
Pulsar en el botón GET /autenticacion/token/:
Aparecerá un formulario de acceso para introducir los datos de usuario y contraseña:
La respuesta que se obtiene después de pulsar el botóntry it out:
El valor token será usado para hacer el resto de conexiones (documentado en la sección de acceso: autenticación de usuarios mediante sus claves)
eyJhbGciOiJIUzI1NiIsImV4cCI6MTQ0ODQ0NTE5OSwiaWF0IjoxNDQ4NDQ0NT
k5fQ.eyJpZCI6MX0.CJZ_sVTHhrxipuJrtcZqF8OJM68Lsc9Ujc4B5jL38Rc
Ejemplo 2: mostrar el listado de todos los vehículos del usuario.
Pulsar en el botón GET /usuario/get_all_vehiculos/:
La respuesta que se obtiene después de pulsar el botóntry it out:
El formato de respuesta es un archivo json donde aparecen todos los vehículos del usuario y sus datos correspondientes como identificador, matrícula, modelo...
Ejemplo de conexión mediante PHP

<?php
////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////
//ACCESO: datos necesarios para el acceso
//Usuario y clave
$usuario = 'usuario';
$clave = 'clave';
//String concatenado de 'usuario:clave'

$userpass = $usuario.':'.$clave;
//Codifica el usuario y clave en base64

$user_base64 = base64_encode($userpass);
////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////
//AUTENTICACION: petición para obtener el token
// Definir los Headers con el TOKEN

$opt = array(
'http' => array(
'method' => "GET",
'header' => array('Authorization: Basic '.$user_base64)
)
);
$context = stream_context_create($opt);
//Petición al Web Service y convierte el JSON devuelto en un array

$url ='https://profifleet.my-tutor.es:803/api/autenticacion/token';
$json = file_get_contents($url, false, $context);
$respuesta = json_decode($json,true);
// Codifica el token recibido a base64 añadiendole ':' al final

$token64 = base64_encode($respuesta['token'].':');
////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////
//GET_ALL_VEHICULOS: obtener los vehículos
// Definir los Headers con el TOKEN64

$opt = array(
'http' => array(
'method' => "GET",
'header' => array("Authorization: Basic ".$token64)
)
);
$context = stream_context_create($opt);
// Petición al Web Service y convierte el JSON devuelto en un array

$url ='https://profifleet.my-tutor.es:803/api/usuario/get_all_vehiculos';
$json = file_get_contents($url,false,$context);
$respuesta = json_decode($json,true);
// Ejemplo de mostrar el primer ID de vehiculo

echo($respuesta[0]['id_vehiculo']);
?>
Ejemplo de conexión mediante Python
#!/usr/bin/python
# -*- encoding: UTF8 -*-
import base64, urllib2

import sys, json
servidor = 'https://profifleet.my-tutor.es:803'
usuario_clave = 'usuario:clave'
def peticion_get(url, headers = None):

"""
Realiza la peticion GET a una URL y devuelve el JSON parseado en una lista de diccionarios.
@param url: URL a la que realizar la petición GET
@param headers: headers a enviar con la petición
@return: lista de diccionarios
"""
peticion = urllib2.Request(url, headers = headers)
respuesta_peticion = urllib2.urlopen(peticion)
body_respuesta = respuesta_peticion.read()
body_respuesta_pars = json.loads(body_respuesta)
return body_respuesta_pars
if __name__ == "__main__":
# Codifica el usuario y la contraseña en base64
base64_u = base64.b64encode(usuario_clave)
# Obtiene el token
respuesta_token = peticion_get(servidor + '/api/autenticacion/token', headers = {'Authorization' : 'Basic ' + base64_u})
token = respuesta_token["token"]
# Codifica el token en base64

base64_t = base64.b64encode(token + ':')
# Obtiene los vehículos

respuesta_vehiculos = peticion_get(servidor + '/api/usuario/get_all_vehiculos', headers = {'Authorization' : 'Basic ' + base64_t})
# Lista los datos de los vehículos

for veh in respuesta_vehiculos:
print "{0[id_vehiculo]} -> {0[identificador]} ({0[marca]} {0[modelo]})".format(veh)
5.- Versiones
0.4.8 31/07/2023
balizas/get_all_balizas Nueva petición para obtener las balizas del usuario
informes/get_ultima_posicion_balizas Nueva petición para obtener la última posición de las balizas
0.4.7 07/07/2023
informes/get_ruta se ha añadido el atributo: estado_maquina
0.4.6 06/07/2023
informes/get_ultima_posicion se ha añadido el atributo: estado_maquina
0.4.5 06/06/2023
informes/get_ultima_posicion Corrección del cálculo de odómetro y horómetro.
0.4.4 22/05/2023
informes/get_ultima_posicion Se han añadido el atributo: peso.
0.4.3 01/02/2023
Se han añadido los atributos: tacografo_estado_id, tacografo_estado_desc, tacografo_tarjeta,

informes/get_ruta
tacografo_tiempo_normativa_desc, para mostrar información del tacógrafo.
informes/get_tacografos Nueva función informes/get_tacografos.
estados/tacografos_estados Nueva función estados/tacografos_estados.
estados/tacografos_normativas Nueva función estados/tacografos_normativas.
0.4.2 13/09/2022
testo Se han eliminado las funciones: informes/get_temperatura_testo, testo/get_temperatura, testo/get_ruta_temperatura
usuarios/get_carpeta Corrección del atributo carpeta por nombre
informes/get_safetydrive Se ha eliminado la función get_safetydrive obsoleta.
informes/get_distancia_tiempo_dia_old Se ha eliminado la función get_distancia_tiempo_dia_old obsoleta.
informes/get_distancia_tiempo_dia Se ha eliminado el atributo suma_tiempo obsoleto.
informes/get_ultima_posicion Se ha eliminado el atributo horometro_debug obsoleto.
0.4.1 23/05/2022
Nueva función get_jornadas_navision
0.4.0 18/08/2021
Se han añadido los atributos imei, imei_all y serie en la petición de get_all_vehiculos
0.3.9 13/11/2020
Se han añadido los atributos consumo_carga_kw y consumo_carga_xciento en la petición de get_ruta
0.3.8 04/05/2020
Mejoras de rendimiento
0.3.7 30/04/2020
Se han añadido más parámetros para filtrar las alertas con la fecha de servidor (fecha_inicio_servidor,fecha_fin_servidor)
0.3.6 29/04/2020
Se ha añadido los atributos bastidor, tiene_canbus y tiene_tacografo en la información del vehículo usuarios/get_all_vehiculos
0.3.5 22/04/2020
Se ha modificado la última posición y alertas para el filtro de horario y posición
0.3.4 21/04/2020
Se ha modificado la ruta para el filtro de horario y posición
0.3.3 10/03/2020
Nuevo diseño de la interfaz web cliente
0.3.2 10/03/2020
informes/get_ultima_posicion Se ha añadido el atributo horómetro y mostrar_horometro para mostrar.
0.3.1 18/03/2019
informes/get_ruta Se ha añadido el atributo estado en el body para filtrar los eventos
Se ha aumentado el máximo de vehículos por petición limitando los días (si selecciona más de 20 vehículos, sólo podrá obtener
informes/get_ruta
1 día de ruta)
0.3.0 22/02/2019
informes/get_ruta Se ha añadido más atributos de tacógrafo
0.2.9 15/11/2018
informes/get_distancia_tiempo_dia Se ha optimizado y corregido errores de este informe
autenticacion/logout Se ha añadido una nueva función para eliminar el token
0.2.8 02/10/2018
informes/get_ultima_posicion Se ha añadido la fecha de inicio y de fin en la petición
0.2.7 08/08/2018
vehiculos/get_alertas Se ha eliminado esta función ya que está en la sección de informes
vehiculos/get_distancia_tiempo_dia Se ha eliminado esta función ya que está en la sección de informes
vehiculos/get_safetydrive Se ha eliminado esta función ya que está en la sección de informes
0.2.6 06/08/2018
get_ultima_posicion Mejoras de rendimiento en la petición con el atributo mostrar_odometro.
0.2.5 30/07/2018
get_pdis Nueva función para obtener la lista de pdis.
0.2.4 27/07/2018
get_ruta Se han añadido más datos como la fecha_insert_servidor, id_pdi e id_conductor.
get_ultima_posicion Se han añadido más datos como la fecha_insert_servidor, id_pdi e id_conductor.
get_conductores Nueva función para obtener la lista de conductores.
get_eventos_posiciones Nueva función para obtener la lista de eventos.
0.2.3 16/07/2018
get_ruta Se han añadido más datos como el acelerador, rpm, contador de litros y de kms, temperatura ambiente y de motor.
0.2.2 15/05/2018
vehiculos Se ha añadido la función set_outputs en vehiculos.
0.2.1 02/03/2018
informes/get_ruta se han añadido como response campos de CANbus (rpm, freno, acelerador,...). También se ha añadido el contador de kms gps.
0.2.0 22/02/2018
vehiculos/get_inputs se ha quitado el máximo de vehículos en la petición.
vehiculos se ha añadido el campo id_vehiculo como response.
0.1.9 30/01/2018
informes Se ha modificado informes/get_temperatura_testo por informes/testo/get_temperatura
informes Se ha añadido la función get_ruta_testo en informes/testo/.
vehiculos Se ha añadido la función get_inputs en vehiculos.
0.1.8 16/01/2018
vehiculos Nueva función añadida set_vehiculo_en_carpeta
vehiculos Se han quitado los informes del vehículo para añadir a la sección de informes.
informes Se han añadido los informes que estavan en la sección vehículos.
usuarios Nueva función añadida get_carpetas.
0.1.7 11/07/2017
vehiculos: get_ultima_posicion Se ha añadido nuevas columnas para identificar el estado de los cables: input2, input3, input4 e input5.
0.1.6 07/07/2017
informes: get_temperatura_testo Nuevo informe de temperaturas para sondas testo.
vehiculos: get_ruta Se ha modificado la petición de la fecha de inicio y fin para filtrar por hora también.
0.1.5 30/06/2017
vehiculos: get_ruta Se ha optimizado las peticiones a esta función. Ahora se pueden enviar una lista de vehículos (máximo 20).
0.1.4 23/06/2017
vehiculos: get_ruta Se ha añadido nuevas columnas para identificar el estado de los cables: input2, input3, input4 e input5
0.1.3 05/06/2017
autentication: token Se ha restringido el acceso solamente a usuarios de tipo webservice
0.1.2 21/04/2017
vehiculos: get_ruta Se ha añadido la función get_ruta en vehículos.
0.1.1 14/03/2017
Ejemplos Se han añadido ejemplos de acceso al webservice mediante código PHP y código Python.
0.1.0 01/03/2017
autentication: token Se ha aumentado el tiempo de conexión a 15 días.
vehiculos: get_ultima_posicion Mejoras de rendimiento y corrección de errores en el informe de última posición.
0.0.9 21/11/2016
vehiculos: get_alertas Se añade los campos de “codigo_evento” y “tipo_evento” para obtener el código de la descripción del evento.
0.0.8 11/11/2016
vehiculos: get_alertas Cambios en el request de fecha inicio y fin, ahora son datetime
0.0.7 03/11/2016
vehiculos: get_alertas Muestra las alertas.
0.0.6 27/09/2016
usuario: get_all_vehiculos Se ha modificado en todos los headers la descripción “Token” por “Authorization”
vehiculos: get_ultima_posicion Se ha modificado en todos los headers la descripción “Token” por “Authorization”
vehiculos: get_safetydrive Se ha modificado en todos los headers la descripción “Token” por “Authorization”
vehiculos: get_distancia_tiempo_dia Se ha modificado en todos los headers la descripción “Token” por “Authorization”
0.0.5 19/09/2016
vehiculos: get_distancia_tiempo_dia Muestra la distancia y el tiempo total de un día
vehiculos: get_ultima_posicion Se ha modificado el campo “id_vehiculo” de requests por “ids_vehiculos”.
vehiculos: get_safetydrive Se ha modificado el campo “id_vehiculo” de requests por “ids_vehiculos”.
0.0.4 13/06/2016
vehiculos: get_ultima_posicion Se añade el campo odómetro.
0.0.3 23/12/2015
vehiculos: get_ultima_posicion Muestra la última posición.
0.0.2 20/11/2015
vehiculos: get_safetydrive Muestra el informe safetydrive
0.0.1 20/11/2015
usuarios: get_all_vehiculos Muestra el listado de todos los vehículos del usuario autenticado.
Cuando el cliente se loguea con el usuario y clave, devuelve la identificación para poder conectarse al servicio y, mediante token,
autentication: token
puede obtener las diferentes funciones existentes.

Webservice Documentación

Cargado por

Copyright:

Formatos disponibles

Webservice Documentación

Cargado por

Información del documento

Descripción original:

Título original

Derechos de autor

Formatos disponibles

Compartir este documento

Compartir o incrustar documentos

Opciones para compartir

¿Le pareció útil este documento?

¿Este contenido es inapropiado?

Copyright:

Formatos disponibles

Webservice Documentación

Cargado por

Copyright:

Formatos disponibles

15/11/23, 14:03 Webservice documentación

Ejemplo de conexión mediante navegador

Ejemplo conexión mediante PHP

Ejemplo conexión mediante Python

Acceso: autenticación de usuarios mediante sus claves.

Funciones: diferentes acciones disponibles para obtener información.

Cliente y ejemplos: muestra ejemplos para poder usar el webservice.

Versiones: histórico de versiones de las diferentes implementaciones realizadas.

El resultado de todas las peticiones es un archivo en formato json.

2.- Acceso: autenticación de usuarios mediante sus claves

Concatenar usuario y clave en un string: “usuario:clave”

Codificar el string anterior mediante Base64 (https://en.wikipedia.org/wiki/Base64).

El valor generado mediante los pasos anteriores es parecido a esto: QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Para más información consultar: https://en.wikipedia.org/wiki/Basic_access_authentication

Para obtener el token se deberá de ejecutar la función autenticacion/token.

El resultado del token es parecido al siguiente valor:

La duración de la sesión es de 15 días.

Concatenar token en un string: "token:"

Codificar el string anterior mediante Base64 (https://en.wikipedia.org/wiki/Base64).

Siguiendo el ejemplo del token anterior, se enviaría de la siguiente forma:

Authorization: Basic ZXlKaGJHY2lPaUpJVXpJMU5pSXNJbVY0Y0NJNk1UUTBPRFEwTlRFNU9Td2lhV0YwSW

3.- Funciones: acciones disponbiles para obtener información

token: Obtención del token y acceso al webservice.

logoutElimina el token y restringe acceso al webservice.

get_eventos_posicionesObtener la lista de eventos de cada posición que puede enviar el GPS.

tacografos_estadosIndica el código y estado del tacógrafo

tacografos_normativasIndica el código y estados de la normativa del tacógrafo.

get_conductoresObtener la lista de conductores del usuario

get_pdis: Obtener la lista de pdis del usuario

get_carpetas: Muestra el listado de todas las carpetas del usuario.

A continuación se muestra el listado de funciones y un resumen de su uso:

Obtención del token y acceso al webservice

Descripción Tipo Observaciones

Descripción Tipo Observaciones

duration integer Valor en segundos. Duración de la sesión

token string Identificador de autenticación para realizar peticiones

Elimina el token y restringe acceso al webservice

Descripción Tipo Observaciones

Descripción Tipo Observaciones

message string Descripción del estado ('Ok.', 'Token Not Found.' )

Lista de todas las balizas del usuario

Descripción Tipo Observaciones

Descripción Tipo Observaciones

id_baliza integer Id de la baliza

referencia string Descripción impresa en el exterior de la baliza

grupo string Carpeta para agrupar las balizas (opcional)

tipo integer Indica el tipo de baliza: remolque, pdi o conductor

Obtener la lista de eventos de cada posición que puede enviar el GPS.

Descripción Tipo Observaciones

Descripción Tipo Observaciones

id_estado integer Código del estado

descripcion string Descripción del estado

color datetime Valor hexadecimal del código de color

Indica el código y estado del tacógrafo

Descripción Tipo Observaciones

Descripción Tipo Observaciones

id_estado integer Código del estado