WebService
Especificación técnica para la integración de los Servicios Web.Versión Documento 2.5
Introducción
El objetivo del presente documento es explicar brevemente la interface de integración con los diferentes servicios que ofrece la Plataforma de Monitoreo, por parte de sus clientes o empresas externas autorizadas.
Tecnología de integración
Para la integración de los Servicios Web de la Plataforma de Monitoreo, se ha diseñado una arquitectura abierta, segura y compatible con las tecnologías más utilizadas en la industria actualmente, es por ello que la interface que ofrecemos se encuentra desarrollada bajo los estándares de RESTful Web Services según se describe en el presente documento.
Requisitos para uso de los servicios web
Para poder utilizar los Servicios Web, cada cliente/distribuidor deberá solicitarlo previamente describiendo las características que necesita integrar así como los usuarios para los que solicita el acceso, una vez obtenida la autorización, le será entregada un APIKEY (llave de identificación) que lo identificará en nuestros servicios y diferentes características que le fueron autorizadas.
Observaciones
Se deja expresa constancia que la arquitectura e interface que aquí se documenta pertenece a nuestras soluciones, y nos reservamos el derecho de modificar o ajustar la misma en forma total o parcial a nuestro solo criterio, en la medida que lo consideremos necesario. Quienes utilizan esta interface reconocen que ante cualquier cambio deberán ajustar sus productos o herramientas según lo requiera sin ningún tipo de reclamo o perjuicio para nosotros.
Especificaciones de uso
Todas las peticiones al servicio serán realizadas utilizando el método web POST a través de la dirección URL https://api.service24gps.com/api/v1/ seguido de la acción a realizar descritas en el presente documento.
Entre cada petición debe existir una diferencia mínima de treinta segundos.
En todas las peticiones se deben enviar las llaves de autenticación APIKEY y TOKEN a través de parámetros.
La respuesta siempre es devuelta en formato json e incluye los campos status y data.
Los parámetros de cada petición se deben enviar como está especificado en la documentación de cada método, el cual es susceptible a mayúsculas y minúsculas.
Método de autenticación - getToken
POST https://api.service24gps.com/api/v1/gettoken
Para obtener acceso las aplicaciones y herramientas de los clientes deben solicitar a través del servicio una llave (Token) de autenticación que le permitirá hacer uso de los servicios durante seis horas continuas , una vez transcurrido este periodo de tiempo, se debe volver a solicitar otro Token de autenticación.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Debe ir en blanco como cadena vacía.
500
username
Un usuario autorizado para usar el servicio por parte del cliente y debe estar definido previamente.
150
usuario
password
Contraseña asociada al usuario.
50
contraseña
get_info
Opcional, si se desea obtener el idusuario, usuario, idcliente, nombre de cliente, token y el tiempo restante del token se debe utilizar este parámetro.
1
0
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/gettoken' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token=""' \
--form 'username="usuario"' \
--form 'password="contraseña"' \
Respuesta de ejemplo:
{
"status": 200,
"data": "wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="
}
Obtener token con información extra - gettoken
POST https://api.service24gps.com/api/v1/gettoken
Para obtener acceso las aplicaciones y herramientas de los clientes deben solicitar a través del servicio una llave (Token) de autenticación que le permitirá hacer uso de los servicios durante seis horas continuas , una vez transcurrido este periodo de tiempo, se debe volver a solicitar otro Token de autenticación.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Debe ir en blanco como cadena vacía.
500
username
Un usuario autorizado para usar el servicio por parte del cliente y debe estar definido previamente.
150
usuario
password
Contraseña asociada al usuario.
50
contraseña
get_info
Bandera (1 o 0) para obtener además del token el tiempo restante de vida del mismo, información de usuario y cliente.
1
1
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/gettoken' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token=""' \
--form 'username="usuario"' \
--form 'password="contraseña"' \
--form 'get_info="1"' \
Respuesta de ejemplo con "get_info":
{
"status": 200,
"data": {
"id_user": "11",
"id_cli": "12",
"name_user": "prueba_user",
"name_cli": "FA SA CV",
"token": "wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==",
"time_left": 190
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id_user
Identificador único del usuario en plataforma.
Entero
id_cli
Identificador único del cliente en plataforma.
Entero
name_user
Nombre del usuario en plataforma.
Cadena de Texto
name_cli
Nombre del cliente en plataforma.
Cadena de Texto
token
Cadena de texto que ayuda a autenticarte.
Cadena de Texto
time_left
Cantidad de minutos restantes para el uso del token
Cadena de Texto
Activos
Métodos relacionados a los activos
Datos de unidades - getData
POST https://api.service24gps.com/api/v1/getdata
Este método devuelve un array de datos con la última información o reporte enviado por las unidades de rastreo asignadas al usuario autentificado.
IMPORTANTE: No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un Web Service genérico .
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
UseUTCDate
Valor booleano (Opcional por defecto es 0)
0 = Como la envió la unidad de rastreo.
1 = Especifica si la fecha del reporte es en formato UTC.
1
0
sensores
Valor booleano
0 = No trae la información de los sensores.
1 = Especifica si se desea obtener la información de sensores.
1
1
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getdata' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'UseUTCDate="0"' \
--form 'sensores="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"UnitId": "Jeep Patriot",
"UnitPlate": "NTX9553",
"GpsIdentif": "0580012342332337",
"ReportDate": "2021-04-26 16:42:43",
"Latitude": "+19.528530",
"Longitude": "-99.171165",
"UrlLocation": "https://maps.google.com/?ie=UTF8&q=19.7893235448976,-98.96555386318250",
"Altitude": 0,
"GpsSpeed": "0",
"Direction": "N",
"Satellites": "22",
"Ignition": "0",
"Odometer": 0,
"IdEvento": "1",
"Domicilio": "Camino a San Juan Ixtacala 479, San Juan, Gustavo A. Madero, Mexico City, Mexico",
"Puerto": "",
"IpOrigen": "",
"BateriaGps": "-1",
"BateriaVeh": "-1",
"Grupo": null,
"Conductor": "Salvador Lopez",
"Inputs": "0|0|0|0|0|0|0|0|0|0|0|0|0|0|0",
"TipoDato": "Ubicación",
"Senal": "62",
"InsertionDate": "2021-04-26 16:43:13",
"Sensores": ""
}
]
}
Nota: Los campos con valor -1 se refieren que no se han enviado por el dispositivo de rastreo.
Ver campos de respuesta:
Campo
Descripción
Formato
UnitId
Valor por el qué es identificada la unidad o vehículo.
Cadena de Texto
UnitPlate
Se refiere a la placa/patente del vehículo.
Cadena de Texto
GpsIdentif
Número de serie o IMEI que permite identificar el dispositivo de rastreo
Cadena de Texto, con longitud de 16 caracteres.
ReportDate
Fecha/hora de la posición
aaaa-mm-dd hh:mm:ss
Latitude
Latitud de la posición del vehículo.
Grados decimales
Longitude
Longitud de la posición del vehículo.
Grados decimales
UrlLocation
Url de localización
Cadena de Texto
Altitude
Altitud de la posición del vehículo.
Metros
GpsSpeed
Orientación del vehículo, Norte, Sur, Este, etc.
Kilómetros / hora
Direction
N,S,E,O,NO,NE,SO,SE
Orientación del vehículo, Norte, Sur, Este, etc.
Satellites
Número de satélites con Fix de la posición.
Entero
Ignition
Status Ignición:
0 = OFF
1 = ON
2 = Desconocida
Entero
Odometer
Odómetro del vehículo en la posición.
Metros
IdEvento
Identificador del evento que reportó el equipo GPS.
Entero
Domicilio
Dirección correspondiente a la latitud y longitud reportada por el equipo.
Cadena de texto
Puerto
Puerto de origen de reporte del equipo GPS.
Entero
IpOrigen
Ip de origen de reporte del equipo GPS
Cadena de texto
BateriaGps
Nivel de voltaje o porcentaje del equipo GPS
Cadena de texto
BateriaVeh
Nivel de voltaje de la fuente conectada al GPS.
Cadena de texto
Grupo
Nombre del grupo al que pertenece el vehículo.
Cadena de texto
Conductor
Nombre del conductor asociado al vehículo.
Cadena de texto
Inputs
Estados de cada entrada del equipo:
0 = Desactivada
1 = Activada.
Cadena de texto
TipoDato
Tipo de dato.
Cadena de texto
Senal
Señal del equipo GPS.
Entero
InsertionDate
Fecha/hora de inserción.
aaaa-mm-dd hh:mm:ss
Sensores
Json de datos de los sensores
JSON
Formato de respuesta de sensores
Ver formato:
Nombre
Descripción
Valor de la propiedad
Ejemplo
Sensores
Formato de respuesta de la petición.
82: Id del sensor.
Bateria_gps: nombre del sensor.
Valores enviados por el equipo relacionado al sensor (Consulta el listado de sensores en getSensors ).
"82":{
"Bateria_gps":{
"nombre": "Bateria_gps",
"valor": "0", "fecha": "2023-03-14 12:01:51"
}
}
Lista de vehículos - vehicleGetAll
POST https://api.service24gps.com/api/v1/vehicleGetAll
Lista los vehículos asignados al usuario autentificado en la API.
IMPORTANTE: No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un Web Service genérico .
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/vehicleGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "198098",
"nombre": "Jeep Patriot",
"patente": "NT-53-53",
"idgps": "0580012342332337",
"gatewayip": "107.170.254.11",
"conductor": "Luis M.",
"grupo": "Seguridad SA.",
"marca": "Ford",
"modelo": "G15",
"color": "Azul",
"anio": "2025",
"numero_serie": "N8798895611",
"odometro": "25682.2",
"tipo_vehiculo": "Camioneta",
"notas": "",
"idgrupo_vehiculo": "878954"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del vehículo dentro de la plataforma.
Entero
nombre
Nombre que identifica al vehículo en la plataforma.
Cadena de Texto
patente
Placa/patente del vehículo.
Cadena de Texto
idgps
Equipo GPS instalado en el vehículo.
Cadena de Texto
gatewayip
IP en la que se encuentra reportando el GPS.
Cadena de Texto
conductor
Nombre del conductor asociado al vehículo.
Cadena de Texto
grupo
Nombre del grupo al que pertenece el vehículo.
Cadena de Texto
marca
Marca del vehículo (VolksWagen, Ford, etc.)
Cadena de Texto
modelo
Modelo del vehículo (Vento, Figo, etc...)
Cadena de Texto
color
Color de la carrocería del vehículo.
Cadena de Texto
anio
Indica el año en que fue lanzado a la venta el vehículo.
Cadena de Texto
numero_serie
Número de serie asociado al activo.
Cadena de Texto
odometro
Valor del odometro.
Cadena de Texto
tipo_vehiculo
Indica si el activo es un: automóvil, peatón, etc.
Cadena de Texto
notas
Información adicional del vehículo.
Cadena de Texto
idgrupo_vehiculo
Identificador único del grupo que pertenece el vehículo.
Cadena de Texto
Lista de vehículos + infoextra - vehicleGetAllComplete
POST https://api.service24gps.com/api/v1/vehicleGetAllComplete
Lista los vehículos asignados al usuario autentificado en la API.
IMPORTANTE: No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un Web Service genérico .
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/vehicleGetAllComplete' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "1980",
"nombre": "Auto Test",
"patente": "NTX9553",
"idgps": "0580012342332337",
"gatewayip": "107.170.254.11",
"conductor": "User Test",
"grupo": "Test Group",
"marca": "Ford",
"modelo": "Mustang",
"color": "Rojo",
"anio": "2015",
"numero_serie": "N123456789",
"num_economico": "rd23",
"tipo_vehiculo": "Automovil",
"icono_vehiculo": "./Iconos/Vehiculos/01.png",
"idequipo_gps": "0",
"idtipo_vehiculo": "3",
"idmarca_vehiculo": "0",
"idconductor": "0",
"idgrupo_vehiculo": "0"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del vehículo dentro de la plataforma.
Entero
nombre
Nombre que identifica al vehículo en la plataforma.
Cadena de Texto
patente
Placa/patente del vehículo.
Cadena de Texto
idgps
Equipo GPS instalado en el vehículo.
Cadena de Texto
gatewayip
IP en la que se encuentra reportando el GPS.
Cadena de Texto
conductor
Nombre del conductor asociado al vehículo.
Cadena de Texto
grupo
Nombre del grupo al que pertenece el vehículo.
Cadena de Texto
marca
Marca del vehículo (VolksWagen, Ford, etc...)
Cadena de Texto
modelo
Modelo del vehículo (Vento, Figo, etc...)
Cadena de Texto
color
Color de la carrocería del vehículo.
Cadena de Texto
anio
Indica el año en que fue lanzado a la venta el vehículo.
Cadena de Texto
numero_serie
Número de serie asociado al activo.
Cadena de Texto
num_economico
Número económico del vehículo
Cadena de Texto
tipo_vehiculo
Indica si el activo es un: automóvil, peatón, etc...
Cadena de Texto
icono_vehiculo
URL de la imagen del vehiculo
Cadena de Texto
idequipo_gps
Identificador del dispositivo.
Entero
idtipo_vehiculo
Identificador del tipo de vehículo.
Entero
idmarca_vehiculo
Identificador de la marca del vehiculo.
Entero
idconductor
Identificador asignado al conductor.
Entero
idgrupo_vehiculo
Identificador del grupo que pertenece el vehículo.
Entero
Listar los contenedores de activos - getDataContainers
POST https://api.service24gps.com/api/v1/getDataContainers
Lista todos los contenedores de uno o varios remolques de todos los activos del cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getDataContainers' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"unitid": "MTR2",
"unitplate": "MTR2",
"gpsidentif": "5107BE5A902E6256",
"gpsdate": "2022-03-02T23:09:09",
"gpslat": "-15.348761848591401",
"gpslong": "-75.1446473753456",
"event": "Ubicación",
"containers": [
{
"id": "152",
"worder": "2151",
"containerno": "Contedor 1",
"bookingno": "1231",
"client": "User Test",
"origin": "Sonora, Mexico",
"destination": "Puerto Manzanillo, Mexico",
"eta": "15564",
"self_billing": "215",
"naviera": "",
"gross_weight": "500kg"
},
{
"id": "285",
"worder": "2151",
"containerno": "Contedor 2",
"bookingno": "1231",
"client": "User Test",
"origin": "Sonora, Mexico",
"destination": "Puerto Manzanillo, Mexico",
"eta": "15564",
"self_billing": "215",
"naviera": "",
"gross_weight": "500kg"
}
]
}
]
}
Odómetro de activo(s) - getOdometer
POST https://api.service24gps.com/api/v1/getOdometer
Este método permíte consultar el odómetro de uno o varios activos en una fecha específica.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
equipo
IMEI o Identificador único del dispositivo configurado en la plataforma. Equipo o equipos separados por “,”
0580012342332337
fecha
Fecha en la que se calculará el odómetro del activo.
2021-04-27
hora
Hora en la que se calculará el odómetro del activo.
23:59:59
odometro_gps
Si la fecha se envía vacía devolverá el último odómetro reportado por el GPS. Si se envía una fecha en específico entonces se devolverá el último odómetro reportado para ese día.
0 = Odómetro calculado por la plataforma.
1 = Odómetro reportado por el GPS.
1
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getOdometer' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="0580012342332337"' \
--form 'fecha="2021-04-27"' \
--form 'hora="23:59:59"' \
--form 'odometro_gps="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"0580012342332337": {
"Fecha": "2021-04-27",
"Kilometros": 0,
"Odometro": "0.00",
"Horas": 0
}
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
Fecha
Fecha a la que pertenece el odómetro.
Fecha (aaaa-mm-dd)
Kilometros
Distancia recorrida por el activo en la fecha indicada.
Distancia en kilómetros
Odometro
Odómetro del activo a la fecha consultada.
Kilómetros
Horas
Horas de uso de motor correspondientes a la fecha.
Flotante
Listar clientes que pertenecen a un activo - getClientsByVehicle
POST https://api.service24gps.com/api/v1/getClientsByVehicle
Lista los clientes que están asignados a un activo especifico.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idvehiculo
Identificador del vehiculo
8
51651
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getClientsByVehicle' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'\
--form 'idvehiculo="51651"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idcliente": "42251",
"cliente": "Empresa CEO"
},
{
"idcliente": "1129759",
"cliente": "Sucursal Norte"
},
{
"idcliente": "15470",
"cliente": "Empresa de carga ICO"
},
{
"idcliente": "8229",
"cliente": "Sucursal Sur"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idcliente
Identificador único del cliente.
Entero
cliente
Nombre del cliente.
Cadena de Texto
Obtener / visualizar los tanques para PEMEX - showTanks
POST https://api.service24gps.com/api/v1/showTanks
Se obtiene los reportes de las unidades de los últimos 5 minutos, los valores retornados es un formato requerido por parte del documento de PEMEX : "Carga de datos de rastreo de autotanques con presentación de servicios para Pemex Logística".
Ver parámetros de solicitud:
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/showTanks' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"ID_UNIDAD": "XX805",
"FECHA": "08/07/2022 09:57:37",
"LATITUD": "25.39214",
"LONGITUD": "-100.11898",
"VELOCIDAD": "11",
"OBSERVACIONES": "",
"COMPANIA": "ONCETG"
},
{
"ID_UNIDAD": "XX317",
"FECHA": "08/07/2022 09:58:20",
"LATITUD": "27.59561",
"LONGITUD": "-99.58542",
"VELOCIDAD": "0",
"OBSERVACIONES": "",
"COMPANIA": "ONCETG"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
ID_UNIDAD
Placa o nombre de la unidad (activo), sin espacios y guiones.
Texto
FECHA
Fecha hora del reporte, Formato: DD/MM/YYY hh:mm:ss Zona Horaria de la Ciudad de México
Date
LATITUD
Latitud del reporte en formato: WGS84
Texto
LONGITUD
Longitud del reporte en formato: WGS84
Texto
VELOCIDAD
Velocidad del reporte
Entero
OBSERVACIONES
Notas o comentarios de la unidad
Texto
COMPANIA
Nombre de la compañía o empresa que pertenecen las unidades
Texto
Listado de grupo de activos - getAssetGroups
POST https://api.service24gps.com/api/v1/getAssetGroups
Obtiene el listado de los grupos de activos.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getAssetGroups' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": 5621235,
"name": "Grupo de activos 1",
"idcliente_sistema": "53725"
},
{
"id": 5621236,
"name": "Grupo de activos 2",
"idcliente_sistema": "53725"
},
{
"id": 5621237,
"name": "Grupo de activos 3",
"idcliente_sistema": "53725"
}
]
}
Respuesta de ejemplo:
Ver campos de respuesta:
Campo
Descripción
Formato
Id
Identificador único del grupo de activos.
Entero
name
Nombre del grupo de activos.
Cadena de texto.
idcliente_sistema
Identificador único del cliente.
Cadena de texto.
Conductores
Lista de conductores - driverGetAll
Listar conductores - driverGetAll
POST https://api.service24gps.com/api/v1/driverGetAll
Obtiene la lista de todos los conductores que pertenecen al cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
licencia
(Opcional) Número de Licencia.
123456
Nota: Si requiere solo la información de un conductor en especifico, debe mandar en la solicitud el parámetro licencia con el número de licencia que tiene asignado el conductor.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/driverGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "43530",
"numero": "0987654321",
"alias": "test_new_driver",
"nombre": "Test Nombre",
"apellido": "New Driver",
"identificador": "TEST0987654NWD",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR001",
"licencia": "78979TEST123",
"vigencia": "2022-05-14",
"direccion": "test de domicilio de conductor test",
"email": "test@test.com",
"idvehiculo": "37922",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test1",
"usuario": "driver_test1",
"password": "MTIzNDU2"
},
{
"id": "43531",
"numero": "0987654321",
"alias": "test_new_driver2",
"nombre": "Test Nombre 2",
"apellido": "New Driver 2",
"identificador": "TEST89956156",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR002",
"licencia": "78979TEST1232",
"vigencia": "2022-05-15",
"direccion": "test de domicilio de conductor test2",
"email": "test2@test.com",
"idvehiculo": "37923",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test2",
"usuario": "driver_test2",
"password": "MTIzNDU2"
},
{
"id": "43532",
"numero": "098765432133",
"alias": "test_new_driver3",
"nombre": "Test Nombre 3",
"apellido": "New Driver 3",
"identificador": "TEST895662563",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR003",
"licencia": "78979TEST1233",
"vigencia": "2022-06-15",
"direccion": "test de domicilio de conductor test3",
"email": "test3@test.com",
"idvehiculo": "37924",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test3",
"usuario": "driver_test3",
"password": "MTIz"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único asignado al conductor.
Entero
numero
Código interno para identificar al conductor.
Cadena de texto
alias
Nombre alterno para identificar al conductor.
Cadena de texto
nombre
Nombre del conductor.
Cadena de texto
apellido
Apellido del conductor.
Cadena de texto
identificador
Código de iButton o RFID asignado al conductor.
Cadena de texto
fecha_alta
Fecha en que se creó el conductor en el sistema.
Date (aaaa-mm-dd)
telefono
Identificador único de la ruta en el sistema.
Cadena de texto
cedula
Número de cédula.
Cadena de texto
licencia
Número de licencia.
Cadena de texto
vigencia
Fecha en que expira la licencia del conductor.
Date (aaaa-mm-dd)
direccion
Ubicación del domicilio del conductor.
Cadena de texto
email
E-mail de contacto del conductor.
Cadena de texto
idvehiculo
Id del vehículo asignado al conductor.
Entero
idgrupo
Id del grupo al que pertenece el conductor.
Entero
nombregrupo
Nombre del grupo al que pertenece el conductor.
Cadena de texto
observaciones
Observaciones realizadas por el operador.
Cadena de texto
usuario
Usuario del conductor.
Cadena de texto
password
Contraseña del conductor codificada en base64.
Cadena de texto
Crear conductor - createDriver
POST https://api.service24gps.com/api/v1/createDriver
Permite realizar el alta de un conductor al sistema. * Campos requeridos.
Todos los parámetros deben enviarse en la solicitud, los marcados con * es obligatorio que tengan un valor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web. *
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken. *
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
Nombre del conductor. *
Test Nombre 3
apellido
Apellido del conductor.
New Driver 3
alias
Nombre alterno para identificar al conductor.
test_new_driver3
identificador
Código de iButton o RFID asignado al conductor.
TEST895662563
numero
Código interno para identificar al conductor.
0987654321
telefono
Número de teléfono del conductor. *
1234567890
cedula
Número de cédula.
FSGBSTR003
licencia
Número de licencia. *
78979TEST1233
vigencia
Fecha en que expira la licencia del conductor. *
2022-06-15
direccion
Ubicación del domicilio del conductor. *
test de domicilio de conductor test3
email
E-mail de contacto del conductor. *
test3@test.com
idvehiculo
Id del vehículo asignado al conductor. *
37924
observaciones
Observaciones realizadas por el operador.
Observación de conductor test3
idgrupo
Identificador del grupo
3
user
Usuario del conductor. (Opcional)
driver_test3
password
Contraseña del conductor. (Opcional)
pass123
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createDriver' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test Nombre 3"' \
--form 'apellido="New Driver 3"' \
--form 'alias="test_new_driver3"' \
--form 'identificador="TEST895662563"' \
--form 'numero="0987654321"' \
--form 'telefono="1234567890"' \
--form 'cedula="FSGBSTR003"' \
--form 'licencia="78979TEST1233"' \
--form 'vigencia="2022-06-15"' \
--form 'direccion="test de domicilio de conductor test3"' \
--form 'email="test3@test.com"' \
--form 'idvehiculo="37924"' \
--form 'idgrupo="3"' \
--form 'observaciones="Observación de conductor test3"' \
--form 'user="driver_test3"' \
--form 'password="pass123"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "710900",
"msg": "Se creó el conductor"
}
}
Nota : Si el usuario a crear ya existe, se mostrará el siguiente mensaje.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"code": 30700,
"message": "No se pudo crear el usuario driver_test"
}
}
Actualizar conductor - updateDriver
POST https://api.service24gps.com/api/v1/updateDriver
Permite realizar la modificación de la información de un conductor. * Campos requeridos.
Todos los parámetros deben enviarse en la solicitud, los marcados con * es obligatorio que tengan un valor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web. *
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken. *
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idConductor
Id del conductor *
123456
nombre
Nombre del conductor. *
Update Test Nombre 3
apellido
Apellido del conductor.
New Driver 3
alias
Nombre alterno para identificar al conductor.
test_new_driver3
identificador
Código de iButton o RFID asignado al conductor.
TEST895662563
numero
Código interno para identificar al conductor.
0987654321
telefono
Número de teléfono del conductor. *
1234567890
cedula
Número de cédula.
FSGBSTR003
licencia
Número de licencia. *
78979TEST1233
vigencia
Fecha en que expira la licencia del conductor. *
2022-06-15
direccion
Ubicación del domicilio del conductor. *
test de domicilio de conductor test3
email
E-mail de contacto del conductor. *
test3@test.com
idvehiculo
Id del vehículo asignado al conductor.
37924
observaciones
Observaciones realizadas por el operador.
Observación de conductor test3
idgrupo
Identificador del grupo
0
user
Usuario del conductor. (Opcional)
driver_test3
password
Contraseña del conductor. (Opcional)
pass123
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateDriver' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idConductor="123456"' \
--form 'nombre="Update Test Nombre 3"' \
--form 'apellido="New Driver 3"' \
--form 'alias="test_new_driver3"' \
--form 'identificador="TEST895662563"' \
--form 'numero="0987654321"' \
--form 'telefono="1234567890"' \
--form 'cedula="FSGBSTR003"' \
--form 'licencia="78979TEST1233"' \
--form 'vigencia="2022-06-15"' \
--form 'direccion="test de domicilio de conductor test3"' \
--form 'email="test3@test.com"' \
--form 'idvehiculo="37924"' \
--form 'observaciones="Observación de conductor test3"' \
--form 'idgrupo="0"' \
--form 'user="driver_test3"' \
--form 'password="pass123"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "123456",
"msg": "Se actualizó el conductor"
}
}
Nota : El usuario a actualizar debe pertenecer al cliente, de lo contrario no se realiza la actualización y se muestra el siguiente mensaje.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"code": 30700,
"message": "El usuario driver_test3 ya existe"
}
}
Eliminar conductor - deleteDriver
POST https://api.service24gps.com/api/v1/deleteDriver
Este método permite eliminar un conductor especifico.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idConductor
Identificador único del conductor en el sistema.
138225
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteDriver' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idConductor="138225"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si en la respuesta de la solicitud aparece "status": 30700 es un error al obtener los datos.
Respuesta de ejemplo:
{
"status": 30700,
"data": ""
}
Listar conductores con grupo y vehículo - driverInfoGetAll
POST https://api.service24gps.com/api/v1/driverInfoGetAll
Obtiene la lista de todos los conductores del cliente con la relación vehículo y grupo conductor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/driverInfoGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "43530",
"numero": "0987654321",
"alias": "test_new_driver",
"nombre": "Test Nombre",
"apellido": "New Driver",
"identificador": "TEST0987654NWD",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR001",
"licencia": "78979TEST123",
"vigencia": "2022-05-14",
"direccion": "test de domicilio de conductor test",
"email": "test@test.com",
"idvehiculo": "37922",
"idgrupo": "10",
"observaciones": "creacion de conductor test",
"idgrupo_conductor": "10",
"nombrevehiculo": "Ford GS",
"patente": "GSI-78955",
"nombregrupo": "Test1"
},
{
"id": "43531",
"numero": "0987654321",
"alias": "test_new_driver2",
"nombre": "Test Nombre 2",
"apellido": "New Driver 2",
"identificador": "TEST89956156",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR002",
"licencia": "78979TEST1232",
"vigencia": "2022-05-15",
"direccion": "test de domicilio de conductor test2",
"email": "test2@test.com",
"idvehiculo": "37923",
"idgrupo": "11",
"observaciones": "creacion de conductor test2",
"idgrupo_conductor": "11",
"nombrevehiculo": "KIA IZURIETA",
"patente": "GSI-7206",
"nombregrupo": "Test2"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único asignado al conductor.
Entero
numero
Código interno para identificar al conductor.
Cadena de texto
alias
Nombre alterno para identificar al conductor.
Cadena de texto
nombre
Nombre del conductor.
Cadena de texto
apellido
Apellido del conductor.
Cadena de texto
identificador
Código de iButton o RFID asignado al conductor.
Cadena de texto
fecha_alta
Fecha en que se creó el conductor en el sistema.
Date (aaaa-mm-dd)
telefono
Identificador único de la ruta en el sistema.
Cadena de texto
cedula
Número de cédula.
Cadena de texto
licencia
Número de licencia.
Cadena de texto
vigencia
Fecha en que expira la licencia del conductor.
Date (aaaa-mm-dd)
direccion
Ubicación del domicilio del conductor.
Cadena de texto
email
E-mail de contacto del conductor.
Cadena de texto
idvehiculo
Id del vehículo asignado al conductor.
Entero
idgrupo
Id del grupo al que pertenece el conductor.
Entero
observaciones
Observaciones realizadas por el operador.
Cadena de texto
idgrupo_conductor
Identificador del grupo que pertenece el conductor.
Entero
nombrevehiculo
Nombre del vehículo.
Cadena de texto
patente
Patente del vehículo.
Cadena de texto
nombregrupo
Nombre del grupo al que pertenece el conductor.
Cadena de texto
Listar catálogo de grupos de conductores - driverGetGroups
POST https://api.service24gps.com/api/v1/driverGetGroups
Obtiene el catálogo de los grupos de conductores del cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/driverGetGroups' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"143": "Conductores Sur",
"160": "Conductores Centrales",
"172": "Conductores Estacion Oriente",
"173": "Conductores Estacion Poniente"
}
}
Listar conductor por licencia - getDriverByIdCard
POST https://api.service24gps.com/api/v1/getDriverByIdCard
Obtiene la información del conductor por el parámetro licencia.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
licencia
Número de licencia.
78979TEST123
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getDriverByIdCard' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'\
--form 'licencia="78979TEST123"'\
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "43530",
"numero": "0987654321",
"alias": "test_new_driver",
"nombre": "Test Nombre",
"apellido": "New Driver",
"identificador": "TEST0987654NWD",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR001",
"licencia": "78979TEST123",
"vigencia": "2022-05-14",
"direccion": "test de domicilio de conductor test",
"email": "test@test.com",
"idvehiculo": "37922",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test1",
"usuario": "driver_test1",
"password": "cGFzczEyMw=="
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único asignado al conductor.
Entero
numero
Código interno para identificar al conductor.
Cadena de texto
alias
Nombre alterno para identificar al conductor.
Cadena de texto
nombre
Nombre del conductor.
Cadena de texto
apellido
Apellido del conductor.
Cadena de texto
identificador
Código de iButton o RFID asignado al conductor.
Cadena de texto
fecha_alta
Fecha en que se creó el conductor en el sistema.
Date (aaaa-mm-dd)
telefono
Identificador único de la ruta en el sistema.
Cadena de texto
cedula
Número de cédula.
Cadena de texto
licencia
Número de licencia.
Cadena de texto
vigencia
Fecha en que expira la licencia del conductor.
Date (aaaa-mm-dd)
direccion
Ubicación del domicilio del conductor.
Cadena de texto
email
E-mail de contacto del conductor.
Cadena de texto
idvehiculo
Id del vehículo asignado al conductor.
Entero
idgrupo
Id del grupo al que pertenece el conductor.
Entero
nombregrupo
Nombre del grupo al que pertenece el conductor.
Cadena de texto
observaciones
Observaciones realizadas por el operador.
Cadena de texto
usuario
Usuario del conductor.
Cadena de texto
password
Contraseña del conductor.
Cadena de texto
Distribuidor
Métodos / endpoints exclusivos para cuando el apikey es a nivel distribuidor.
Obtener la lista de todos los clientes - getClients
POST https://api.service24gps.com/api/v1/getClients
Obtiene el listado de todos los clientes del distribuidor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getClients' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "10",
"nombre": "cliente 1",
"es_suspendido": "0",
"razon_social": "cliente sa de cv",
"cuit_rfc": "cliente01",
"ciudad": "Puebla",
"domicilio": "Avenida principal",
"telefonos": "1343243241",
"contactos": "Test1 2245789645",
"email": "cliente01@gmail.com",
"last_update": "2021-12-09 15:15:16",
"fecha_suspendido": "0000-00-00",
"es_activo": "1"
},
{
"id": "11",
"nombre": "cliente 2",
"es_suspendido": "1",
"razon_social": "cliente 2 sa de cv",
"cuit_rfc": "cliente02",
"ciudad": "Monterrey",
"domicilio": "Avenida central",
"telefonos": "3245643",
"contactos": "Test2 5589568989",
"email": "cliente02@gmail.com",
"last_update": "2021-12-17 10:41:25",
"fecha_suspendido": "0000-00-00",
"es_activo": "1"
},
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del cliente
Entero
nombre
Nombre asignado al cliente
Texto
es_suspendido
Bandera o estado si está o no suspendido,.
1 = suspendido
0 = no suspendido
Booleano
razon_social
Razón social del cliente
Texto
cuit_rfc
RFC del cliente
Texto
ciudad
Ciudad de dónde es el cliente
Texto
domicilio
Domicilio o dirección de dónde es el cliente
Texto
telefonos
Teléfono(s) del cliente
Texto
contactos
Contacto(s) del cliente
Texto
email
Correo electrónico del cliente
Texto
last_update
Fecha Hora de la última actualización del cliente
FechaHora
fecha_suspendido
Fecha de cuándo se suspendió el cliente
Fecha
es_activo
Bandera o estado si está activo o no el cliente.
1 = activo
0 = no activo
Booleano
Crea o actualiza un cliente - setClient
POST https://api.service24gps.com/api/v1/setClient
Crea o actualiza un cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e7
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente
(Opcional) Identificador único del cliente. Sólo cuando se va actualizar.
11
nombre
(Requerido) Nombre que va tener el cliente.
Test nombre
razon_social
(Requerido) Razón social del cliente.
Test Razon Social
idzona_horaria
(Opcional) Identificador único de la zona horaria - Obtener los tipos en el método getTimeZone .
1
IdTipo_informacion_tributaria
(Opcional) Identificador del tipo de información tributaria.
- Si no requiere tipo, se asigna 0
- Obtener los tipos en el método getTypesTax .
5
email
(Requerido) Correo del cliente.
test@test.com
rfc
(Opcional) RFC del cliente.
RFC0123456789
ciudad
(Opcional) Ciudad de dónde es el cliente.
Puebla
domicilio
(Opcional) Domicilio o dirección del cliente.
Test domicilio
codpostal
(Opcional) Código postal de la ubicación del cliente.
72111
contactos
(Opcional) Datos del contacto.
test contacto
telefonos
(Opcional) Teléfono(s) para contactar al cliente.
2228562144
descripcion
(Opcional) Alguna descripción o información del cliente.
Test Cliente Descripcion
Solicitud de ejemplo crear un cliente:
curl --location 'https://api.service24gps.com/api/v1/setClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test nombre"' \
--form 'razon_social="Test Razon Social"' \
--form 'idzona_horaria="1"' \
--form 'IdTipo_informacion_tributaria="5"' \
--form 'email="test@test.com"' \
--form 'rfc="RFC0123456789"' \
--form 'ciudad="Puebla"' \
--form 'domicilio="Test domicilio"' \
--form 'codpostal="72111"' \
--form 'contactos="test contacto "' \
--form 'telefonos="2228562144"' \
--form 'descripcion="Test Cliente Descripcion"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Solicitud de ejemplo editar un cliente:
curl --location 'https://api.service24gps.com/api/v1/setClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcliente="11"' \
--form 'nombre="Test nombre"' \
--form 'razon_social="Test Razon Social"' \
--form 'idzona_horaria="1"' \
--form 'IdTipo_informacion_tributaria="5"' \
--form 'email="test@test.com"' \
--form 'rfc="RFC0123456789"' \
--form 'ciudad="Puebla"' \
--form 'domicilio="Test domicilio"' \
--form 'codpostal="72111"' \
--form 'contactos="test contacto "' \
--form 'telefonos="2228562144"' \
--form 'descripcion="Test Cliente Descripcion"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del cliente
Entero
Suspender cliente - allowClient
POST https://api.service24gps.com/api/v1/allowClient
Suspende un cliente.
Ver parámetros de solicitud:
Parámetros
Parámetros
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idclient
Identificador único del cliente.
11
sino_suspend
Valor a actualizar:
1 = suspende
0 = activa
1
razon_suspend
Razón, motivo o causa del porque se suspende.
motivo test
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/allowClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idclient="12"' \
--form 'sino_suspend="1"' \
--form 'razon_suspend="motivo test"'
Respuesta de ejemplo:
{
"status": 200,
"data": "OK"
}
Obtener usuarios de algún cliente - getUsers
POST https://api.service24gps.com/api/v1/getUsers
Obtiene el listado de los usuarios de un cliente en específico.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente
Identificador único del cliente
11
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getUsers' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcliente=11'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "156211",
"nombre": "user01",
"usuario": "usuario primero",
"es_activo": "1",
"last_update": "2021-11-08 17:05:14",
"last_update_password": "",
"loginas": "https://plataforma.service24gps.com/loginas/cred;WE49hX5TngeG8z3kk0yZW_rljZbkHVuEBD9taqOPcD5gaIL4xm-WZ8XdSWN6Mr6_66444443333U_EGEsWd9VqvyZl6msm1MBy4VCTDUizCirgUgTQ34n24BSVV9XkEUfnenPTJuRBEknIJvg11gfdSynXkQ,,"
},
{
"id": "516311",
"nombre": "user02",
"usuario": "usuario dos",
"es_activo": "1",
"last_update": "2022-01-17 22:59:47",
"last_update_password": "",
"loginas": "https://plataforma.service24gps.com/loginas/cred;WE49hX5TngeG8z3kk0yZW_rljZbkHVuEykhXihWJj-EDJb15YcPikU0LbWRv1cl4qjOZXxY444444999128888909T_GgiTA80qFYb1MvsFKv_e7-_-VzWoTXSpqDnwTJ462DHabbD2v7o2RdstNM62wEHbxLclgfzbpLJ2LFnWHQXuXo"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del usuario
Entero
nombre
Nombre asignado al usuario
Texto
usuario
Nombre del usuario, para después iniciar sesión en plataforma
Texto
last_update
Fecha hora de la última actualización del usuario
FechaHora
last_update_password
Fecha hora de la última actualización de la contraseña del usuario
FechaHora
es_activo
Bandera o estado si está activo o no el cliente, 1 = activo, 0 = no activo
Booleano
loginas
Link o url para el inicio de sesión de la plataforma
Texto
Obtener la información del usuario - getMyUser
POST https://api.service24gps.com/api/v1/getMyUser
Obtener la información del usuario y cliente referente al token que se está utilizando.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken o token devuelto por plataforma.
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getMyUser' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SJx5eXC7PtGHwHcSY8O8DVLVjXycEFKiQ/kQ9A3NcWfiy7iqrjrkVw=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"iduser": "11",
"user": "user_01",
"nameuser": "Usuario uno",
"idclient": "12",
"nameclient": "Empresa SA de CV"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
iduser
Identificador único del usuario en plataforma.
Entero
idcliente
Identificador único del cliente en plataforma.
Entero
nameuser
Nombre del usuario en plataforma.
Cadena de Texto
nameclient
Nombre del cliente en plataforma.
Cadena de Texto
user
Usuario para ingresar a plataforma.
Cadena de Texto
Crea o actualiza un usuario - setUser
POST https://api.service24gps.com/api/v1/setUser
Crea o actualiza un usuario.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idusuario
(Opcional) Identificador único del usuario. Sólo cuando se va actualizar.
1
nombre
(Requerido) Nombre que va tener el usuario.
User 111
user
(Requerido) Usuario con el que se va autenticar.
user_111
password
(Requerido) Contraseña para el usuario.
123456
email
(Requerido) Correo electrónico del usuario.
user111@gmail.com
idcliente
(Requerido) Identificador único del cliente al que va pertenecer el usuario.
11
idzona_horaria
(Opcional) Identificador único de la zona horaria. - Obtener los tipos en el método getTimeZone .
1
parar_motor
(Opcional) Activar comando de paro de motor. 1 = Si 0 = No
0
enviar_sms
(Opcional) Enviar comando y alertas por SMS. 1 = Si 0 = No
0
cargar_geocercas_al_inicio
(Opcional) Cargar geocercas al inicio de cada sesión. 1 = Si 0 = No
1
Solicitud de ejemplo crear un usuario:
curl --location 'https://api.service24gps.com/api/v1/setUser' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="User 111"' \
--form 'user="user_111"' \
--form 'password="123456"' \
--form 'email="user111@gmail.com"' \
--form 'idcliente="11"' \
--form 'idzona_horaria="1"' \
--form 'parar_motor="0"' \
--form 'enviar_sms="0"' \
--form 'cargar_geocercas_al_inicio="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": 1
}
Solicitud de ejemplo editar un usuario:
curl --location 'https://api.service24gps.com/api/v1/setUser' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idusuario="1"' \
--form 'nombre="User 111"' \
--form 'user="user_111"' \
--form 'password="123456"' \
--form 'email="user111@gmail.com"' \
--form 'idcliente="11"' \
--form 'idzona_horaria="1"' \
--form 'parar_motor="0"' \
--form 'enviar_sms="0"' \
--form 'cargar_geocercas_al_inicio="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": 1
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del usuario
Entero
Crear Activo - createAsset
POST https://api.service24gps.com/api/v1/createAsset
Crea un activo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e7
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
(Requerido) Nombre que va tener el activo.
Test nombre
tipo_vehiculo
(Requerido) Identificador único del tipo del activo. - Obtener los tipos en el método getVehiclesType .
1
marca
(Opcional) Identificador único de marca del activo. - Obtener los tipos en el método getVehiclesBrands .
1
modelo
(Requerido) Modelo del activo.
Mazda
anio
(Opcional) Año del activo.
2017
patente
(Opcional) Patente del activo.
test123
idcliente
(Opcional) Identificador único del cliente.
11
equipo_gps
(Requerido) Equipo GPS del activo.
123456789
color
(Opcional) Color del activo.
Negro
numero_serie
(Opcional) Número de serie del activo.
55500056544
numero_motor
(Opcional) Número de motor del activo.
M211
numero_economico
(Opcional) Número económico del activo.
0227
rendimiento_combustible
(Opcional) Rendimiento del combustible.
0
Solicitud de ejemplo crear un activo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createAsset' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test nombre"' \
--form 'tipo_vehiculo="1"' \
--form 'marca="1"' \
--form 'modelo="Mazda"' \
--form 'anio="2017"' \
--form 'patente="test123"' \
--form 'idcliente="11"' \
--form 'equipo_gps="123456789"' \
--form 'color="Negro"' \
--form 'numero_serie="55500056544"' \
--form 'numero_motor="M211"' \
--form 'numero_economico="0227"' \
--form 'rendimiento_combustible="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": "194311"
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del activo.
Entero
Actualizar un Activo - updateAsset
POST https://api.service24gps.com/api/v1/updateAsset
Actualiza información de un activo.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idvehiculo
(Requerido) Identificador único del vehículo a actualizar.
11
nombre
(Requerido) Nombre que va ocupar el vehículo.
Activo 01
modelo
(Opcional) Nombre del modelo del vehículo.
Ibiza
anio
(Opcional) Año del vehículo.
2021
numero_economico
(Opcional) Número económico del vehículo.
2
estado
(Requerido) Bandera, para establecer si está activo o no el vehículo: 1 = Activo
0 = No activo
1
patente
(Opcional) Placa o patente del vehículo.
XX-AAA-10
patente_caja
(Opcional) Placa o patente del vehículo, si tiene caja o remolque.
XX-AAA-11
color
(Opcional) Color del vehículo.
Rojo
rendimiento_combustible
(Opcional) El rendimiento del combustible del vehículo.
1
numero_serie
(Opcional) El número de serie del vehículo.
SERIE-XXX-10
numero_motor
(Opcional) Número de motor del vehículo.
MOTOR-XXX-11
equipo_gps
(Requerido) Nombre del equipo GPS del activo. Ver en endpoint: getDevices
123123123156
Nota: El equipo_gps no debe estar asignado a otro activo, debe estar disponible.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateAsset' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'idvehiculo="11"' \
--form 'nombre="Activo 01"' \
--form 'model="Ibiza"' \
--form 'anio="2021"' \
--form 'numero_economico="11"' \
--form 'estado="1"' \
--form 'patente="XX-AAA-10"' \
--form 'patente_caja="XX-AAA-11"' \
--form 'color="Rojo"' \
--form 'rendimiento_combustible="1"' \
--form 'numero_serie="SERIE-XXX-10"' \
--form 'numero_motor="MOTOR-XXX-11"' \
--form 'equipo_gps="123123123156"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del vehículo
Entero
Crear relación activo con cliente - addAssetByClient
POST https://api.service24gps.com/api/v1/addAssetByClient
Crea la relación de un activo con un cliente.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idvehiculo
(Requerido) Identificador único del vehículo.
110011
idcliente
(Opcional) Identificador único del cliente
42106
cliente
(Requerido) Nombre del cliente
User Test
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/addAssetByClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'idvehiculo="110011"' \
--from 'idcliente="42106"' \
--form 'cliente="User Test"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Obtener el listado de las compañías celulares - getCompaniasCelular
POST https://api.service24gps.com/api/v1/getCompaniasCelular
Obtiene el listado de todos las compañías de celular, para utilizar alguna cuando se edite o modifique una tarjeta sim.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getCompaniasCelular' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Movistar",
"2": "Telcel",
"6": "Personal",
"7": "Claro",
"8": "Entel",
"10": "NEXTEL",
"11": "Vodafone",
"12": "TIM",
"13": "TIGO",
"14": "TURKCELL",
"15": "Orange",
"16": "IUSACELL",
"17": "T-Mobile",
"18": "UNITEL",
"19": "Vodacom",
"20": "Optimus",
"21": "Digicel",
"22": "Vivo",
"23": "DIGITEL",
"24": "Elisa",
"25": "ETB",
"26": "Mas Movil",
"27": "KOLBI",
"28": "Avantel",
"29": "T-Mobile",
"30": "Emnify",
"31": "CNT Ecuador",
"32": "F2M",
"33": "bitel",
"34": "Cable Wireless Panama",
"35": "NETT2",
"36": "Bueno Cell",
"37": "AT&T",
"38": "Telefonica",
"39": "Bismark",
"40": "Movilnet",
"41": "Movilnet",
"42": "Matooma",
"43": "Things Mobile",
"44": "POST",
"45": "m2m express",
"46": "IglobalSat",
"47": "M2MDataGlobal",
"48": "WOM",
"49": "Móvil Éxito",
"50": "UffMovil",
"51": "Virgin Mobile",
"52": "UNE",
"53": "Directv",
"54": "Truphone",
"55": "Oi",
"56": "Algar",
"57": "Olivia"
}
}
Obtener las tarjetas sim (chips telefónicos) - getSims
POST https://api.service24gps.com/api/v1/getSims
Obtiene el listado de todas mis tarjetas sims o chips telefónicos.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getSims' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "1155",
"nombre": "sim 1",
"compania": "Telcel",
"numero": "2913403402",
"nip": "123456789012345",
"notas": "este es la primer sim de telcel",
"fecha_alta": "2021-01-28",
"mb_plan": "0",
"es_prepago": "0"
},
{
"id": "1156",
"nombre": "sim 2",
"compania": "Movistar",
"numero": "324234234234",
"nip": "123456789012312",
"notas": "",
"fecha_alta": "",
"mb_plan": "5",
"es_prepago": "1"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la tarjeta sim
Entero
nombre
Nombre asignado a la tarjeta sim
Texto
compania
Nombre de la compañía de la tarjeta sim
Texto
numero
Número de la tarjeta sim
Entero
nip
Número personal de la tarjeta sim
Entero
notas
Descripción para la tarjeta sim
Texto
fecha_alta
Fecha de cuando se creó la tarjeta sim
Fecha
mb_plan
Megabytes del plan (sólo si tiene)
Entero
es_prepago
Bandera o estado si de prepago la tarjeta sim, 1 = prepago, 0 = no prepago
Booleano
Crea o actualiza una tarjeta sim (chip telefónico) - setSim
POST https://api.service24gps.com/api/v1/setSim
Crea o actualiza una tarjeta sim. * Campos requeridos.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idsim
Identificador único de la tarjeta sim.
Sólo cuando se va actualizar.
11
nombre
Nombre que va tener la tarjeta sim *
Sim 01
nro_tel
Número telefónico de la tarjeta sim *
2224567810
nro_nip
NIP de la tarjeta sim *
1120
id_compania
Identificado único de la compania (Se obtiene del endpoint: getCompaniasCelular )
2
es_prepago
Bandera, para establecer si es prepago o no.
1 = Prepago
2 = No prepago
1
notas
Descripción o información extra de las notas
Esta es mi sim 01
mb_plan
Cantidad de megabytes en el plan
10
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/setSim' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Sim 01"' \
--form 'nro_tel="2224567810"' \
--form 'nro_nip="1120"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la tarjeta sim
Entero
Insertar datos de dispositivo - insertPositionData
POST https://api.service24gps.com/api/v1/insertPositionData
Basado en el documento de protocolo de comunicación service24gps. Para ingresar información en los reportes del equipo GPS y se muestre en la plataforma, tanto en el detalle nuevo del activo como en los eventos y/o alertas.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw==
imei
(Requerido) Identificador único / imei del dispositivo gps.
6d7b91026765abcd
checksum
(Requerido) Primeros 4 caracteres del md5 de reports.
e71a
reports
(Requerido) String en formato json de ubicaciones
[ { "stamp": "20220502184600", "latlng": "4.6892583,-74.1159799", "direction": 0, "speed": 0,
"sig": 10,
"satellites": 15, "event": 1, "battery": 40,
"bat": 100,
"odm": 500,
"bato": 50,
"acc": 1,
"alt": "10",
} ]
Nota: reports es un array de objetos, así sea un solo reporte debe estar dentro de un array.
Ver tabla de parámetros reports:
Parámetros
Descripción
Ejemplo
stamp
(Requerido) Fecha y hora en GMT 0.
"stamp": "20230510235500"
latlng
(Requerido) Latitud y longitud.
"latlng": "4.6892583,-74.1159799"
direction
(Requerido) Dirección.
"direction": 0
speed
(Requerido) Velocidad del dispositivo.
"speed": 0
sig
(Opcional) Señal GSM. Entre 0-10
"sig": 10
satellites
(Requerido) Satélite.
"satellites": 15
event
(Requerido) Tipo de evento.
Ejemplo:
1: Ubicación
2: Botón SigMen Obtener listado de eventos en getEventTypes
"event": 1
battery
(Requerido) Batería del dispositivo. Entre 0 - 100 %
"battery": 40
bato
(Opcional) Batería Vehículo. Entre 0 - 100 volts
"bato": 100
acc
(Opcional) Estado de ignición. Ejemplo:
1: Encendido
0: Apagado
"acc": 1
odm
(Opcional) Odómetro.
"odm": 500
alt
(Opcional) Altitud.
"alt": "10"
ad
(Opcional) Información adicional para el envió de información de sensores en formato JSON.
"ad": {
"t1": 25.5,
"h1": 10,
"h2": 1
}
infoextra
(Opcional) Información extra para el dispositivo en formato JSON.
"infoextra": {
"qr_buffer": "0",
"qr_idProceso": "2971599",
"qr_uid": "MiLugar1"
}
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/insertPositionData' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw=="' \
--form 'imei="6d7b91026765abcd"' \
--form 'checksum="e71a"' \
--form 'reports="[
{
\"stamp\":\"20220119235500\",
\"latlng\":\"4.6892583,-74.1159799\",
\"direction\":0,
\"speed\":0,
\"sig\":10,
\"satellites\":15,
\"event\":501,
\"battery\":40,
\"bat\":100,
\"odm\":500,
\"bato\":50,
\"acc\":1,
\"alt\":\"10\",
\"ad\": {
\"t1\": 25.5,
\"h1\": 10,
\"h2\": 1
}
}
]"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"checksum": "e71a",
"match_checksum": 1,
"received": 1,
"processed": 1,
"errors": []
}
}
Nota: La key " errors " es un array con todos los errores encontrados al procesar las tramas. En los errores se usa el mismo índice que en las tramas para relacionar en que reporte se originó.
Respuesta de ejemplo s i el checksum no coincide:
{
"status": 200,
"data": {
"checksum": "3824",
"match_checksum": 0
}
}
Tipos de formato en infoextra
Ver formatos:
Formato
Descripción
Nombre de la propiedad
Valor de la propiedad
Ejemplo
Tipo llave valor
Este formato solo se completa el nombre y el valor a mostrar, es un modo simple de agregar información.
Tiene la limitante que no se puede dar formato o interacción a esta información dentro de la plataforma.
"lampara 1"
"encendido"
"infoextra":{
"lampara 1": "encendido",
"lampara 2": "apagado",
"lampara 3": "encendido"
}
Tipo llave valor extendido
Este formato tiene mas opciones, donde podremos definir las acciones sobre los elementos que vera el cliente dentro del detalle del activo.
Llave:
(Requerido) label
(Requerido) value
(Opcional) unit
(Opcional) color
(Opcional) icon
(Opcional) href
(Opcional) onclick
"label"
"Litros"
"infoextra":{
"0":{
"label": "Litros",
"value": "11.12",
"unit": "litros",
"icon": "i-lock-2",
"color": "#987456",
"href": "https://example.com",
"onclick": "function_litro(_litro_)"
},
"1":{
"label": "Litros 2",
"value": "114.2",
"unit": "litros",
"icon": "i-lock-2",
"color": "#158456"
}
}
Tipo llave texto
Este formato sirve para mostrar un mensaje de tipo texto dentro de la plataforma.
Llave:
(Requerido) text
(Opcional) color
(Opcional) bgcolor
(Opcional) href
(Opcional) onclick
"text"
"Mensaje de prueba"
"infoextra":{
"0":{
"text": "Mensaje de prueba",
"color": "#987456",
"bcolor": "#284650",
"href": "https://example.com",
"onclick": "function_msg(_msg_)"
},
"1":{
"text": "Mensaje a plataforma",
"color": "#458756",
}
}
Solicitud de ejemplo con infoextra:
curl --location --request POST 'https://api.service24gps.com/api/v1/insertPositionData' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw=="' \
--form 'imei="6d7b91026765abcd"' \
--form 'checksum="e71a"' \
--form 'reports="[
{
\"stamp\": \"20220502184600\",
\"latlng\": \"4.6892583,-74.1159799\",
\"direction\": 0,
\"speed\": 0,
\"satellites\": 15,
\"event\": 501,
\"battery\": 4.013,
\"infoextra\":{
\"lampara 1\": \"encendido\",
\"lampara 2\": \"apagado\",
\"lampara 3\": \"encendido\"
},
}
]"'
Obtener equipos GPS - getDevices
POST https://api.service24gps.com/api/v1/getDevices
Obtiene el listado de los equipos.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getDevices' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "11",
"nombre": "351234567891920",
"tipo": "GPS",
"marca": "Android",
"modelo": "Android",
"imei": "0323292803",
"nro_telefonico": "5558795106",
"estado": "0",
"notas": "",
"idsim": "0",
"fecha_alta": "2020-11-17",
"idcliente_propietario": 0,
"cliente_propietario": ""
},
{
"id": "12",
"nombre": "7DD15E0CA5314A35B8D78DDC25424FEF",
"tipo": "GPS",
"marca": "Skypatrol",
"modelo": "TT8750",
"imei": "0555292803",
"nro_telefonico": "77521078401",
"estado": "1",
"notas": "",
"idsim": "11",
"fecha_alta": "2019-04-30",
"idcliente_propietario": 1,
"cliente_propietario": "Transportes del Sur"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del dispositivo
Entero
nombre
Nombre asignado al dispositivo, regularmente es el IMEI.
Texto
tipo
Tipo de dispositivo.
Texto
marca
Marca del dispositivo
Texto
modelo
Modelo del dispositivo
Texto
imei
Código pregrabado del dispositivo
Texto
numero telefónico
Número celular del dispositivo
Texto
estado
Bandera o estado si está activo o no el dispositivo, 1 = activo, 0 = no activo
Booleano
notas
Nota extra o descripción del dispositivo
Texto
idsim
Identificador único de la tarjeta sim (chip telefónico)
Entero
fecha_alta
Fecha de la alta del dispositivo
Fecha
idcliente_propietario
ID del cliente propietario del Activo
Entero
cliente_propietario
Nombre del cliente propietario del Activo
Texto
Crear un equipo GPS - createDevice
POST https://api.service24gps.com/api/v1/createDevice
Crear un equipo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e7
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
tipo_equipo
(Opcional) Tipo de equipo. - Obtener los tipos en el método getTypesDevices .
1
nombre
(Requerido) Nombre del equipo.
000123
imei
(Opcional) IMEI del equipo.
000123
marca
(Requerido) Marca del equipo. - Obtener los tipos en el método getBrands.
1
modelo
(Requerido) Modelo del equipo. - Obtener los tipos en el método getModels.
1
chip_telefonico
(Opcional) Número telefónico.
2222112233
idzona_horaria
(Opcional) Identificador único de la zona horaria.
- Obtener los tipos en el método getTimeZone .
1
idpais
(Opcional) Identificador único del país.
- Obtener los países en el método getCountrys
1
Solicitud de ejemplo crear un equipo:
curl --location 'https://api.service24gps.com/api/v1/createDevice' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e7"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'tipo_equipo="1"' \
--form 'nombre="000123"' \
--form 'imei="000123"' \
--form 'marca="1"' \
--form 'modelo="1"' \
--form 'chip_telefonico="2222112233"' \
--form 'idzona_horaria="1"' \
--form 'idpais="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": "000123"
}
Nota: Cuando supere el límite permitido para crear equipos se mostrará la siguiente respuesta.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 30700,
"message": "This is a Free account, it has exceeded the allowed limit of created devices"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
Nombre
Nombre del equipo.
Texto
Editar un equipo GPS - updateDevice
POST https://api.service24gps.com/api/v1/updateDevice
Actualiza un equipo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
iddevice
(Opcional) Identificador único del dispositivo a actualizar
11
idsim
(Opcional) Identificador único de la tarjeta sim (chip telefónico). Ver endpoint: getSims
9
nombre
(Requerido) Nombre que va ocupar el dispositivo, puede ser el imei del equipo, según el tipo de marca.
87198978126384923
tipo_equipo
(Opcional) Identificador único de los tipos disponibles. Ver en endpoint: getTypesDevices
1
marca
(Opcional) Identificador único de las marcas disponibles. Ver en endpoint: getBrands
2
modelo
(Opcional) Identificador único de los modelos disponibles. Ver en endpoint: getModels
1
estado
(Opcional) Bandera, para establecer si está activo o no el dispositivo.
1 = Activo
0 = No activo
0
imei
(Opcional) Imei del dispositivo
87198978126384923
notas
(Opcional) Descripción o texto extra para el dispositivo
Este es un dispositivo nuevo, de la marca Suntech
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateDevice' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'iddevice="11"' \
--from 'idsim="9"' \
--form 'nombre="87198978126384923"' \
--form 'tipo_equipo="1"' \
--form 'marca="1"' \
--form 'modelo="2"' \
--form 'estado="1"' \
--form 'imei="87198978126384923"' \
--form 'notas="Este es un dispositivo nuevo, de la marca Suntech"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del dispositivo
Entero
Obtener listado de marcas - getBrands
POST https://api.service24gps.com/api/v1/getBrands
Obtiene el listado de las marcas de los equipos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getBrands' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"133": "Zero one technology",
"299": "Zenda",
"150": "Yulongda technology limited",
"136": "Yuangeng",
"351": "Xmetra",
"239": "Xirgo",
"190": "Xintong technology co.",
"18": "Xexun",
"84": "Xact tecnology",
"127": "Wonde Proud Technology",
"151": "Wmcs",
"167": "Wireless links",
"350": "WanWayTech",
"314": "Vjoycar",
"290": "Vivotek",
"129": "Vic-zone"
}
}
Obtener listado de modelos - getModels
POST https://api.service24gps.com/api/v1/getModels
Obtiene el listado de los modelos de equipos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getModels' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"199": "G91S",
"200": "Sniper G797",
"201": "LELL-510",
"202": "Lell-520",
"203": "Lell-530",
"204": "STEPP II",
"205": "RS-1102",
"206": "RS-906",
"207": "RS-909",
"209": "PlugTrack",
"210": "UTP Navigator",
"211": "FORT-300",
"212": "Fort-111",
"213": "TK-106",
"214": "Bitrek",
"215": "Bitrek BI 310",
"216": "Back2you",
"217": "GPS Marker",
"218": "Progress 01",
"220": "Syrus",
"221": "Netvisor 11",
"222": "Evolution",
"223": "CR200",
"224": "Cello-F",
"225": "CelloTrack",
"226": "Compact CAN",
"943": "GV300W",
"227": "Compact Security",
"228": "Cello Can-IQ",
"229": "SmartOne",
"230": "SmartOne LP",
"231": "SmartOneB",
"232": "Gelix-2",
"233": "Gelix-3",
"234": "MasterKit BM8009"
}
}
Obtener listado de tipos de dispositivo - getTypesDevices
POST https://api.service24gps.com/api/v1/getTypesDevices
Obtiene el listado de tipos de dispositivos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getTypesDevices' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "GPS",
"2": "Alarma",
"3": "IoT",
"4": "DVR Fijo",
"5": "DVR Movil",
"7": "Tag Multisensor / Tag Sensor",
"8": "Reloj",
"10": "App Tracker Compartida",
"11": "App Tracker"
}
}
Obtener listado del detalle de un modelo de equipo - getDeviceDetail
POST https://api.service24gps.com/api/v1/getDeviceDetail
Obtiene el listado de la información detallada del modelo de un equipo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idmodelo
Identificador único del modelo del equipo a consultar. Los modelos disponibles en plataforma se obtienen en el método getModels .
1
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getDeviceDetail' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idmodelo="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "1",
"tipo_dispositivo": "Rastreador de Vehículos",
"protocolo": "AMBOS",
"entradas_salidas": "3/2",
"bateria": "Sí - Batería Interna",
"fabricante": "Skypatrol",
"fabricante_url": "http://www.skypatrol.com/",
"modelo": "TT8750",
"imagen": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSKLiiSDNg0P7pHeJQqnlMiqjjrruhVgHndKN1RiyLzCDn2kOIopnDTV3qR&s=10",
"caracteristicas": "
• Cuatribanda GSM (850 / 900 / 1800 / 1900 Mhz). • Sensor de movimiento y alertas vibratorias. • Diseñado para uso personal o vendedores. • Habilitado para actualizaciones remotas. • Programable con botón de pánico para emergencias. • Resistente al agua, estandar IPX5. • 10 a 12 días de rastreo con una sola carga.
",
"descripcion": "TT8750 es un potente localizador GPS, que está diseñado para los animales domésticos, vehículos y bienes de seguimiento. con sensibilidad de recepción superior, TTFF rápido y GSM frecuencias 850/900/1800/1900. Su ubicación puede ser en tiempo real o programar un seguimiento por el servidor back-end o terminales especificados. Sobre la base de la protocolo integrado, TT8750 puede comunicarse con el servidor de back-end a través de GPRS / GSM informes de la red, y la transferencia de Geo-cercas, el estado del dispositivo de emergencia y GPS programado posición.
",
"desc_corta": "El TT8750 es el dispositivo de seguimiento perfecto con GPS en tiempo real para aplicaciones compactas y encubiertas que requieren de 1 a 2 semanas de duracion de batería.
"
}
]
}
Datos del cliente - getClientData
POST https://api.service24gps.com/api/v1/getClientData
Este método devuelve la información del cliente que esta ocupando el apikey.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getClientData' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "1923322",
"nombre": "Salvador",
"razon_social": "Rastreo SA",
"cuit_rfc": "MAKA901104",
"ciudad": "CDMX",
"domicilio": "Moneda 43",
"codpostal": 08109,
"contactos": "Jose",
"telefonos": "5512345678",
"skype": "live:.cid.5970721b7712717127",
"email": "correo@example.com"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del cliente.
Entero
nombre
Nombre asignado al cliente.
Cadena de Texto
razon_social
Razón social del cliente.
Cadena de Texto
cuit_rfc
RFC (Registro Federal de Contribuyentes) del cliente.
Cadena de Texto
ciudad
Ciudad de origen del cliente.
Cadena de Texto
domicilio
Domicilio o dirección del cliente.
Cadena de Texto
codpostal
Código postal del cliente.
Cadena de Texto
contactos
Nombre de contacto(s) del cliente.
Cadena de Texto
telefonos
Número de contacto(s) del cliente.
Cadena de Texto
skype
Skype del cliente.
Cadena de Texto
email
Correo electrónico del cliente.
Cadena de Texto
Obtener los activos de un cliente - getClientAssetsInfo
POST https://api.service24gps.com/api/v1/getClientAssetsInfo
Obtiene el listado de los activos asignados a un cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idCliente
Identificador único del cliente.
11
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getClients' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idCliente="11"'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"imei": "86755328129212",
"dispositivo": "1743245914",
"sim": "331384054561792",
"nro_telefonico": "331384054561792",
"activo": "I8W-124",
"placa": "ABC-001",
"fecha_de_alta_sim": "2021-09-06",
"fecha_de_alta_imei": "2021-09-04",
"fecha_de_alta_activo": "2021-05-11",
"marca": "Suntech",
"modelo": "ST3310U",
"idvehiculo": "1277"
},
{
"imei": "96455328229202",
"dispositivo": "96455328229202",
"sim": "240453899",
"nro_telefonico": "240453899",
"activo": "J6Y-33",
"placa": "ABC-002",
"fecha_de_alta_sim": "2021-09-07",
"fecha_de_alta_imei": "2021-09-03",
"fecha_de_alta_activo": "2021-05-11",
"marca": "Suntech",
"modelo": "ST300A",
"idvehiculo": "7537"
},
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
imei
Imei del dispositivo
Texto
dispositivo
Nombre del dispositivo
Texto
sim
Nombre del chip telefónico o sim
Texto
nro_telefonico
Número del chip telefónico o sim
Texto
activo
Nombre del activo o vehículo
Texto
placa
Placa del vehículo.
Texto
fecha_de_alta_sim
Fecha de cuando se creó la sim en el sistema
Texto
fecha_de_alta_imei
Fecha de cuando se creó el dispositivo
Texto
fecha_de_alta_activo
Fecha de cuando se creó el activo/vehículo
Texto
marca
Nombre de la marca del dispositivo
Texto
modelo
Nombre del modelo del dispositivo
Texto
idvehiculo
Identificador único del vehículo
Texto
Listar tipos tributarios - getTypesTax
POST https://api.service24gps.com/api/v1/api/v1/getTypesTax
Obtiene el listado de los tipos de información tributaria.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getTypesTax' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "RFC",
"2": "CUIT",
"3": "NIT",
"4": "CPF",
"5": "RIF",
"6": "RUT",
"7": "RNC",
"8": "NIF",
"9": "SSN",
"10": "TIN",
"11": "P:IVA",
"12": "RUC",
"13": "RTU",
"14": "RTN",
"15": "CC",
"16": "CNPJ"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del tipo tributario.
Entero
nombre
Nombre del tipo tributario.
Texto
Crear cliente, usuarios, activos, equipos y tarjetas sim - createClientAndElements
POST https://api.service24gps.com/api/v1/createclientandelements
Este método permite crear cliente, usuarios, activos, equipos y tarjetas sim .
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw==
client
(Requerido) String en formato json de datos del cliente a crear
{ "city":"ciudad", "country_id":"2", "time_zone_id":"16", "state_id":"21", "postal_code":"72000", "phone":"1234567890", "email":"correo@host.com", "name":"nombre", "register_number":"numero registro", "business_name":"nombre", "full_address":"direccion", "custom_field":[ { "name":"nombre campo uno", "value":"valor uno" }, { "name":"nombre campo dos", "value":"valor dos" } ] }
users
(Requerido) String en formato json de datos para crear usuarios..
[ { "name": "nombre usuario", "username": "usuario", "password": "contraseña", "email": "correo@host.com", "assets": [ "placa" ], "profile_id": 1, "send_email_welcome": 1 }, { "name": "nombre usuario", "username": "usuario", "password": "contraseña", "email": "correo@host.com", "assets": [ "placa" ], "profile_id": 1, "send_email_welcome": 0 } ]
assets
(Requerido) String en formato json de datos para crear equipos, activos y sims
[
{ "asset": { "name": "activo", "plate": "placa", "asset_type_id": "1", "asset_brand_id": "5", "model": "2022", "year": "2022", "custom_field": [ { "name": "nombre campo uno", "value": "valor uno asset" }, { "name": "nombre campo dos", "value": "valor uno asset" } ] }, "device": { "device_type_id": "1", "name": "equipo", "imei_uid": "2022202220222022", "brand_id": "1", "model_id": "1", "time_zone_id": "16", "unlink_vehicle": "2023-01-01" }, "sim": { "name": "nombre", "company_id": "1", "phone_number": "12345678900", "nip_number": "123456" }, "IdSensors_template": 1415 } ]
Nota: users y assets son un array de objetos, así sea un solo elemento debe estar dentro de un array.
Ver tabla de parámetros client:
Parámetros
Descripción
Ejemplo
city
(Requerido) Ciudad.
"city": "ciudad"
country_id
(Requerido) Id pais.
"country_id": "2"
time_zone_id
(Requerido) Id zona horaria.
"time_zone_id":"16"
state_id
(Opcional) Estado.
"state_id":"21",
postal_code
(Opcional) Código postal.
"postal_code": 72000
phone
(Opcional) Teléfono.
"phone":"1234567890"
email
(Opcional) Correo electrónico.
"email":"correo@host.com"
name
(Requerido) Nombre.
"name":"nombre"
register_number
(Opcional) RFC.
"register_number":"numero registro"
business_name
(Opcional) Razón social.
"business_name":"nombre"
full_addres
(Opcional) Domicilio.
"full_address":"direccion"
custom_fields
(Opcional) Campos personalizados.
"custom_field":[ { "name":"nombre campo uno", "value":"valor uno" },
{ "name":"nombre campo dos", "value":"valor dos" } ]
Ver tabla de parámetros users:
Parámetros
Descripción
Ejemplo
name
(Opcional) Nombre del usuario.
"name": "nombre usuario"
username
(Requerido) Usuario.
"username": "usuario"
password
(Opcional) Contraseña.
"password": "contraseña"
email
(Requerido) Correo.
"email": "correo@host.com"
assets
(Opcional) activos.
"assets": [ "placa" ]
profile_id
(Opcional) Grupo sistema.
"profile_id": 1
send_email_welcome
(Opcional) Enviar correo de bienvenida.
"send_email_welcome": 0
Ver tabla de parámetros assets :
Parámetros
Descripción
Ejemplo
asset
(Requerido) String en formato json de vehículo
"name": "nombre usuario"
{ "name": "activo", "plate": "placa", "asset_type_id": "1", "asset_brand_id": "5", "model": "2022", "year": "2022", "custom_field": [ { "name": "nombre campo uno", "value": "valor uno asset" }, { "name": "nombre campo dos", "value": "valor uno asset" } ] }
device
(Requerido) String en formato json de Equipo.
{ "device_type_id": "1", "name": "equipo", "imei_uid": "202220222022202212055", "brand_id": "1", "model_id": "1", "time_zone_id": "16", "unlink_vehicle": "2023-01-01" }
sim
(Requerido) String en formato json de chip.
{ "name": "sim12055", "company_id": "1", "phone_number": "1234567890012055", "nip_number": "123456" }
IdSensors_template
(Opcional) Plantilla.
"IdSensors_template": 1415
Ver tabla de parámetros asset:
Parámetros
Descripción
Ejemplo
name
(Requerido) Nombre.
"name": "activo12055",
plate
(Requerido) Placa.
"plate": "placa"
asset_type_id
(Requerido) Id tipo.
"asset_type_id": "1"
marca
(Opcional) Id Marca.
"asset_brand_id": "5"
model
(Opcional) Modelo.
"model": "2022"
year
(Opcional) Año.
"year": "2022",
assets
(Opcional) Campos personalizados.
"custom_field": [ { "name":"nombre campo uno", "value":"valor uno asset" }, { "name":"nombre campo dos", "value":"valor uno asset" }]
Ver tabla de parámetros device:
Parámetros
Descripción
Ejemplo
device_type_id
(Requerido) Id tipo dispositivo.
"device_type_id": "1"
name
(Requerido) Nombre.
"name": "equipo"
imei_uid
(Opcional) Imei.
"imei_uid": "202220222022202212055"
brand_id
(Requerido) Id marca.
"brand_id": "1"
model_id
(Requerido) Id modelo.
"model_id": "1"
time_zone_id
(Opcional) Id zona horaria.
"time_zone_id": "16"
unlink_vehicle
(Opcional) Fecha.
"unlink_vehicle": "2023-01-01"
Ver tabla de parámetros sim:
Parámetros
Descripción
Ejemplo
name
(Requerido) Nombre.
"name": "sim12055"
company
(Opcional) Id compania.
"company_id": "1"
phone_number
(Requerido) Númeor de telefono.
"phone_number": "1234567890012055"
nip_number
(Opcional) nip.
"nip_number": "123456"
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/createclientandelements' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=bduahaoj4mpc5h67p39fn0ahh6' \
--data-urlencode 'token=SJx5eXC7PtSP98YutHgP/wc990+6mK+PFfw2RVblNgQx0PyoR1v/sg==' \
--data-urlencode 'client={
"city": "puebla",
"country_id": "2",
"time_zone_id": "16",
"state_id": "21",
"postal_code": "72810",
"phone": "12345678",
"email": "caguilar@navitrack.com",
"name": "apiprod1201",
"register_number": "clienteapi29c29",
"business_name": "cliente api",
"full_address": "Primer retorno de Osa Menor número 2, oficina 301, San Andrés Cholula, Puebla, México.",
"custom_field": [{"name":"Campo Personalizado 1","value":"Testing 1"},{"name":"Campo Personalizado 2","value":"Testing 2"}]
}' \
--data-urlencode 'users=[
{
"name": "nombre usuario",
"username": "usuario",
"password": "contraseña",
"email": "correo@host.com",
"assets": [
"placa"
],
"profile_id": 1,
"send_email_welcome": 1
},
{
"name": "nombre usuario",
"username": "usuario",
"password": "contraseña",
"email": "correo@host.com",
"assets": [
"placa"
],
"profile_id": 1,
"send_email_welcome": 0
}
]' \
--data-urlencode 'assets=[
{
"asset": {
"name": "activo",
"plate": "placa",
"asset_type_id": "1",
"asset_brand_id": "5",
"model": "2022",
"year": "2022",
"custom_field": [ {
"name":"nombre campo uno",
"value":"valor uno asset"
}, {
"name":"nombre campo dos",
"value":"valor uno asset"
}]
},
"device": {
"device_type_id": "1",
"name": "equipo",
"imei_uid": "2022202220222022",
"brand_id": "1",
"model_id": "1",
"time_zone_id": "16",
"unlink_vehicle": "2023-01-01"
},
"sim": {
"name": "nombre",
"company_id": "1",
"phone_number": "12345678900",
"nip_number": "123456"
},
"IdSensors_template": 1415
}
]' \
--data-urlencode 'apikey=f77c31ce81907cc5f0ecffeda60fb4f6'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"client": "Se creo el cliente apiprod1201",
"users": [
"Se creo el usuario nombre usuario",
"Se creo el usuario nombre usuario"
],
"sim": [
"Se creo la sim nombre"
],
"device": [
"Se creo el equipo 2022202220222022"
],
"assets": [
"Se creo el vehiculo activo"
]
}
}
Ver campos de respuesta:
Campo
Descripción
Tipo
client
Descripción cliente creado
JSON
users
Listado usuarios creados
JSON
sim
Listado tarjetas creadas
JSON
device
Listado equipos creados
JSON
assets
Listado activos creados
JSON
Obtiene el listado de zonas horarias - getTimeZone
POST https://api.service24gps.com/api/v1/getTimeZone
Obtiene el listado de zonas horarias (GMT).
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getTimeZone' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "GMT+00:00",
"2": "GMT+01:00",
"3": "GMT+02:00",
"4": "GMT+03:00",
"5": "GMT+04:00",
"6": "GMT+05:00",
"7": "GMT+06:00",
"8": "GMT+07:00",
"9": "GMT+08:00",
"10": "GMT+09:00",
"11": "GMT+10:00",
"12": "GMT-01:00",
"13": "GMT-02:00",
"14": "GMT-03:00",
"15": "GMT-04:00",
...
}
}
Obtiene el listado tipos de activos - getVehiclesType
POST https://api.service24gps.com/api/v1/getVehiclesType
Obtiene el listado tipos de vehículos.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getVehiclesType' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Automovil",
"2": "PickUp",
"3": "Camion",
"4": "Camioneta",
"5": "Colectivo",
"6": "Ambulancia",
"7": "Bicicleta",
"8": "Peaton",
"9": "Moto",
"10": "Autobus",
"11": "Grua",
"12": "Normal",
"13": "Rampa",
"14": "Grande",
"15": "Ergodinamica",
...
}
}
Obtiene el listado marcas de activos - getVehiclesBrands
POST https://api.service24gps.com/api/v1/getVehiclesBrands
Obtiene el listado marcas de activos.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getVehiclesBrands' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Ford",
"2": "Fiat",
"3": "Peugeot",
"4": "Mercedes Benz",
"5": "Volkswagen",
"6": "Renault",
"7": "Chevrolet",
"8": "Nissan",
"9": "Volvo",
"10": "Irizar",
"11": "Dodge",
"12": "Toyota",
"13": "Kenworth",
"14": "Jeep",
"15": "Hyundai",
...
}
}
Eliminar Activo - deleteAsset
POST https://api.service24gps.com/api/v1/deleteAsset
Éste método permite eliminar un activo específico. Se elimina también el equipo asignado al activo y se quita de los permisos en clientes y/o usuarios.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
asset_id
(Requerido) Identificador único del Activo en el sistema.
123456
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteAsset' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'asset_id="123456"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si no existe el registro del Activo se mostrará un mensaje de error.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 40100,
"message": "The vehicle does not exist"
}
}
Eliminar equipo GPS - deleteDevice
POST https://api.service24gps.com/api/v1/deleteDevice
Este método permite eliminar un Equipo GPS especifico y los Activos asociados al equipo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
device_id
(Requerido) Identificador único del Equipo GPS en el sistema. El identificador se puede obtener en el método getDevices.
123456
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteDevice' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'device_id="123456"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si no existe el registro del Equipo GPS se mostrará un mensaje de error.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 40100,
"message": "The GPS device does not exist"
}
}
Obtiene el listado de paises - getCountrys
POST https://api.service24gps.com/api/v1/getCountrys
Obtiene el listado de países.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getCountrys' \
--form 'apikey="9e815ce8b91e40379407320cd0a13a98"' \
--form 'token="dS4cs7M/gkR8in6Y5Jd3KLO9qKBO4btc4wFTmb69JfVDslam2j+vJw=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Argentina",
"2": "México",
"4": "Republica Dominicana",
"5": "Bolivia",
"6": "Brasil",
"7": "Chile",
"8": "Colombia",
"9": "Costa Rica",
"10": "Ecuador",
"11": "El Salvador",
"12": "EEUU",
"13": "Guatemala",
"15": "Honduras",
"16": "Nicaragua",
"17": "Panama",
"18": "Paraguay",
"19": "Peru",
"20": "Uruguay",
...
}
}
Listar conductores - driverGetAll
POST https://api.service24gps.com/api/v1/driverGetAll
Obtiene la lista de todos los conductores que pertenecen a los clientes del distribuidor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
licencia
(Opcional) Número de Licencia.
123456
Nota: Si requiere solo la información de un conductor en especifico, debe mandar en la solicitud el parámetro licencia con el número de licencia que tiene asignado el conductor.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/driverGetAll' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "43530",
"numero": "0987654321",
"alias": "test_new_driver",
"nombre": "Test Nombre",
"apellido": "New Driver",
"identificador": "TEST0987654NWD",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR001",
"licencia": "78979TEST123",
"vigencia": "2022-05-14",
"direccion": "test de domicilio de conductor test",
"email": "test@test.com",
"idvehiculo": "37922",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test1",
"cliente": "DEMO Cliente 1",
"usuario": "driver_test1",
"password": "cGFzczEyMw==",
"idcliente": "6660"
},
{
"id": "43531",
"numero": "0987654321",
"alias": "test_new_driver2",
"nombre": "Test Nombre 2",
"apellido": "New Driver 2",
"identificador": "TEST89956156",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR002",
"licencia": "78979TEST1232",
"vigencia": "2022-05-15",
"direccion": "test de domicilio de conductor test2",
"email": "test2@test.com",
"idvehiculo": "37923",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test2",
"cliente": "DEMO Cliente 2",
"usuario": "driver_test2",
"password": "g7z8zGFzcyM78=",
"idcliente": "6661"
},
{
"id": "43532",
"numero": "098765432133",
"alias": "test_new_driver3",
"nombre": "Test Nombre 3",
"apellido": "New Driver 3",
"identificador": "TEST895662563",
"fecha_alta": "2022-02-25",
"telefono": "1234567890",
"cedula": "FSGBSTR003",
"licencia": "78979TEST1233",
"vigencia": "2022-06-15",
"direccion": "test de domicilio de conductor test3",
"email": "test3@test.com",
"idvehiculo": "37924",
"idgrupo": "0",
"nombregrupo": "",
"observaciones": "creacion de conductor test3",
"cliente": "DEMO Cliente 3",
"usuario": "driver_test3",
"password": "c789epczEyM78=",
"idcliente": "6662"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único asignado al conductor.
Entero
numero
Código interno para identificar al conductor.
Cadena de texto
alias
Nombre alterno para identificar al conductor.
Cadena de texto
nombre
Nombre del conductor.
Cadena de texto
apellido
Apellido del conductor.
Cadena de texto
identificador
Código de iButton o RFID asignado al conductor.
Cadena de texto
fecha_alta
Fecha en que se creó el conductor en el sistema.
Date (aaaa-mm-dd)
telefono
Identificador único de la ruta en el sistema.
Cadena de texto
cedula
Número de cédula.
Cadena de texto
licencia
Número de licencia.
Cadena de texto
vigencia
Fecha en que expira la licencia del conductor.
Date (aaaa-mm-dd)
direccion
Ubicación del domicilio del conductor.
Cadena de texto
email
E-mail de contacto del conductor.
Cadena de texto
idvehiculo
Id del vehículo asignado al conductor.
Entero
idgrupo
Id del grupo al que pertenece el conductor.
Entero
nombregrupo
Nombre del grupo al que pertenece el conductor.
Cadena de texto
observaciones
Observaciones realizadas por el operador.
Cadena de texto
cliente
Nombre del cliente al que pertenece el conductor
Cadena de texto
usuario
Usuario del conductor.
Cadena de texto
password
Contraseña del conductor.
Cadena de texto
idcliente
Id del cliente al que pertenece el conductor
Entero
Listar vehículos - vehicleGetAllComplete
POST https://api.service24gps.com/api/v1/vehicleGetAllComplete
Este método devuelve el listado de los vehículos.
IMPORTANTE: No recomendamos utilizar este método para consultar de forma recurrente las posiciones de todos los Activos. Si necesitas recibir continuamente la información reportada por tus Activos en un sistema externo, utiliza un Web Service genérico .
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/vehicleGetAllComplete' \
--header 'Cookie: PHPSESSID=6g5p2n9vso19j8vgdc9fcuind1' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "86630",
"nombre": "Guardia 1",
"patente": "Gua-123",
"idgps": "APPSHARED42201644869554060",
"gatewayip": "107.170.254.11",
"conductor": "",
"grupo": null,
"marca": null,
"modelo": "",
"color": "",
"anio": "0",
"numero_serie": "",
"num_economico": "",
"tipo_vehiculo": "Peaton",
"icono_vehiculo": "/commons/svg/3d_micro.php?c=CC83ED&grados=235",
"ignorar_equipo": "0",
"idequipo_gps": "196982",
"idtipo_vehiculo": "8",
"idmarca_vehiculo": "0",
"idconductor": "0",
"idgrupo_vehiculo": "0",
"idclientepropietario": "6661",
"clientepropietario": "DEMO Cliente 2"
},
{
"id": "86966",
"nombre": "Patrulla guardia 1",
"patente": "XTX-123",
"idgps": null,
"gatewayip": null,
"conductor": "",
"grupo": "Grupo Guardias",
"marca": "Volkswagen",
"modelo": "Polo",
"color": "",
"anio": "2018",
"numero_serie": "1234567890",
"num_economico": "uh43",
"tipo_vehiculo": "Automovil",
"icono_vehiculo": "./Iconos/Vehiculos/new_668_android-phone-color.png",
"ignorar_equipo": null,
"idequipo_gps": "121992",
"idtipo_vehiculo": "1",
"idmarca_vehiculo": "5",
"idconductor": "0",
"idgrupo_vehiculo": "5457",
"idclientepropietario": "6660",
"clientepropietario": "DEMO Cliente 1"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del vehículo.
Entero
nombre
Nombre asignado al vehículo
Cadena de Texto
patente
Patente del vehículo
Cadena de Texto
idgps
identificador gps
Cadena de Texto
gatewayip
ip del gateway
Cadena de Texto
conductor
Nombre del conductor
Cadena de Texto
grupo
Nombre del grupo
Cadena de Texto
marca
Marca del vehículo
Cadena de Texto
modelo
Modelo del vehículo
Cadena de Texto
color
Color de vehículo
Cadena de Texto
anio
Año del vehículo
Cadena de Texto
numero_serie
Numero de serie
Cadena de Texto
num_economico
Número económico
Cadena de Texto
tipo_vehiculo
Tipo de activo (Automovil, Camión, etc...)
Cadena de Texto
icono_vehiculo
Icono asignado al activo en la plataforma
Cadena de Texto
ignorar_equipo
Indica si se deben descartar las tramas del equipo
Entero
idequipo_gps
Identificador único del equipo gps
Entero
idtipo_vehiculo
Identificador único del tipo de activo
Entero
idmarca_vehiculo
Identificador único de la marca del activo
Entero
idconductor
Identificador único del conductor
Entero
idgrupo_vehiculo
Identificador único del grupo al que pertenece el activo
Entero
idclientepropietario
Id del cliente propietario del activo
Entero
clientepropietario
Nombre del cliente propietario del activo
Cadena de Texto
Lista las licencias de una factura - getInvoiceDetail
POST https://api.service24gps.com/api/v1/getInvoiceDetail
Para obtener el listado de las licencias pertenecientes a la factura consultada.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
num_factura
Número de la factura
8
23435
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getInvoiceDetail' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'num_factura="23435"' \
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"cliente": "Luis Rojas",
"vehiculo": "Aveo",
"placa": "ADU029",
"gps": "867553056764707",
"tipo": "GPS",
"comentario": null
},
{
"cliente": "Roberto Gómez",
"vehiculo": "Yaris",
"placa": "BKN482",
"gps": "867204060343613",
"tipo": "GPS",
"comentario": null
},
{
"cliente": "María Fernández",
"vehiculo": "Corolla",
"placa": "XYZ789",
"gps": "861234059182734",
"tipo": "GPS",
"comentario": null
},
{
"cliente": "Carlos Mendoza",
"vehiculo": "Hilux",
"placa": "PQR456",
"gps": "865432098712345",
"tipo": "OBD",
"comentario": null
},
{
"cliente": "Daniela Suárez",
"vehiculo": "Tracker",
"placa": "JHS912",
"gps": "869876543210987",
"tipo": "GPS",
"comentario": null
},
{
"cliente": "Ana Gómez",
"vehiculo": "Civic",
"placa": "MNO123",
"gps": "863456789012345",
"tipo": "LBS",
"comentario": null
},
{
"cliente": "Jorge Ramírez",
"vehiculo": "Sentra",
"placa": "JKL890",
"gps": "864567890123456",
"tipo": "GPS",
"comentario": null
},
{
"cliente": "Laura Torres",
"vehiculo": "Versa",
"placa": "GHI567",
"gps": "867890123456789",
"tipo": "OBD",
"comentario": null
}
]
}
Distribuidor - Tickets
Métodos relacionados con los tickets.
Lista de datos para generar ticket - getdataticket
POST https://api.service24gps.com/api/v1/getdataticket
Obtiene los datos de plataforma, clasificación, tipo y acción.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getdataticket' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"plataforma": {
"1": "Backoffice",
"2": "OnTracking",
"3": "Backoffice",
"4": "OnReports",
"5": "Aplicaciones Móviles",
"6": "OnBus",
"8": "Alertas",
"10": "OnDriving",
"11": "OnTool",
"12": "OnRouting",
"13": "OnRoad",
"15": "OnWall",
"16": "OnAlert",
"17": "OnPatrol",
"18": "OnDocs",
"19": "OnDelivery",
"22": "OnNavigate",
"67": "OnDash",
"70": "OnStatus",
"80": "OnMobile"
},
"clasificacionTicket": {
"1": "facturacin",
"2": "baja-de-activo",
"3": "alta-de-activo",
"4": "siniestrosreposiciones",
"5": "calidadfuncionamiento-del-servicio",
"6": "comunicacin-con-operadorrepresentante",
"7": "ventas",
"8": "soporte",
"9": "desarrollo"
},
"TipoTicket": {
"1": "pedido",
"2": "reclamo",
"3": "consulta",
"4": "sugerencia",
"0": "urgencia"
},
"AccionTicket": {
"1": "asignar",
"2": "comentar",
"4": "cancelar",
"3": "cerrar",
"0": "en-espera-de-respuesta"
},
"StatusTicket": {
"1": "Pendiente",
"2": "En resolución",
"3": "Cerrado",
"4": "Cancelado",
"0": "En espera de respuesta",
"5": "Reabierto"
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
plataforma
listado de plataformas.
JSON
clasificacionTicket
Listado de clasificaciones.
JSON
TipoTicket
Listado de tipos.
JSON
AccionTicket
Listado de acciones.
JSON
StatusTicket
Listado de status ticket.
JSON
Listado de tickets - gettickets
POST https://api.service24gps.com/api/v1/gettickets
Obtiene el listado total de tickets o los tickets de un cliente en especifico.
Nota : El método gettickets solo muestra los tickets de clientes que están habilitados, si están eliminados no se mostrará la información en la respuesta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idCliente
(Opcional) Identificador único del cliente. -Consultar el id de los clientes en el método getClients .
16572
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/gettickets' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'idCliente="16572"'
Respuesta de ejemplo:
{
"status":200,
"data":{
"909081":[
{
"idTicket":"12313",
"cliente":"Luis",
"nombre":"Ticket de prueba1",
"telefonoContacto":"2222123453",
"emailContacto":"usuario1@hotmail.com",
"plataforma":"Cliente",
"clasificacion":"desarrollo",
"tipo":"consulta",
"descripcion":"Solicitud de activos",
"status":"En resolución",
"fecha":"2024-03-07",
"hora":"13:30:19"
},
{
"idTicket":"12314",
"cliente":"Enrique",
"nombre":"Ticket de prueba2",
"telefonoContacto":"2222123454",
"emailContacto":"usuario2@hotmail.com",
"plataforma":"Cliente",
"clasificacion":"desarrollo",
"tipo":"sugerencia",
"descripcion":"Equipo : dvr J03554455",
"status":"Cerrado",
"fecha":"2022-04-22",
"hora":"17:34:28"
},
],
"909082":[
{
"idTicket":"12315",
"cliente":"Julio",
"nombre":"Ticket de prueba3",
"telefonoContacto":"2222123455",
"emailContacto":"usuario3@hotmail.com",
"plataforma":"Cliente",
"clasificacion":"alta-de-activo",
"tipo":"pedido",
"descripcion":"instalcion hora tecnico",
"status":"Cerrado",
"fecha":"2021-10-01",
"hora":"11:13:59"
}
],
"909083":[
{
"idTicket":"12316",
"cliente":"Eduardo",
"nombre":"Ticket de prueba4",
"telefonoContacto":"2222123455",
"emailContacto":"usuario4@hotmail.com",
"plataforma":"Cliente",
"clasificacion":"alta-de-activo",
"tipo":"pedido",
"descripcion":"instalcion hora tecnico",
"status":"Cerrado",
"fecha":"2021-10-01",
"hora":"11:13:59"
}
]
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idTicket
Identificador único del ticket en el sistema.
Entero
cliente
Nombre del cliente.
Cadena de Texto
nombre
Nombre asignado al ticket.
Cadena de Texto
telefonoContacto
Número telefónico del contacto.
Cadena de Texto
emailContacto
Correo electrónico del contacto.
Cadena de Texto
plataforma
Nombre de la plataforma.
Cadena de Texto
clasificacion
Nombre de la clasificación.
Cadena de Texto
tipo
Nombre del tipo del ticket.
Cadena de Texto
descripcion
Descripción sobre el ticket.
Cadena de Texto
status
Estatus del ticket.
Cadena de Texto
fecha
Fecha del ticket.
Cadena de Texto
hora
Hora del ticket.
Cadena de Texto
Crear ticket - createticket
POST https://api.service24gps.com/api/v1/createticket
Este método permite crear un ticket.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
Nombre con el que se identificará el ticket dentro de la plataforma.
cliente
telefono
Número telefónico de contacto
123456789
email
Correo electrónico de contacto
test@test.com
idPlataforma
Identificador único de plataforma
1
idClasificacion
Identificador único de clasificación
1
idTipo
Identificador único de tipo
1
idCliente
Identificador único de cliente
1
activos
Lista de activos separados por coma
activo 1. activo2, activo 3
fechaInicio
Fecha inicio
2022-01-01
fechaFin
Fecha fin
2022-01-21
descripcion
Descripción sobre el ticket.
Buena tarde, Se solicita apoyo
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createticket' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="cliente"' \
--form 'tipo_cerca="1"' \
--form 'telefono="123456789"' \
--form 'email="test@test.com"' \
--form 'idPlataforma="1"' \
--form 'idClasificacion="1"' \
--form 'idTipo="1"' \
--form 'idCliente="1"' \
--form 'activos="activo1, activo 2, activo 3"' \
--form 'fechaInicio="2022-01-01"' \
--form 'fechaFin="2022-01-21"' \
--form 'descripcion="Buena tarde, Se solicita apoyo"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idticket": 1
}
}
Ver campos de respuesta:
idticket
Identificador único del ticket
Entero
Subir imagenes para ticket - uploadimageticket
POST https://api.service24gps.com/api/v1/uploadimageticket
Este método permite subir imágenes para adjuntar la url en la descripción del ticket
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
file[]
Arreglo de archivos
file[]=@"/home/Usuario/Escritorio/prueba.jpg" file[]=@"/home/Usuario/Escritorio/cliente.jpg"
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/uploadimageticket' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'file[]=@"/home/Usuario/Escritorio/prueba.jpg"' \
--form 'file[]=@"/home/Usuario/Escritorio/cliente.jpg"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
"https://newspace1.nyc3.digitaloceanspaces.com/Tickets/idDistribuidor-4220/642610073_prueba.png",
"https://newspace1.nyc3.digitaloceanspaces.com/Tickets/idDistribuidor-4220/642610074_cliente.png"
]
}
Ver campos de respuesta:
Url imagenes
Url de las imagenes
JSON
Responder ticket - createticketdetalle
POST https://api.service24gps.com/api/v1/createticketdetalle
Este método permite responder un ticket.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
IdTicket
(Requerido) Identificador único de ticket a responder.
288282
IdAccionticket
(Requerido) Identificador único de acción.
3
descripcion
(Requerido) Descripción sobre el detalle del ticket.
Buena tarde, Se solicita apoyo
alertamail
(Requerido) Bandera para enviar alerta por mail (true) o no (false).
true
alertasms
(Requerido) Bandera para enviar alerta por sms (true) o no (false).
false
alertasoporte
(Requerido) Bandera para enviar a soporte (true) o no (false).
false
mostraralusuario
(Requerido) Bandera para mostrar al usuario (true) o no (false).
false
imageurl
(Opcional) Array de url de imágenes devuelto por el método uploadimageticket.
['https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQUumUUHBnkkeyb0oTT5GnX6dgjYN1wAmp5ohsRZB3YcQ&s=10' ]
idstatus_ticket
(Opcional) Identificador único de status del ticket.
El catálogo de status ticket se puede obtener en el método getDataTicket .
3
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createticketdetalle' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'IdTicket="288282"' \
--form 'IdAccionticket="3"' \
--form 'descripcion="Buenas tarde, Se solicita apoyo"' \
--form 'alertamail="true"' \
--form 'alertasms="false"' \
--form 'alertasoporte="false"' \
--form 'mostraralusuario="false"' \
--form 'imageurl="['https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQUumUUHBnkkeyb0oTT5GnX6dgjYN1wAmp5ohsRZB3YcQ&s=10']"'\
--form 'idstatus_ticket="3"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idticket": 12871287
}
}
Ver campos de respuesta:
idticket
Identificador único del detalle del ticket.
Entero
Obtener detalle del ticket - getTicketAnswer
POST https://api.service24gps.com/api/v1/getTicketAnswer
Obtiene el detalle del ticket.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Idticket
(Requerido) Identificador único del ticket.
898915
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getTicketAnswer' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'\
--form 'Idticket="898915"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"Id": "898915",
"Descripcion": "Estimados, solicito el apoyo para obtener la información de mi equipo.
\n",
"Detalle": [
{
"Idticket_detalle": "33547,
"Usuario": "cliente1",
"Fecha": "2023-07-10",
"Hora": "09:01:52",
"Respuesta": "Hola buenos días:\n\nle daremos seguimiento al tema.",
"Leido": "No"
},
{
"Idticket_detalle": "33546
"Usuario": "cliente1",
"Fecha": "2023-07-05",
"Hora": "15:49:34",
"Respuesta": "Hola buenos dias, pueden enviar el número del equipo.",
"Leido": "Sí"
},
{
"Idticket_detalle": "33545,
"Usuario": "cliente1",
"Fecha": "2023-07-05",
"Hora": "09:27:42",
"Respuesta": "Buenos días, se envió la información. \n\nsaludos",
"Leido": "Sí"
}
]
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
Id
Identificador único del ticket.
Entero
Descripcion
Descripción del ticket.
Texto
Detalle
Detalle del ticket.
JSON
Equipos
Datos históricos de eventos del equipo - historyGetEvents
POST https://api.service24gps.com/api/v1/historyGetEvents
Este método permite consultar los datos históricos de los eventos de un equipo para un rango de fechas y horas especificados.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
equipo
IMEI o Identificador único del dispositivo configurado en la plataforma.
200
0580012342332337
fechaIni
Fecha Inicial de los datos.
19
2021-04-27 00:00:00
fechaFin
Fecha Final de los datos.
19
2021-04-27 23:59:59
format
Si se pasan horas en fechaIni y fechaFin debe enviar “ DateTime ”, de lo contrario utilice “ Date ”.
8
DateTime
idsEvents
Se específica un o muchos Id de los eventos a consultar, separados por coma sin espacios. Si no se especifican se obtienen todos los eventos que no sean ubicación.
1321,1322,1323,1324,1325,1326,1336, 1337,1338,1339
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/historygetevents' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="0580012342332337"' \
--form 'fechaIni="2021-04-27 00:00:00"' \
--form 'fechaFin="2021-04-27 23:59:59"' \
--form 'format="DateTime"' \
--form 'idsEvents="1321,1322,1323,1324,1325,1326,1336,1337,1338,1339"'
{
"status": 200,
"data": {
"equipo": "0580012342332337",
"latitud": "19.528530",
"longitud": "--99.171165",
"idstatus": "1",
"gmt": "-6",
"fecha": "2024-01-04",
"hora": "10:14:18",
"fecha_reporte": "20240104101418",
"idevento": "348",
"velocidad": "0",
"orientacion": "0",
"senal": "0",
"satelites": "0",
"inputs": "0|0|0|0|0|0|0|0|0|0|0|0|0|0|0",
"odometro": "0",
"bateria_gps": "86",
"bateria_veh": "0",
"ignicion": "1",
"idconductor": "34110",
"domicilio": "Camino a San Juan Ixtacala 479, San Juan, Gustavo A. Madero, Mexico City, Mexico",
"de_buffer": "0",
"datos_extras": "{\"parameters\":{\"out_1\":\"0\",\"out_2\":\"0\",\"out_3\":\"0\",\"out_4\":\"0\",\"out_5\":\"0\",\"out_6\":\"0\",\"out_7\":\"0\",\"out_8\":\"0\"},\"outputs\":\"0|0|0|0|0|0|0|0\",\"Time_stamp_insert\":\"20210427201542\",\"tipo_dato\":{\"1\":\"2021-04-28 01:15:42\",\"13\":\"2021-04-27 21:04:29\",\"55\":\"2021-04-27 21:04:30\",\"14\":\"2021-04-27 21:05:42\",\"3\":\"2021-04-27 21:03:42\"},\"gw\":\"Escuchar-ST4340-TCP.php\",\"ip\":\"107.170.254.11\",\"kp\":\"6088b73e3a7f5\"}",
"grupo": "CONDUCTORES MX",
"conductor": "CONDUCTOR1",
"patente": "ABC123",
"activo": "ACTIVO 1"
}
}
Respuesta de ejemplo:
Ver campos de respuesta:
Campo
Descripción
Formato
equipo
Número de serie o IMEI que permite identificar el dispositivo.
Entero
latitud
Latitud de la posición del vehículo.
Grados decimales
longitud
Longitud de la posición del vehículo.
Grados decimales
idstatus
Status de la información que reportó el equipo:
1 = Información actual
2 = Información a futuro.
Entero
gmt
Greenwich Mean Time.
Cadena de texto
fecha
Fecha de la posición del vehículo.
DateTime
hora
Hora de la posición del vehículo.
HH::MM:SS
fecha_reporte
Fecha y hora de la posición del vehículo.
Timestamp
idevento
Identificador del evento que reportó el equipo GPS.
Entero
velocidad
Velocidad en km/h que detecta el equipo GPS.
Entero
orientacion
Orientación en grados en la que reportó el equipo GPS.
Entero
senal
Señal GSM del equipo GPS.
Entero
satelites
Cantidad de satélites.
Entero
inputs
Estados de cada entrada del equipo:
0 = Desactivada
1 = Activada
Cadena de texto
odometro
Metros (mts) que ha recorrido el vehículo, detectado por el GPS.
Entero
bateria_gps
Porcentaje o voltaje del nivel de la batería interna del GPS.
Entero | Decimales
bateria_veh
Voltaje (v) de la batería del vehículo.
Decimales
ignicion
Status Ignición:
0 = OFF
1 = ON
2 = Desconocida
Entero
IdConductor
Id del conductor autentificado, Ibutton
Entero
domicilio
Domicilio.
Cadena de texto
de_buffer
Status del tipo de reporte:
0 = Sin Buffer
1 = Buffer
Entero
datos_extras
Valores que son obtenidos del protocolo OBDII.
JSON
grupo
Nombre del grupo que pertenece.
Cadena de texto
conductor
Nombre del conductor.
Cadena de texto
patente
Nombre de la patente.
Cadena de texto
activo
Nombre del activo.
Cadena de texto
Datos históricos equipo - history/get
POST https://api.service24gps.com/api/v1/history/get
Este método permite consultar los datos históricos de un equipo para un rango de fechas y horas especificados.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
equipo
(Requerido) IMEI o Identificador único del dispositivo configurado en la plataforma.
200
0580012342332337
fechaIni
(Requerido) Fecha Inicial de los datos.
19
2023-03-08 00:00:00
fechaFin
(Requerido) Fecha Final de los datos.
19
2023-03-08 23:59:59
format
(Requerido) Si se pasan horas en fechaIni y fechaFin debe enviar “DateTime”, de lo contrario utilice “Date”.
8
DateTime
limite
(Opcional) Permite establecer un límite de filas de datos a recibir del WS, si no especifica un límite se regresan todos los datos.
1
Nota: El limite máximo para consultar datos históricos es de 15 días por equipo.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/history/get' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'equipo="0580012342332337"' \
--form 'fechaIni="2023-03-08 00:00:00"' \
--form 'fechaFin="2023-03-08 23:59:59"' \
--form 'format="DateTime"' \
--form 'limite="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"equipo": "0580012342332337",
"latitud": "+19.528530",
"longitud": "-99.171165",
"iporigen": "",
"puerto": "",
"idstatus": "1",
"gmt": "-5",
"fecha": "2023-03-08",
"hora": "23:59:39",
"fecha_reporte": "20230308235939",
"idevento": "1",
"velocidad": "0",
"orientacion": "0",
"senal": "65",
"satelites": "20",
"inputs": "0|0|0|0|0|0|0|0|0|0|0|0|0|0|0",
"odometro": "57373562",
"bateria_gps": "100",
"bateria_veh": "13.83",
"ignicion": "1",
"idconductor": "0",
"domicilio": "Camino a San Juan Ixtacala 479, San Juan, Gustavo A. Madero, Mexico City, Mexico",
"de_buffer": "0",
"datos_extras": "{\"parameters\":{\"out_1\":\"0\",\"out_2\":\"0\",\"out_3\":\"0\",\"out_4\":\"0\",\"out_5\":\"0\",\"out_6\":\"0\",\"out_7\":\"0\",\"out_8\":\"0\"},\"outputs\":\"0|0|0|0|0|0|0|0\",\"Time_stamp_insert\":\"20210427201542\",\"tipo_dato\":{\"1\":\"2021-04-28 01:15:42\",\"13\":\"2021-04-27 21:04:29\",\"55\":\"2021-04-27 21:04:30\",\"14\":\"2021-04-27 21:05:42\",\"3\":\"2021-04-27 21:03:42\"},\"gw\":\"Escuchar-ST4340-TCP.php\",\"ip\":\"107.170.254.11\",\"kp\":\"6088b73e3a7f5\"}",
"grupo": "Flota 1",
"conductor": "",
"patente": "ABC-813",
"activo": "Activo-01"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
equipo
Número de serie o IMEI que permite identificar el dispositivo.
Entero
latitud
Latitud de la posición del vehículo.
Grados decimales
longitud
Longitud de la posición del vehículo.
Grados decimales
iporigen
Ip de origen de reporte del equipo GPS.
Cadena de texto
puerto
Puerto de origen de reporte del equipo GPS.
Entero
idstatus
Status de la información que reportó el equipo:
1 = Información actual
2 = Información a futuro.
Entero
gmt
Greenwich Mean Time.
Cadena de texto
fecha
Fecha
aaaa-mm-dd
hora
Hora
hh:mm:ss
fecha_reporte
Fecha hora de la posición del vehículo.
DateTime
idevento
Identificador del evento que reportó el equipo GPS.
Entero
velocidad
Velocidad en km/h que detecta el equipo GPS.
Entero
orientacion
Orientación en grados en la que reportó el equipo GPS.
Entero
senal
Señal GSM del equipo GPS.
Entero
satelites
Cantidad de satélites.
Entero
inputs
Estados de cada entrada del equipo:
0 = Desactivada
1 = Activada
Cadena de texto
odometro
Metros (mts) que ha recorrido el vehículo, detectado por el GPS.
Entero
bateria_gps
Porcentaje o voltaje del nivel de la batería interna del GPS.
Entero | Decimales
bateria_veh
Voltaje (v) de la batería del vehículo.
Decimales
ignicion
Status Ignición:
0 = OFF
1 = ON
2 = Desconocida
Entero
IdConductor
Id del conductor autentificado, Ibutton
Entero
de_buffer
Status del tipo de reporte:
0 = Sin Buffer
1 = Buffer
Entero
datos_extras
Valores que son obtenidos del protocolo OBDII.
JSON
grupo
Nombre del grupo
Cadena de texto
conductor
Nombre del conductor
Cadena de texto
patente
Patente del activo
Cadena de texto
activo
Nombre del activo
Cadena de texto
Obtener listado de marcas y modelos - getBrandsAndModels
POST https://api.service24gps.com/api/v1/getBrandsAndModels
Obtiene el listado completo de marcas y modelos de dispositivos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getBrandsAndModels' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "299",
"marca": "Zenda",
"modelos": [
{
"id": "77",
"modelo": " ZD-VT2"
},
{
"id": "1006",
"modelo": "ZD-VT1"
}
]
},
{
"id": "150",
"marca": "Yulongda technology limited",
"modelos": [
{
"id": "1474",
"modelo": "GT06H"
},
{
"id": "371",
"modelo": "YuLongDa GT06"
}
]
},
{
"id": "384",
"marca": "Accurate Technology",
"modelos": [
{
"id": "1533",
"modelo": "TK100"
}
]
}
]
}
Obtener alertas por día - getAlerts
POST https://api.service24gps.com/api/v1/getAlerts
Obtiene las alertas generadas en el rango de fechas indicado para un equipo específico, un grupo de Activos o todos los equipos asociados al usuario.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idgrupo
(Opcional) Identificador único del grupo de Activos. Este parámetro tiene prioridad sobre equipo; si se especifica, la consulta se realizará para los Activos pertenecientes al grupo indicado. Para obtener los identificadores disponibles, consulte el método getAssetGroups. Nota: Si se desea realizar la consulta únicamente para un equipo, este parámetro debe enviarse vacío.
45665
equipo
(Requerido) IMEI del equipo del cual se desean obtener las alertas. Este parámetro será considerado únicamente cuando idgrupo no se especifique.
354148072188807
fecha_inicio
(Requerido) Fecha de inicio del rango para la consulta de alertas.
2026-08-01
fecha_fin
(Requerido) Fecha de fin del rango para la consulta de alertas.
2026-08-14
Si los parámetros idgrupo y equipo se envían vacíos, la consulta devolverá las alertas de todos los Activos asociados al usuario.
Si ambos campos de fecha se dejan vacíos, la consulta se realizará para el día actual.
Solo es posible consultar rangos de hasta 14 días .
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getAlerts' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idgrupo="45665"' \
--form 'equipo="354148072188807"' \
--form 'fecha_inicio="2026-08-01"' \
--form 'fecha_fin="2026-08-14"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"Equipo": "354148072188807",
"Fecha": "2026-08-10",
"Hora": "08:16:16",
"Descripcion": "Unidad Generó BOTON DE PANICO el 2022/02/24 08:16:16
",
"Latitud": "18.98043888996881",
"Longitud": "-98.22312211997996",
"Domicilio": "Boulevard Periférico Ecológico, Constitución Loma Bella, 72474 Puebla, Puebla",
"StatusAlerta": "FUERA DE LA GEOCERCA",
"TipoAlerta": "Geocerca E/S"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
Equipo
Equipo asignado al vehículo que ejecutó la alerta.
Cadena de Texto
Fecha
Fecha en la que la alerta se ejecutó.
DateTime
Hora
Hora de la alerta (se maneja en formato de 24 hrs.)
DateTime
Descripción
Texto descriptivo de la alerta.
Cadena de Texto
Latitud
Latitud correspondiente al punto en que se originó la alerta.
Cadena de Texto
Longitud
Longitud correspondiente al punto en que se originó la alerta.
Cadena de Texto
Domicilio
Dirección correspondiente a la latitud y longitud reportada por el equipo.
Cadena de Texto
StatusAlerta
Nombre del estado del alerta, puede ser los siguientes:
IGNICIÓN ON
IGNICIÓN OFF
DENTRO DE LA GEOCERCA
FUERA DE LA GEOCERCA
TEMPERATURA LIMITE INFERIOR
TEMPERATURA LIMITE SUPERIOR
Cadena de Texto
TipoAlerta
Nombre del tipo de alerta que se generó.
Cadena de Texto
Lista de eventos - getEventTypes
POST https://api.service24gps.com/api/v1/getEventTypes
Obtiene el listado de todos los eventos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getEventTypes' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Ubicación",
"2": "Botón SigMen",
"3": "Activo Detenido",
"4": "Botón de Pánico ON",
"5": "Puerta Conductor",
...
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del evento en el sistema.
Entero
nombre
Nombre del evento
Texto
Lista de sensores - GetSensors
POST https://api.service24gps.com/api/v1/getSensors
Obtiene el listado de todos los sensores disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getSensors' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Ignición ON / OFF",
"2": "Desconexión de Batería Principal",
"3": "Botón de Pánico",
"4": "Corte Remoto de Combustible",
"5": "Apertura / Cierre de puertas",
...
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del sensor.
Entero
nombre
Nombre del sensor
Texto
Geocercas
Métodos relacionados con las geocercas.
Lista de geocercas - getGeofences
POST https://api.service24gps.com/api/v1/getGeofences
Obtiene el listado de geocercas de tipo poligonal (dibujo), lineal (ruta) o circular.
Ver parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getGeofences' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idCerca": 987984,
"idtipo_cerca": 2,
"tipo_cerca": "Circulo",
"nombre": "Geocerca 2",
"color": "#024769",
"puntos": [
{
"lat": 19.12084,
"lng": -98.24436
}
],
"radio": 160,
"limite_velocidad": 10,
"solo_mi_usuario": 0,
"visible": 0,
"umbral": {
"puntos_poligono": [],
"tolerancia": 0
},
"grupo": "Sin Asignar",
"compartida": 1
},
{
"idCerca": 46468,
"idtipo_cerca": 3,
"tipo_cerca": "Ruta",
"nombre": "Geocerca 3",
"color": "#FF0000",
"puntos": [
{
"lat": -15.350319,
"lng": -75.145134
},
{
"lat": -15.350459,
"lng": -75.145083
},
{
"lat": -15.35056,
"lng": -75.145035
},
{
"lat": -15.350728,
"lng": -75.144909
}
],
"radio": 0,
"limite_velocidad": 50,
"solo_mi_usuario": 0,
"visible": 0,
"umbral": {
"puntos_poligono": [
{
"lat": -15.350557,
"lng": -75.145837
},
{
"lat": -15.350758,
"lng": -75.14576
},
{
"lat": -15.35022,
"lng": -75.144379
},
{
"lat": -15.35008,
"lng": -75.14443
}
],
"tolerancia": 40
},
"grupo": "GRUPO TEST",
"compartida": 0
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idCerca
Identificador único de la geocerca en el sistema.
Entero
idtipo_cerca
Indica el tipo de geocerca.
1 = Poligonal o dibujo
2 = Circular
3 = Lineal o ruta
Entero
tipo_cerca
Nombre del tipo de geocerca.
Cadena de Texto
nombre
Nombre con el que se identifica la geocerca dentro de la plataforma.
Cadena de Texto
color
Color con el que se muestra e identifica la geocerca en la plataforma.
Cadena de Texto (RGB hexadecimal)
puntos
Punto o puntos que conforman la geocerca.
JSON
radio
Radio en metros que abarca la geocerca circular .
Entero
limite_velocidad
Velocidad máxima (Km/h) permitida en la geocerca.
Entero
solo_mi_usuario
Indica si la geocerca solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
Entero
visible
Indica si la geocerca se debe o no mostrar.
1 = Mostrar
0 = Ocultar
Entero
umbral
Datos de la geocerca lineal o ruta , el cual contiene los puntos del polígono y la tolerancia.
JSON
grupo
Nombre del grupo que pertenece la geocerca.
Cadena de Texto
compartida
Indica si la geocerca es compartida.
1 = Compartida
0 = No compartida
Entero
Crear geocerca - createGeofence
POST https://api.service24gps.com/api/v1/createGeofence
Este método permite crear una geocerca de tipo: circular, poligonal o lineal.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
(Requerido) Nombre con el que se identificará la geocerca dentro de la plataforma.
GeoHome
puntos
(Requerido) Punto o puntos que conformarán la geocerca.
[{"lat":-12.087574155453476,"lng":-77.08396062254906},{"lat":-12.087672508218587,"lng":-77.08401560783386},{"lat":-12.087707915205174,"lng":-77.08394654095173},{"lat":-12.087658083148632,"lng":-77.08388954401016},{"lat":-12.087618086359699,"lng":-77.08389893174171},{"lat":-12.08758989189834,"lng":-77.08392508327961},{"lat":-12.08757546682392,"lng":-77.08395726978779}]
tipo_cerca
(Requerido) Indica el tipo de geocerca a crear.
1 = Poligonal o dibujo
2 = Circular
3 = Lineal o ruta.
1
color
(Opcional) Color con el que se mostrará e identificará la geocerca en la plataforma, en formato RGB hexadecimal.
#223344
radio
(Opcional) Radio en metros que abarcará la geocerca circular.
0
limite_velocidad
(Opcional) Velocidad máxima (Km/h) permitida en la geocerca.
50
solo_mi_usuario
(Opcional) Indica si la geocerca solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
1
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createGeofence' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="GeoHome"' \
--form 'puntos="[{\"lat\":-12.087574155453476,\"lng\":-77.08396062254906},{\"lat\":-12.087672508218587,\"lng\":-77.08401560783386},{\"lat\":-12.087707915205174,\"lng\":-77.08394654095173},{\"lat\":-12.087658083148632,\"lng\":-77.08388954401016},{\"lat\":-12.087618086359699,\"lng\":-77.08389893174171},{\"lat\":-12.08758989189834,\"lng\":-77.08392508327961},{\"lat\":-12.08757546682392,\"lng\":-77.08395726978779}]"' \
--form 'tipo_cerca="1"' \
--form 'color="#223344"' \
--form 'radio="0"' \
--form 'limite_velocidad="50"' \
--form 'solo_mi_usuario="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Actualizar geocerca - updateGeofence
POST https://api.service24gps.com/api/v1/updateGeofence
Este método permite actualizar cualquier valor de una geocerca.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idCerca
(Requerido) Identificador único de la geocerca en el sistema.
138225
nombre
Nombre con el que se identificará la geocerca dentro de la plataforma.
GeoHome
puntos
Punto o puntos que conformarán la geocerca.
[{"lat":-12.087574155453476,"lng":-77.08396062254906},{"lat":-12.087672508218587,"lng":-77.08401560783386},{"lat":-12.087707915205174,"lng":-77.08394654095173},{"lat":-12.087658083148632,"lng":-77.08388954401016},{"lat":-12.087618086359699,"lng":-77.08389893174171},{"lat":-12.08758989189834,"lng":-77.08392508327961},{"lat":-12.08757546682392,"lng":-77.08395726978779}]
color
Color con el que se mostrará e identificará la geocerca en la plataforma, en formato RGB hexadecimal.
#223344
radio
Radio en metros que abarcará la geocerca circular.
0
limite_velocidad
Velocidad máxima (Km/h) permitida en la geocerca.
50
solo_mi_usuario
Indica si la geocerca solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
0
visible
Indica si la geocerca se debe o no mostrar.
1 = Mostrar
0 = Ocultar
1
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createGeofence' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idCerca="138225"' \
--form 'nombre="GeoHome"' \
--form 'puntos="[{\"lat\":-12.087574155453476,\"lng\":-77.08396062254906},{\"lat\":-12.087672508218587,\"lng\":-77.08401560783386},{\"lat\":-12.087707915205174,\"lng\":-77.08394654095173},{\"lat\":-12.087658083148632,\"lng\":-77.08388954401016},{\"lat\":-12.087618086359699,\"lng\":-77.08389893174171},{\"lat\":-12.08758989189834,\"lng\":-77.08392508327961},{\"lat\":-12.08757546682392,\"lng\":-77.08395726978779}]"' \
--form 'color="#223344"' \
--form 'radio="0"' \
--form 'limite_velocidad="50"' \
--form 'solo_mi_usuario="0"' \
--form 'visible="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si la geocerca es de tipo compartida , no permitirá actualizar y mostrará un mensaje de error .
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 30300,
"msg": "La geocerca es compartida, no se puede actualizar"
}
}
Eliminar geocerca - deleteGeofence
POST https://api.service24gps.com/api/v1/deleteGeofence
Este método permite eliminar una geocerca especifica.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idCerca
(Requerido) Identificador único de la geocerca en el sistema.
138225
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteGeofence' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idCerca="138225"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si la geocerca es de tipo compartida , no permitirá eliminar y mostrará un mensaje de error .
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 30300,
"msg": "La geocerca es compartida, no se puede eliminar"
}
}
Lugares
Métodos relacionados con los lugares.
Lista de lugares - getPlaces
POST https://api.service24gps.com/api/v1/getPlaces
Obtiene el listado de todos los lugares que pertenecen al usuario o cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getPlaces' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idLugar": "556987",
"nombre": "Colegio",
"direccion": "Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx.",
"latitud": "19.550788",
"longitud": "-99.191248",
"descripcion": "Primaria y Secundaria",
"telefono": "55 5390 2698",
"email": "",
"grupoLugar": "11",
"grupo": "principal",
"solo_mi_usuario": "48016",
"icono": "/images/Lugares/new_596_retail_shop_building.png",
"visible": 1
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idLugar
Identificador único del lugar en el sistema.
Entero
nombre
Nombre con el que se identificará el lugar en el sistema.
Cadena de Texto
direccion
Dirección en la que se ubica el lugar.
Cadena de Texto
latitud
Latitud correspondiente al lugar que se dará de alta.
Flotante
longitud
Longitud correspondiente al lugar que se dará de alta.
Flotante
descripcion
Comentario o descripción breve sobre el lugar.
Cadena de Texto
telefono
Número telefónico o de contacto vinculado al lugar.
Cadena de Texto
email
Dirección de correo electrónico vinculado al lugar.
Cadena de Texto
grupoLugar
Identificador del grupo al que pertenece el lugar.
Entero
grupo
Nombre del grupo al que pertenece el lugar
Cadena de texto
solo_mi_usuario
Indica si el lugar solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
Entero
icono
Icono con el que se identificará el lugar en el sistema.
Cadena de Texto
visible
Indica si el lugar se debe o no mostrar.
1 = Mostrar
0 = Ocultar
Entero
Crear Lugar - createPlace
POST https://api.service24gps.com/api/v1/createPlace
Este método permite crear un lugar.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
Nombre con el que se identifica el lugar en el sistema.
Colegio 1
direccion
Dirección en la que se ubica el lugar.
Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx.
latitud
Latitud correspondiente al lugar.
19.550788
longitud
Longitud correspondiente al lugar.
-99.191248
descripcion
Comentario o descripción breve sobre el lugar.
Primaria y Secundaria
telefono
Número telefónico o de contacto vinculado al lugar.
5553902698
email
Dirección de correo electrónico vinculado al lugar.
prueba@prueba.com
solo_mi_usuario
Indica si el lugar solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
0
icono
Icono con el que se identificará el lugar en el sistema.
/images/Lugares/new_596_retail_shop_building.png
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createPlace' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idLugar="556987"' \
--form 'nombre="Colegio 1"' \
--form 'direccion="Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx."' \
--form 'latitud="19.550788"' \
--form 'longitud="-99.191248"' \
--form 'descripcion="Primaria y Secundaria"' \
--form 'telefono="5553902698"' \
--form 'email="prueba@prueba.com"' \
--form 'solo_mi_usuario="0"' \
--form 'icono="/images/Lugares/new_596_retail_shop_building.png"'
Respuesta de ejemplo:
{
"status": 200,
"data": "12345"
}
Actualizar lugar - updatePlace
POST https://api.service24gps.com/api/v1/updatePlace
Este método permite actualizar cualquier valor de un lugar.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idLugar
Identificador único del lugar en el sistema.
556987
nombre
Nombre con el que se identifica el lugar en el sistema.
Colegio 2
direccion
Dirección en la que se ubica el lugar.
Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx.
latitud
Latitud correspondiente al lugar.
19.550788
longitud
Longitud correspondiente al lugar.
-99.191248
descripcion
Comentario o descripción breve sobre el lugar.
Primaria y Secundaria
telefono
Número telefónico o de contacto vinculado al lugar.
5553902698
email
Dirección de correo electrónico vinculado al lugar.
solo_mi_usuario
Indica si el lugar solo es visible para el usuario que la generó.
1 = Mi usuario
0 = Todos los usuarios
0
icono
Icono con el que se identificará el lugar en el sistema.
/images/Lugares/new_596_retail_shop_building.png
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updatePlace' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idLugar="556987"' \
--form 'nombre="Colegio 2"' \
--form 'direccion="Aztecas 158, Hab la Romana, 54030 Tlalnepantla de Baz, Méx."' \
--form 'latitud="19.550788"' \
--form 'longitud="-99.191248"' \
--form 'descripcion="Primaria y Secundaria"' \
--form 'telefono="55 5390 2698"' \
--form 'email=""' \
--form 'solo_mi_usuario="0"' \
--form 'icono="/images/Lugares/new_596_retail_shop_building.png"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Eliminar lugar - deletePlace
POST https://api.service24gps.com/api/v1/deletePlace
Este método permite eliminar un lugar especifico.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idLugar
Identificador único de la geocerca en el sistema.
144825
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deletePlace' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idLugar="144825"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si en la respuesta de la solicitud aparece "status": 30700 es un error al obtener los datos.
Respuesta de ejemplo:
{
"status": 30700,
"data": ""
}
Modulos
Listar Módulos - getModules
POST https://api.service24gps.com/api/v1/getModules
Lista los módulos disponibles en las diferentes plataformas para asignar a los usuarios.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getModules' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "2",
"nombre": "Recorridos"
},
{
"id": "3",
"nombre": "Lugares"
},
{
"id": "5",
"nombre": "Alertas"
},
{
"id": "8",
"nombre": "Reportes"
},
{
"id": "311",
"nombre": "My Platform"
}
]
}
SMS
Administrar los mensajes de texto.
Obtener mensajes - getMessages
POST https://api.service24gps.com/api/v1/getMessages
Lista los mensajes SMS por un rango de fechas.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
fecha_inicio
Fecha inicio a consultar, si no se manda este parámetro se utiliza la fecha actual.
2021-11-01
fecha_fin
Fecha fin a consultar, si no se manda este parámetro se utiliza la fecha actual.
2021-11-02
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getMessages' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'fecha_inicio="2021-11-01"' \
--form 'fecha_fin="2021-11-02"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "11",
"fecha_hora": "2021-11-01 14:23:18",
"destinatario": "2226308920",
"mensaje": "Mensaje 01",
"enviado": "1",
"device": "1740301338",
"gateway": "My SMS Gateway"
},
{
"id": "12",
"fecha_hora": "2021-11-02 14:23:10",
"destinatario": "2226489019",
"mensaje": "Mensaje 02",
"enviado": "1",
"device": "323701090018785",
"gateway": "My SMS Gateway"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del mensaje sms dentro de la plataforma.
Entero
fecha_hora
Fecha hora que se envió el mensaje de sms (GMT Hora de México centro)
Fecha Hora (Y-m-d H:i:s)
destinatario
Número telefónico al que se envió el mensaje sms
Cadena de Texto
mensaje
Texto o contenido que se envió
Cadena de Texto
enviado
Bandera para validar si se envió el mensaje: 1 = Enviado, 0 = No enviado
Valor booleano
device
Identificador único del dispositivo (GPS)
Cadena de Texto
gateway
Servicio SMS Gateway que se utilizó para el envío del mensaje.
Cadena de Texto
Obtener el mensaje por su identificador único - getMessage
POST https://api.service24gps.com/api/v1/getMessage
Obtiene el mensaje SMS por su Id.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador único del mensaje sms.
11
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getMessage' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="11"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "11",
"fecha_hora": "2021-11-01 14:23:18",
"destinatario": "2226308920",
"mensaje": "Mensaje 01",
"enviado": "1",
"device": "1740301338",
"gateway": "My SMS Gateway"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del mensaje sms dentro de la plataforma.
Entero
fecha_hora
Fecha hora que se envió el mensaje de sms (GMT Hora de México centro)
Fecha Hora (Y-m-d H:i:s)
destinatario
Número telefónico al que se envió el mensaje sms
Cadena de Texto
mensaje
Texto o contenido que se envió
Cadena de Texto
enviado
Bandera para validar si se envió el mensaje: 1 = Enviado, 0 = No enviado
Valor booleano
device
Identificador único del dispositivo (GPS)
Cadena de Texto
gateway
Servicio SMS Gateway que se utilizó para el envío del mensaje.
Cadena de Texto
Insertar o encolar un mensaje - insertMessage
POST https://api.service24gps.com/api/v1/insertMessage
Registra o encola un nuevo mensaje SMS.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
to
Número telefónico del destinatario
2226308920
message
Texto a mandar o encolar.
Hola mundo!
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/insertMessage' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'to="2226308920"' \
--form 'message="Hola mundo!"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "11"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del mensaje sms dentro de la plataforma.
Entero
Inserta o encola un mensaje por dispositivo - insertMessageDevice
POST https://api.service24gps.com/api/v1/insertMessageDevice
Registra o encola un nuevo mensaje SMS a través de un dispositivo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
device
Identificador único del dispositivo (GPS)
1743201963
message
Texto a mandar o encolar.
Hola mundo!
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/insertMessageDevice' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'device="1743201963"' \
--form 'message="Hola mundo!"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "11"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del mensaje sms dentro de la plataforma.
Entero
Plataforma - OnApp
Comprende métodos de procesamiento para la aplicación tracker, generalmente esta particularidad se requiere como autenticación el TokenApp (JWT) para su funcionamiento.
Método de autenticación - auth
POST https://api.service24gps.com/api/v1/auth
Este método genera el token de autenticación que le permitirá hacer uso de los servicios.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
type
El tipo de aplicación que solicita codificado en Base64.
Mg==
uid
IMEI o identificador único del dispositivo codificado en Base64.
MTIzNDU2Nzg5
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/auth' \
--form 'type="Mg=="' \
--form 'uid="OGVkNTU2NTE3NmM0MzM3Mw=="'
Respuesta de ejemplo:
{
"status": "200",
"data": "eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU",
"extra": {
"idcliente": "44897",
"iddistribuidor": "45296"
"idvehiculo": "138634",
"hash": "jpg8PUcekJQ",
"tipo_equipo": "11"
}
}
Datos del dispositivo - getdata_device
POST https://api.service24gps.com/api/v1/getdata_device
Obtiene la información del dispositivo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/getdata_device' \
--header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjgwNzEwMTMiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.l26c6-zqG8SLukYakCPX8DMZnDpWm0ATzmPCtfggk4o'
Respuesta de ejemplo:
{
"status": "200",
"data": {
"id": "198880",
"device": "8e785176c43373",
"fecha_de_alta": "2022-02-22",
"idcliente_distribuidor": "4121896",
"vehiculo": "Ford",
"idvehiculo": "1691202",
"idcliente_sistema": "411897",
"cliente": "Transportes del sur",
"distribuidor": "Navitrack"
},
"extra": []
}
Listar rondines - getRondinesProceso
POST https://api.service24gps.com/api/v1/getRondinesProceso
Este método lista la información de los rondines programados para hoy y/o de la semana.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
imei
IMEI o identificador único del dispositivo codificado en Base64.
MTIzNDU2Nzg5
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/getRondinesProceso' \
--header 'Authorization: eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU' \
--form 'imei="OGVkNTU2NTE3NmM0MzM3Mw=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"2022-04-27": [
{
"idruta_proceso": 0,
"idruta": "23884",
"nombre": "testHora",
"fecha_inicio": "2022-04-27",
"hora_inicio": "13:45",
"fecha_fin": "2022-04-27",
"hora_fin": "15:00:00",
"estatus": "",
"idvehiculo": "169202",
"lugares": [
{
"id": "uid43662083",
"tipo": 0,
"orden": "1",
"nombre": "q1",
"dist_pa": 0,
"latLng": "0,0",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": "0",
"orientacion": "",
"completado": 0,
"tipoLugarTag": "1",
"codigo": "uid43662083",
"sinoGPS": "0"
},
{
"id": "uid43707424",
"tipo": 0,
"orden": "2",
"nombre": "q2",
"dist_pa": 0,
"latLng": "0,0",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": "0",
"orientacion": "",
"completado": 0,
"tipoLugarTag": "1",
"codigo": "uid43707424",
"sinoGPS": "0"
}
]
}
],
"2022-04-30": [
{
"idruta_proceso": 0,
"idruta": "23884",
"nombre": "testHora",
"fecha_inicio": "2022-04-30",
"hora_inicio": "13:45",
"fecha_fin": "2022-04-30",
"hora_fin": "15:00:00",
"estatus": "",
"idvehiculo": "169202",
"lugares": [
{
"id": "uid43662083",
"tipo": 0,
"orden": "1",
"nombre": "q1",
"dist_pa": 0,
"latLng": "0,0",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": "0",
"orientacion": "",
"completado": 0,
"tipoLugarTag": "1",
"codigo": "uid43662083",
"sinoGPS": "0"
},
{
"id": "uid43707424",
"tipo": 0,
"orden": "2",
"nombre": "q2",
"dist_pa": 0,
"latLng": "0,0",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": "0",
"orientacion": "",
"completado": 0,
"tipoLugarTag": "1",
"codigo": "uid43707424",
"sinoGPS": "0"
}
]
}
]
},
"extra": {
"nombre": "TestUser",
"patente": "27223"
}
}
Listar puntos de rondín - getPuntosRondinProceso
POST https://api.service24gps.com/api/v1/getRondinesProceso
Este método lista la información de los puntos del rondín.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
idruta_proceso
Id de la ruta en proceso en base64.
MA==
imei
IMEI o identificador único del dispositivo codificado en Base64.
MTIzNDU2Nzg5
idruta
Id de la ruta en base 64.
MTcwMTQ=
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
Solicitud de ejemplo:
curl --location --request POST 'https://qa_api.service24gps.com/api/v1/onapp/getPuntosRondinProceso' \
--header 'Authorization: eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU'\
--data-urlencode 'idruta_proceso=MA==' \
--data-urlencode 'imei=MTIzNDU2Nzg5' \
--data-urlencode 'idruta=MTcwMTQ='
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"nombre": "Lugar 1",
"status": "",
"codigo": "MiLugar1",
"uid": "uid65658949",
"latitud": "0",
"longitud": "0",
"orden": "1"
},
{
"nombre": "Lugar 2",
"status": "",
"codigo": "MiLugar2",
"uid": "uid42324784",
"latitud": "0",
"longitud": "0",
"orden": "2"
},
{
"nombre": "Lugar 3",
"status": "",
"codigo": "MiLugar33",
"uid": "uid16380798",
"latitud": "0",
"longitud": "0",
"orden": "3"
},
{
"nombre": "Lugar 4",
"status": "",
"codigo": "MiLugar44",
"uid": "uid86091311",
"latitud": "0",
"longitud": "0",
"orden": "4"
},
{
"nombre": "Lugar 5",
"status": "",
"codigo": "MiLugar55",
"uid": "uid29985878",
"latitud": "0",
"longitud": "0",
"orden": "5"
},
{
"nombre": "Lugar 6",
"status": "",
"codigo": "uid54005553",
"uid": "uid68640714",
"latitud": "0",
"longitud": "0",
"orden": "6"
}
],
"extra": []
}
Obtener formularios - getForms
POST https://api.service24gps.com/api/v1/onapp/getForms
Obtiene el listado de todos los formularios creados por el cliente, y la estructura almacenada.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
token
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/getforms' \
--header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjgwNzEwMTMiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.l26c6-zqG8SLukYakCPX8DMZnDpWm0ATzmPCtfggk4o'
Respuesta de ejemplo:
{
"status": "200",
"data": {
"v2": [
{
"id": "852",
"nombre": "Cuestionario prueba 2",
"header": {
"imagen1": "https://newspace1.nyc3.digitaloceanspaces.com/DynamicForms/formato/41897/p2000220405.jpg",
"imagen2": "https://newspace1.nyc3.digitaloceanspaces.com/DynamicForms/formato/41897/p200120405.jpg",
"nombre": "Cuestionario prueba 2",
"showFolio": "1"
},
"generales": {
"1": {
"texto": "test1",
"respuesta": "13",
"alineacion": "1",
"orden": "1",
"opciones": {
"1": {
"nombre": " test1 "
},
"2": {
"nombre": " test2 "
}
}
}
},
"2": {
"texto": "test2",
"respuesta": "14",
"alineacion": "1",
"orden": "1",
"opciones": {
"1": {
"nombre": " test "
},
"2": {
"nombre": " test "
},
}
}
}
},
"categorias": {
"1": {
"texto": "validacion",
"respuesta": "16",
"alineacion": "1",
"orden": "1"
},
"2": {
"texto": "fecha inicio",
"respuesta": "6",
"alineacion": "1",
"orden": "1"
}
},
"footes": null,
"vigencia": "-1",
"metadatos": {
"idFormato": "852",
"imei": "ed55625c43373",
"url": "https://qa.service24gps.com:443/DynamicForms/ChangeElementStatus/AnswerForms/ContestarFormato?token=88396386fba25",
"noFinalizar": 1,
"vigencia": "2022-04-04",
"contador": 3
},
"token": "88378963ba25",
"status": "1"
}
],
"v3": [
{
"assignedid": "71192",
"idform": "863",
"duration": "-1",
"version": "3",
"name": "Formulario prueba",
"form": [
{
"type": "header",
"subtype": "h1",
"label": "Prueba formulario titulo"
},
{
"type": "text",
"required": false,
"label": "Campo de Texto",
"className": "form-control",
"name": "text-1649348824011",
"value": "Prueba de texto formulario",
"subtype": "text"
},
{
"type": "customDatetime",
"subtype": "datetime-local",
"required": false,
"label": "Fecha / Hora",
"name": "customDatetime-1649349101208",
"value": "2022-04-07T11:31"
},
{
"type": "starRating",
"required": false,
"label": "Calificación",
"name": "starRating-1649349115836"
},
{
"type": "jSignature",
"required": false,
"label": "Firma",
"description": "firma de enterado",
"name": "jSignature-1649349139232"
},
{
"type": "multimedia",
"subtype": "image",
"required": false,
"label": "Multimedia",
"name": "multimedia-1649429241021"
}
],
"answered": "0",
"date": "2022-04-08",
"hour": "07:57:13",
"onlyOnce": false
}
]
},
"extra": []
}
Listar formularios - getformatos
POST https://api.service24gps.com/api/v1/getformatos
Este método lista los formularios asignados al dispositivo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/getformatos' \
--header 'Authorization: eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU'
Respuesta de ejemplo:
{
"status": "200",
"data": [
{
"metadatos": {
"idFormato": "852",
"imei": "8ed55678921123373",
"url": "https://qa.service24gps.com:443/DynamicForms/ChangeElementStatus/AnswerForms/ContestarFormato?token=88396386fba25",
"noFinalizar": 1,
"vigencia": "2022-04-04",
"contador": 3
},
"token": "88396386fba25",
"estado": "1",
"timestamp_creacion": "2022-04-05 10:33:21",
"nombre": "Cuestionario prueba 2"
},
{
"metadatos": {
"idFormato": "846",
"imei": "8ed55678921123373",
"url": "https://qa.service24gps.com:443/DynamicForms/ChangeElementStatus/AnswerForms/ContestarFormato?token=d5144a9b4b81d",
"noFinalizar": 1,
"vigencia": "2022-04-04",
"contador": 1
},
"token": "d5144a9b4b81d",
"estado": "1",
"timestamp_creacion": "2022-04-05 08:37:24",
"nombre": "Cuestionario prueba"
}
],
"extra": []
}
Listar equipos compartidos - getSharedApps
POST https://api.service24gps.com/api/v1/getSharedApps
Este método lista los equipos que son de tipo app tracker compartida.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/getSharedApps' \
--header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjgwNzEwMTMiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.l26c6-zqG8SLukYakCPX8DMZnDpWm0ATzmPCtfggk4o'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"IdEquipo": "205526",
"Identificador": "APPSHARED418969651096603723",
"Imei": "APPSHARED418961651096603723",
"Nombre": "LM Compartido",
"Placa": "TEST123",
"Compartida": false,
"TrackerHost": "N/A"
},
{
"IdEquipo": "205527",
"Identificador": "APPSHARED418961691096876447",
"Imei": "APPSHARED418961651096876447",
"Nombre": "Activo Compartido",
"Placa": "LMMM4",
"Compartida": false,
"TrackerHost": "N/A"
}
],
"extra": []
}
Liberar y asignar equipo compartido - switchApp
POST https://api.service24gps.com/api/v1/switchApp
Este método libera y asigna los equipos que son de tipo app tracker compartida.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
oldApp
IMEI o identificador único del dispositivo codificado en Base64 de la app tracker compartida (liberar equipo).
QVBQU0hBUkVENDE4OTYxNjUxMDk2NjAzNzIz
newApp
IMEI o identificador único del dispositivo codificado en Base64 de la app tracker compartida (asignar equipo).
QVBQU0hBUkVENDE4OTYxNjUxMDk2ODc2NDQ3
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/switchApp' \
--header 'Authorization: eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU' \
--form 'oldApp="QVBQU0hBUkVENDE4OTYxNjUxMDk2NjAzNzIz"' \
--form 'newApp="QVBQU0hBUkVENDE4OTYxNjUxMDk2ODc2NDQ3"'
Respuesta de ejemplo:
{
"status": 200,
"data": "",
"extra": []
}
Nota: La app tracker compartida solo puede ser utilizada en un solo dispositivo.
Listar menú - getMenuTracker
POST https://api.service24gps.com/api/v1/getMenuTracker
Este método lista el menú que se le debe mostrar en la tracker de acuerdo a su plantilla de botones asignada y si no tiene plantilla, se asigna unos botones por defecto.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
imei
IMEI o identificador único del dispositivo codificado en Base64.
MTIzNDU2Nzg5
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/getMenuTracker' \
--header 'Authorization: eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU' \
--form 'imei="MTIzNDU2Nzg5"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"app": 2,
"idButton": "6",
"type": "268",
"title": "Check In con foto",
"subtitle": "Inicia tu jornada",
"colorIconFilter": true,
"icon": "check-in",
"color": "#7AA5B4",
"colorIcon": "#FFFFFF",
"platform": "2",
"action": "check",
"checkData": "Inicia mi jornada laboral",
"showCamera": "true",
"multiplePictures": "true"
},
{
"app": 2,
"idButton": "8",
"type": "1435",
"title": "Check Out con foto",
"subtitle": "Termina tu jornada",
"colorIconFilter": true,
"icon": "check-out",
"color": "#0A2367",
"colorIcon": "#FFFFFF",
"platform": "2",
"action": "check",
"checkData": "Salida de mi jornada laboral",
"showCamera": "true",
"multiplePictures": "true"
},
{
"app": 2,
"idButton": "10",
"type": "1478",
"title": "Audio",
"subtitle": "Grabar una nota de audio",
"colorIconFilter": true,
"icon": "vol-up",
"color": "#733d01",
"colorIcon": "#FFFFFF",
"platform": "2",
"action": "audio"
},
{
"app": 2,
"idButton": "11",
"type": "1477",
"title": "Imagen",
"subtitle": "Capturar una imagen",
"colorIconFilter": true,
"icon": "file",
"color": "#9c9900",
"colorIcon": "#FFFFFF",
"platform": "2",
"action": "image"
},
{
"app": 2,
"idButton": "13",
"type": "1568",
"title": "Firma",
"subtitle": "Capturar una firma",
"colorIconFilter": true,
"icon": "fingerprint-reader",
"color": "#522c01",
"colorIcon": "#FFFFFF",
"platform": "2",
"action": "signature"
},
{
"app": 2,
"idButton": "4",
"type": "576",
"title": "OnForms",
"subtitle": "Responde un formulario",
"colorIconFilter": true,
"icon": "pdf",
"color": "#f1c40f",
"colorIcon": "#FFFFFF",
"platform": "2",
"action": "module_forms"
}
],
"extra": []
}
Finalizar Sesión - logout
POST https://api.service24gps.com/api/v1/logout
Finaliza la sesión del dispositivo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
Authorization
Token generado por el método auth.
eyJ0eXAi5225V1QiLCJhbGciOiJIUz7829.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjcxNjU0MTkiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.TvJclXkRKzKmoDgjeOuZCZOYix4HhTXy4_5lSMRgTMU
uiddevice
Identificador único del dispositivo.
c1698794d07a_tp785_689721
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/onapp/logout' \
--header 'Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1aWQiOiJPR1ZrTlRVMk5URTNObU0wTXpNM013PT0iLCJ0eXBlIjoiTWc9PSIsImRhdGV0aW1lIjoiMjAyMjA0MjgwNzEwMTMiLCJleHBpcmUiOjIxNjAwLCJjbGllbnRlIjoiTkRFNE9UYz0iLCJkaXN0cmlidWlkb3IiOiJOREU0T1RZPSJ9.l26c6-zqG8SLukYakCPX8DMZnDpWm0ATzmPCtfggk4o' \
--form 'uiddevice="c1698794d07a_tp785_689721"'
Respuesta de ejemplo:
{
"status": 200,
"data": "",
"extra": []
}
Plataforma - OnBus
Listar rutas programadas OnBus - getProgrammedRoutesOnBus
POST https://api.service24gps.com/api/v1/getProgrammedRoutesOnBus
Obtiene el listado de todas las rutas programadas que se encuentran pendientes, en proceso, iniciadas o canceladas, ya sea en el día en curso u opcionalmente en un rango de fechas específico (máximo 5 días).
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
fecha_inicio
Fecha inicial desde la que se buscarán las rutas.
2021-05-05
fecha_final
Fecha final hasta donde se realizará la búsqueda de las rutas.
2021-05-05
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getProgrammedRoutesOnBus' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'fecha_inicio="2021-05-05"' \
--form 'fecha_final="2021-05-05"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"Ruta salida lugar2021-05-0500:00:00": {
"id": "2076939",
"nombre": "Ruta salida lugar",
"fecha_inicio": "2021-05-05",
"hora_inicio": "00:00:00",
"fecha_fin": "2021-05-05",
"hora_fin": "00:41:00",
"idruta": "2076939",
"fecha_completado": "0000-00-00",
"hora_completado": "00:00:00",
"activo": "Activo Simulado 4",
"placa": "TXT-321",
"comentario": "",
"sino_creacion_manual": "0",
"icono": "./Iconos/Vehiculos/CarIcon.png",
"equipo": null,
"idactivo": "13955",
"grupo": "",
"estado": "Pendiente",
"definicion": {
"distancia": 80,
"conductor1": [
{
"id": "1960",
"nombre": "NELSON MAURICION BRAM",
"codigo": ""
}
],
"conductor2": [
{
"id": "",
"nombre": "",
"codigo": ""
}
],
"creado": "2021-05-17 00:00:00",
"lugares": [
{
"id": "465845",
"tipo": 1,
"orden": "1",
"nombre": "el negro mandingo",
"dist_pa": 0,
"latLng": "19.059873,-98.237004",
"fEstimada": 0,
"tolerancia": "0",
"timeBetween": 15,
"distLleg": 0,
"orientacion": "",
"completado": "0",
"ViajeHora": "0",
"ViajeMin": "15",
"TiempoParado": "0",
"RadioPunto": "0",
"HoraConfigHorario": "Invalid date",
"llegadaEstimada": "2021-05-05 00:00:00",
"salidaEstimada": "2021-05-05 00:00:00",
"horaSale": "00:00",
"horallega": "00:00",
"horallegaEstimada": "00:00:00",
"horaSaleEstimada": "00:00:00"
}
],
"EsHoraFija": 0
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la ruta programada
Entero
nombre
Nombre asignado a la ruta programada
Texto
fecha_inicio
Fecha programada de inicio de la ruta
Fecha (aaaa-mm-dd)
hora_inicio
Hora programada de inicio de la ruta
Hora (hh:mm:ss)
fecha_fin
Fecha programada para finalizar la ruta
Fecha (aaaa-mm-dd)
hora_fin
Hora programada para finalizar la ruta
Hora (hh:mm:ss)
idruta
Identificador único de la ruta de la cual se tomaron los puntos
Entero
fecha_completado
Fecha en que se finalizó la ruta
Fecha (aaaa-mm-dd)
hora_completado
Hora en que se finalizó la ruta
Hora (hh:mm:ss)
activo
Nombre del activo que está realizando la ruta
Nombre
placa
Placa / patente correspondiente al activo
Texto
comentario
Comentario creado por el sistema sobre el estado de la ruta.
Texto
sino_creacion_manual
Indica si la ruta se creó manualmente o a partir de una programación automática.
Entero
icono
Icono asignado al activo para identificarlo en el sistema
Texto
equipo
Identificador único del equipo GPS asignado al activo
Entero
idactivo
Identificador único del activo que está realizando la ruta
Entero
grupo
Nombre del grupo al que pertenece el vehículo.
Texto
estado
Indica el status en el que se encuentra la ruta (Iniciada, Pendiente, En proceso, Cancelada)
Texto
definicion
Definición de los lugares que conforman la ruta
Texto JSON*
Nota: El formato del texto JSON utilizado para la definición de la ruta es el mismo al del método programRouteOnBus .
Programar ruta OnBus - programRouteOnBus
POST https://api.service24gps.com/api/v1/programRouteOnBus
Programa la salida de una ruta para el sistema OnBus.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idruta
Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.
2533
idactivo
Identificador único del activo que realizará el recorrido de la ruta seleccionada.
13953
nombre
Nombre asignado a la ruta programada
OnBus APII
definicion
Definición de los puntos
{ "distancia":"80", "frecuenciaSalida":"10", "lugares":[ { "id":"11789", "tipo":"2", "orden":"1", "nombre":"TERMINAL BOGOTA", "dist_pa":"0", "latLng":"4.611841,-74.17858", "fEstimada":"", "timeBetween":"0", "distLleg":"500", "orientacion":"", "salidaEstimada":"2018-05-05 18:01:18" } ], "conductor1":[ { "id":2300, "codigo":"KS8374", "nombre":"Karla Segovia" } ], "conductor2":[ { "id":2297, "codigo":"CM5732", "nombre":"Luis Morales" } ], "creado":"2021-05-05 18:01:18" }
fecha_inicio
Fecha en la que deberá iniciar la salida de ruta
2021-05-05
hora_inicio
Hora en la que deberá iniciar la salida de ruta
17:00:00
fecha_fin
Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo)
2021-05-05
hora_fin
Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo)
19:50:00
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/programRouteOnBus' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idruta="2533"' \
--form 'idactivo="13953"' \
--form 'nombre="OnBus APII"' \
--form 'definicion="{\"distancia\":\"80\",\"frecuenciaSalida\":\"10\",\"lugares\":[{\"id\":\"11789\",\"tipo\":\"2\",\"orden\":\"1\",\"nombre\":\"TERMINAL BOGOTA\",\"dist_pa\":\"0\",\"latLng\":\"4.653657365711841,-74.1157141327858\",\"fEstimada\":\"\",\"timeBetween\":\"0\",\"distLleg\":\"500\",\"orientacion\":\"\",\"salidaEstimada\":\"2018-05-05 18:01:18\"}],\"conductor1\":[{\"id\":2300,\"codigo\":\"KS8374\",\"nombre\":\"Karla Segovia\"}],\"conductor2\":[{\"id\":2297,\"codigo\":\"CM5732\",\"nombre\":\"Luis Morales\"}],\"creado\":\"2021-05-05 18:01:18\"}"' \
--form 'fecha_inicio="2021-05-05"' \
--form 'hora_inicio="17:00:00"' \
--form 'fecha_fin="2021-05-05"' \
--form 'hora_fin="19:50:00"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "2080129"
}
}
Actualizar ruta programada OnBus - updateRouteOnBus
POST https://api.service24gps.com/api/v1/updateRouteOnBus
Actualiza la información de salida de una ruta para el sistema OnBus.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador único de la ruta programada en el sistema.
2080129
nombre
Nombre asignado a la ruta programada
OnBus APII
definicion
Definición de los puntos
{ "distancia":"80", "frecuenciaSalida":"10", "lugares":[ { "id":"11789", "tipo":"2", "orden":"1", "nombre":"TERMINAL BOGOTA", "dist_pa":"0", "latLng":"4.611841,-74.17858", "fEstimada":"", "timeBetween":"0", "distLleg":"500", "orientacion":"", "salidaEstimada":"2018-05-05 18:01:18" } ], "conductor1":[ { "id":2300, "codigo":"KS8374", "nombre":"Karla Segovia" } ], "conductor2":[ { "id":2297, "codigo":"CM5732", "nombre":"Luis Morales" } ], "creado":"2021-05-05 18:01:18" }
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRouteOnBus' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="f77c31ce81907cc5f0ecffeda60fb4f6"' \
--form 'token="SJx5eXC7PtRJwHcSY8O8DYbTUZGQCSkTRD9VvriKevvpsCpxC49cJQ=="' \
--form 'id="2080129"' \
--form 'nombre="Prueba update OnBusAPII 1"' \
--form 'definicion="{\"distancia\":\"80\",\"frecuenciaSalida\":\"10\",\"lugares\":[{\"id\":\"11789\",\"tipo\":\"2\",\"orden\":\"1\",\"nombre\":\"TERMINAL BOGOTA\",\"dist_pa\":\"0\",\"latLng\":\"4.653657365711841,-74.1157141327858\",\"fEstimada\":\"\",\"timeBetween\":\"0\",\"distLleg\":\"500\",\"orientacion\":\"\",\"salidaEstimada\":\"2018-05-17 18:01:18\"}],\"conductor1\":[{\"id\":2300,\"codigo\":\"KS8374\",\"nombre\":\"Karla Segovia\"}],\"conductor2\":[{\"id\":2297,\"codigo\":\"CM5732\",\"nombre\":\"Luis Morales\"}],\"creado\":\"2021-05-17 18:01:18\"}"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "2080129"
}
}
Eliminar ruta programda OnBus - deleteProgrammedRouteOnBus
POST https://api.service24gps.com/api/v1/deleteProgrammedRouteOnBus
Elimina una ruta programada.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idruta
Identificador único de la ruta programada.
138225
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getProgrammedRoutesOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Listar rutas OnBus - getRoutesOnBus
POST https://api.service24gps.com/api/v1/getRoutesOnBus
Obtiene la lista de todas las rutas OnBus que pertenecen al cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getRoutesOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"distancia": 80,
"lugares": [
{
"id": "234208",
"tipo": 1,
"orden": "4",
"nombre": "numero 4",
"dist_pa": 36,
"latLng": "19.030818,-98.21381",
"fEstimada": "",
"tolerancia": "0",
"timeBetween": 5,
"distLleg": 15,
"orientacion": "",
"completado": "0",
"ViajeHora": "0",
"ViajeMin": "5",
"TiempoParado": "0",
"RadioPunto": "15",
"HoraConfigHorario": "Invalid date"
},
{
"id": "234209",
"tipo": 1,
"orden": "5",
"nombre": "numero 5",
"dist_pa": 109,
"latLng": "19.03168,-98.213316",
"fEstimada": "",
"tolerancia": "0",
"timeBetween": 5,
"distLleg": 15,
"orientacion": "",
"completado": "0",
"ViajeHora": "0",
"ViajeMin": "5",
"TiempoParado": "0",
"RadioPunto": "15",
"HoraConfigHorario": "Invalid date"
},
{
"id": "234210",
"tipo": 1,
"orden": "6",
"nombre": "numero 6",
"dist_pa": 227,
"latLng": "19.030686,-98.211428",
"fEstimada": "",
"tolerancia": "0",
"timeBetween": 5,
"distLleg": 15,
"orientacion": "",
"completado": "0",
"ViajeHora": "0",
"ViajeMin": "5",
"TiempoParado": "0",
"RadioPunto": "15",
"HoraConfigHorario": "Invalid date"
}
],
"descripcion": "Ruta test",
"tiempoEstimado": "31-03-2022",
"id": "1602",
"nombre": "Ruta de Prueba."
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
distancia
Distancia en metros para considerar que se llegó a un lugar, éste valor aplica para los lugares que tengan distLleg = 0.
Entero
lugares
Información de los lugares que conforman la ruta.
Arreglo de objetos
descripcion
Descripción breve de la ruta.
Cadena de texto
tiempoEstimado
Fecha en la que se crea la ruta.
Date (dd-mm-aaaa)
id
Identificador único de la ruta en el sistema.
Entero
nombre
Nombre con el que se identifica la ruta en el sistema.
Cadena de texto
Crear ruta OnBus - createRouteOnBus
POST https://api.service24gps.com/api/v1/createRouteOnBus
Permite crear la definición o serie de puntos que conforman una ruta; la cual estará disponible para ser utilizada con OnBus.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
Nombre con el que se identifica la ruta en el sistema.
Test RouteOnBus
definicion
Definición de los puntos.
{ "distancia": 80,
"lugares": [
{ "id": "234210", "tipo": 1, "orden": "6", "nombre": "numero 6", "dist_pa": 227, "latLng": "19.030686,-98.211428", "fEstimada": "", "tolerancia": "0", "timeBetween": 5, "distLleg": 15, "orientacion": "", "completado": "0", "ViajeHora": "0", "ViajeMin": "5", "TiempoParado": "0", "RadioPunto": "15", "HoraConfigHorario": "Invalid date" } ], "descripcion": "Ruta test", "tiempoEstimado": "31-01-2018", "nombre": "Ruta de Prueba."
}
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createRouteOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test RouteOnBus"' \
--form 'definicion="{\"distancia\":80,\"lugares\":[{\"id\":\"234210\",\"tipo\": 1,\"orden\":\"6\",\"nombre\": \"numero 6\",\"dist_pa\": 227,\"latLng\"\"19.030686,-98.211428\",\"fEstimada\": \"\",\"tolerancia\": \"0\",\"timeBetween\": 5,\"distLleg\": 15,\"orientacion\": \"\",\"completado\": \"0\",\"ViajeHora\": \"0\",\"ViajeMin\": \"5\",\"TiempoParado\": \"0\",\"RadioPunto\": \"15\",\"HoraConfigHorario\": \"Invalid date\"}],\"descripcion\": \"Ruta test\",\"tiempoEstimado\": \"31-01-2018\",\"id\": \"1602\",\"nombre\": \"Ruta de Prueba.\"}"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "2300129"
}
}
Actualizar ruta OnBus - updateRouteOnBus
POST https://api.service24gps.com/api/v1/updateRouteOnBus
Permite realizar la modificación de la información de una ruta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador único de la ruta en el sistema.
Update Test Nombre 3
nombre
Nombre con el que se identificará la ruta en el sistema.
New Driver 3
definicion
Definición de los puntos.
{ "distancia": 80,
"lugares": [
{ "id": "2300129", "tipo": 1, "orden": "6", "nombre": "numero 6", "dist_pa": 227, "latLng": "19.030686,-98.211428", "fEstimada": "", "tolerancia": "0", "timeBetween": 5, "distLleg": 15, "orientacion": "", "completado": "0", "ViajeHora": "0", "ViajeMin": "5", "TiempoParado": "0", "RadioPunto": "15", "HoraConfigHorario": "Invalid date" } ], "descripcion": "Ruta test", "tiempoEstimado": "31-01-2018", "id": "2300129", "nombre": "Ruta de Prueba."
}
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRouteOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test RouteOnBus"' \
--form 'definicion="{\"distancia\":80,\"lugares\":[{\"id\":\"2300129\",\"tipo\": 1,\"orden\":\"6\",\"nombre\": \"numero 6\",\"dist_pa\": 227,\"latLng\"\"19.030686,-98.211428\",\"fEstimada\": \"\",\"tolerancia\": \"0\",\"timeBetween\": 5,\"distLleg\": 15,\"orientacion\": \"\",\"completado\": \"0\",\"ViajeHora\": \"0\",\"ViajeMin\": \"5\",\"TiempoParado\": \"0\",\"RadioPunto\": \"15\",\"HoraConfigHorario\": \"Invalid date\"}],\"descripcion\": \"Ruta test\",\"tiempoEstimado\": \"31-01-2018\",\"id\": \"1602\",\"nombre\": \"Ruta de Prueba.\"}"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "2300129"
}
}
Eliminar ruta OnBus - deleteRouteOnBus
POST https://api.service24gps.com/api/v1/deleteRouteOnBus
Este método permite eliminar una ruta especifica.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idRuta
Identificador único de la ruta en el sistema.
138225
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteRouteOnBus' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Plataforma - OnDelivery
Listar todos los productos - getAllProducts
POST https://api.service24gps.com/api/v1/ondelivery/getAllProducts
Obtiene todos los productos de un cliente - distribuidor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllProducts' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": {
"1": {
"id": "2",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"nombre": "Mi Prodducto 2",
"descripcion": "Este es el segundo producto",
"costo": "105",
"impuesto": "16.8",
"idmoneda": "4",
"peso": "99.99",
"volumen": "89.00",
"unidad_peso": "0",
"unidad_volumen": "0",
"idtipo_activo_producto_od": null,
"codigo_producto": null,
"estado": "1",
"valor_unidad_peso": null,
"valor_unidad_volumen": null,
"nombre_moneda": "COP"
},
"2": {
"id": "3",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"nombre": "Mi Prodducto 3",
"descripcion": "Este es el tercer producto",
"costo": "200",
"impuesto": "32",
"idmoneda": "4",
"peso": "99.99",
"volumen": "30.00",
"unidad_peso": "0",
"unidad_volumen": "0",
"idtipo_activo_producto_od": null,
"codigo_producto": null,
"estado": "1",
"valor_unidad_peso": null,
"valor_unidad_volumen": null,
"nombre_moneda": "COP"
},
"3": {
"id": "176",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"nombre": "Mí producto",
"descripcion": "",
"costo": "43",
"impuesto": "6.88",
"idmoneda": "2",
"peso": "2.00",
"volumen": "3.00",
"unidad_peso": "166",
"unidad_volumen": "156",
"idtipo_activo_producto_od": "5",
"codigo_producto": "",
"estado": "1",
"valor_unidad_peso": "kilogramo",
"valor_unidad_volumen": "Metros cubicos",
"nombre_moneda": "MXN"
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del producto.
Entero
idcliente_distribuidor
Identificador único del distribuidor.
Entero
idcliente_sistema
Identificador único del cliente.
Entero
nombre
Nombre del producto.
Cadena de texto
descripcion
Descripción del producto.
Cadena de texto
costo
Costo.
Entero
impuesto
Impuesto.
Flotante
idmoneda
Identificador único de la moneda.
Entero
peso
Peso.
Flotante
volumen
Volumen.
Flotante
unidad_peso
Unidad de peso.
Entero
unidad_volumen
Unidad de volumen.
Entero
idtipo_activo_producto_od
Identificador único del activo del producto.
Entero
codigo_producto
Código del producto
Cadena de texto
estado
Estado.
Entero
valor_unidad_peso
Valor unidad de peso.
Cadena de texto
valor_unidad_volumen
Valor unidad de volumen.
Cadena de texto
nombre_moneda
Nombre de la moneda.
Cadena de texto
Listar clientes - getAllClient
POST https://api.service24gps.com/api/v1/ondelivery/getAllClient
Obtiene todos los clientes creados en la plataforma de OnDelivery.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllClient' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": {
"id": "2",
"nombre": "client 2",
"razon_social": "informatica",
"identificador": null,
"contacts": [],
"address": [
{
"id": "1996",
"nombre": "Direccion 1",
"idpais": "2",
"idprovincia": "11",
"ciudad": "Atizapan de Zaragoza",
"calle": "Av Paseo de zaragoza",
"numero_int": "",
"numero_ext": "52",
"codigo_postal": "0",
"idtipo_domicilio": "0",
"idcliente_od": "2",
"idcontacto_cliente_od": "0",
"latitud": "19.5575007",
"longitud": "-99.2392561",
"estado": "1"
}
]
},
"2": {
"id": "3",
"nombre": "cliente 3",
"razon_social": "mi razon social",
"identificador": null,
"contacts": [],
"address": [
{
"id": "1997",
"nombre": "Direccion 1",
"idpais": "2",
"idprovincia": "11",
"ciudad": "Atizapan de Zaragoza",
"calle": "Paseo de las alamedas",
"numero_int": "",
"numero_ext": "72",
"codigo_postal": "0",
"idtipo_domicilio": "0",
"idcliente_od": "3",
"idcontacto_cliente_od": "0",
"latitud": "19.5509438",
"longitud": "-99.2415031",
"estado": "1"
}
]
},
"3": {
"id": "3870",
"nombre": "Cliente Costa rica",
"razon_social": "N/A",
"identificador": "000000000022",
"contacts": [],
"address": [
{
"id": "2132",
"nombre": "Tienda Costa Rica",
"idpais": "9",
"idprovincia": "219",
"ciudad": "Curridabat",
"calle": "A044",
"numero_int": "",
"numero_ext": "111",
"codigo_postal": "11801",
"idtipo_domicilio": "0",
"idcliente_od": "3870",
"idcontacto_cliente_od": "0",
"latitud": "9.9139642",
"longitud": "-84.0371452",
"estado": "1"
},
{
"id": "2138",
"nombre": "Tienda Costa Rica Centro",
"idpais": "9",
"idprovincia": "219",
"ciudad": "Curridabat",
"calle": "A044",
"numero_int": "",
"numero_ext": "128",
"codigo_postal": "11801",
"idtipo_domicilio": "1",
"idcliente_od": "3870",
"idcontacto_cliente_od": "0",
"latitud": "9.9141155",
"longitud": "-84.0283294",
"estado": "1"
}
]
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del cliente.
Entero
nombre
Nombre del cliente.
Cadena de texto
razon_social
Razón social.
Cadena de texto
identificador
Identificador.
Entero
contacts
Contacto del cliente.
Json
address
Dirección del cliente.
Json
Listar detalle del pedido - getOrderDetail
POST https://api.service24gps.com/api/v1/ondelivery/getOrderDetail
Devuelve el detalle del pedido.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
order_id
Identificador único de la orden.
5307
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/ondelivery/getOrderDetail' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'order_id="5307"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "5307",
"costo_total": "0",
"timestamp_inicio": "2022-05-12 13:37:00",
"timestamp_fin": "2022-05-15 13:37:00",
"idcliente_od": "27",
"idalmacen_od": "13",
"idstatus_pedido_od": "4",
"subtotal": "0",
"impuesto": "0",
"idmoneda": "57",
"num_factura": "",
"peso_total": "0.00",
"volumen_total": "0.00",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idusuario_sistema": "5163",
"comentarios": "",
"iddomicilio_cliente_od": "436",
"pagado": "0",
"numero_pedido": "0000000046",
"tiempo_servicio": "10",
"cantidad": "0",
"inventario_afectado": "1",
"estado": "1",
"codigo_rastreo": "5608351360120",
"cliente": "Cliente prueba",
"status_pedido": "Cancelado",
"moneda": "EUR",
"idvehiculo_od": null,
"detalle": []
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la orden.
Entero
costo_total
Costo total.
Cadena de texto
timestamp_inicio
Fecha inicio.
Timestamp
timestamp_fin
Fecha fin.
Timestamp
idcliente_od
Identificador único del cliente.
Entero
idalmacen_od
Identificador único del almacén.
Entero
idstatus_pedido_od
Identificador único del pedido.
Entero
subtotal
Subtotal.
Cadena de texto
impuesto
Impuesto.
Cadena de texto
idmoneda
Identificador único del tipo de moneda.
Entero
num_factura
Número de factura.
Cadena de texto
peso_total
Peso total.
Cadena de texto
volumen_total
Volumen total.
Cadena de texto
idcliente_distribuidor
Identificador único del distribuidor.
Entero
idcliente_sistema
Identificador único del cliente.
Entero
idusuario_sistema
Identificador único del usuario.
Entero
comentarios
Comentario sobre la orden.
Cadena de texto
iddomicilio_cliente_od
Identificador único del domicilio.
Entero
numero_pedido
Número del pedido.
Cadena de texto
tiempo_servicio
Tiempo del servicio.
Cadena de texto
cantidad
Cantidad.
Cadena de texto
estado
Estado de la orden
Entero
codigo_rastreo
Código de rastreo.
Cadena de texto
cliente
Nombre del cliente.
Cadena de texto
status_pedido
Status de la orden.
Cadena de texto
moneda
Moneda.
Cadena de texto
idvehiculo_od
Identificador único del vehículo.
Entero
detalle
detalle de la orden
Array
Listar ordenes- getOrders
POST https://api.service24gps.com/api/v1/ondelivery/getOrders
Este método lista las ordenes creadas.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
begin_date
Fecha de inicio.
2022-05-01
end_date
Fecha fin.
2022-05-30
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getOrders' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'begin_date="2022-05-01"' \
--form 'end_date="2022-05-30"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "5307",
"idcliente_od": "27",
"cliente": "Cliente prueba",
"idstatus_pedido_od": "1",
"status": "Pendiente",
"idmoneda": "57",
"moneda": "EUR",
"timestamp_inicio": "2022-05-12 13:37:00",
"timestamp_fin": "2022-05-15 13:37:00",
"num_factura": "",
"subtotal": "0",
"impuesto": "0",
"costo_total": "0",
"peso_total": "0.00",
"volumen_total": "0.00",
"comentarios": "",
"iddomicilio_cliente_od": "436",
"tiempo_servicio": "10",
"numero_pedido": "0000000046",
"cantidad": "0",
"horario_entrega": "2022-05-12 13:37 - 13:37",
"codigo_rastreo": "5608351360120",
"vehiculo": "Sin activo",
"placa": ""
},
{
"id": "5309",
"idcliente_od": "27",
"cliente": "Cliente prueba",
"idstatus_pedido_od": "1",
"status": "Pendiente",
"idmoneda": "57",
"moneda": "EUR",
"timestamp_inicio": "2022-05-13 13:37:00",
"timestamp_fin": "2022-05-16 13:37:00",
"num_factura": "852526",
"subtotal": "0",
"impuesto": "0",
"costo_total": "0",
"peso_total": "200.00",
"volumen_total": "50.00",
"comentarios": "productos nuevos",
"iddomicilio_cliente_od": "436",
"tiempo_servicio": "10",
"numero_pedido": "0000000048",
"cantidad": "0",
"horario_entrega": "2022-05-13 13:37 - 13:37",
"codigo_rastreo": "5808491360879",
"vehiculo": "Sin activo",
"placa": ""
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la orden.
Entero
idcliente_od
Identificador único del cliente.
Entero
cliente
Nombre del cliente.
Cadena de texto
idstatus_pedido_od
Identificador único del pedido.
Entero
status
Status de la orden.
Cadena de texto
idmoneda
Identificador único del tipo de moneda.
Entero
moneda
Moneda.
Cadena de texto
timestamp_inicio
Fecha inicio.
Timestamp
timestamp_fin
Fecha fin.
Timestamp
num_factura
Número de factura.
Cadena de texto
subtotal
Subtotal.
Cadena de texto
impuesto
Impuesto.
Cadena de texto
costo_total
Costo total.
Cadena de texto
peso_total
Peso total.
Cadena de texto
volumen_total
Volumen total.
Cadena de texto
comentarios
Comentario sobre la orden.
Cadena de texto
iddomicilio_cliente_od
Identificador único del domicilio.
Entero
tiempo_servicio
Tiempo del servicio.
Cadena de texto
numero_pedido
Número del pedido.
Cadena de texto
cantidad
Cantidad.
Cadena de texto
horario_entrega
Horario de entrega.
Cadena de texto
codigo_rastreo
Código de rastreo.
Cadena de texto
vehiculo
Nombre del vehículo.
Cadena de texto
placa
Placa del vehículo.
Cadena de texto
Crear orden - createOrder
POST https://api.service24gps.com/api/v1/ondelivery/createOrder
Este método permite crear una orden.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
inicio
(Requerido) Fecha de inicio.
2025-05-01 09:00:00
fin
(Requerido) Fecha fin.
2025-05-01 10:00:00
idcliente_od
(Requerido) Identificador único del cliente. El id se puede obtener en el método getAllClient
2078
idstatus_pedido_od
(Opcional) Identificador único del status del pedido. El id se puede obtener en el método getStatuses
1
num_factura
(Opcional) Número de factura.
1992
num_pedido
(Opcional) Número de pedido.
405
comentario
(Opcional) Comentario sobre el pedido.
productos nuevos
iddomicilio
(Requerido) Identificador único del domicilio. El id se puede obtener en el método getAllAddressClient
14999
pago
(Opcional) Pago del pedido.
0
tiempo_servicio
(Requerido) Tiempo de servicio.
10
afecta_inventario
(Opcional) Afecta inventario.
1
idalmacen_od
(Opcional) Identificador único del almacén. El id se puede obtener en el método getAllWareHouse
150
detalle
(Requerido) Detalle de los productos.
[ {"idproducto_od":"41","cantidad":"5" }]
peso_total
(Opcional) Peso total.
200
volumen_total
(Opcional) Volumen total,
50
costo_total
(Opcional) Costo total.
0
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/createOrder' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'inicio="2025-07-15 09:00:00"' \
--form 'fin="2025-07-15 10:00:00"' \
--form 'idcliente_od="2078"' \
--form 'idstatus_pedido_od="1"' \
--form 'num_factura="1992"' \
--form 'numero_pedido="405"' \
--form 'comentario="productos nuevos"' \
--form 'iddomicilio="14999"' \
--form 'tiempo_servicio="10"' \
--form 'afecta_inventario="1"' \
--form 'idalmacen_od="150"' \
--form 'detalle="[{\"idproducto_od\":\"51\",\"cantidad\":\"1\"}]"' \
--form 'detalle_productos="1"' \
--form 'peso_total="200"' \
--form 'volumen_total="50"' \
--form 'costo_total="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "907893",
"costo_total": 1160,
"timestamp_inicio": "2025-07-15 09:00:00",
"timestamp_fin": "2025-07-15 10:00:00",
"idcliente_od": "20534",
"idalmacen_od": "150",
"idstatus_pedido_od": 1,
"subtotal": 1000,
"impuesto": 160,
"idmoneda": "2",
"num_factura": "1992",
"peso_total": 10,
"volumen_total": "",
"idcliente_distribuidor": "78987",
"idcliente_sistema": "78986",
"idusuario_sistema": "64323",
"comentarios": "",
"iddomicilio_cliente_od": "14999",
"pagado": false,
"numero_pedido": "405",
"tiempo_servicio": "10",
"cantidad": 0,
"inventario_afectado": "1",
"estado": 1,
"codigo_rastreo": "521481799",
"datos_extras": null
}
Editar orden - editOrder
POST https://api.service24gps.com/api/v1/ondelivery/editOrder
Este método permite editar una orden.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
order_id
Identificador único de la orden.
5309
inicio
Fecha de inicio.
2022-05-13 13:37:00
fin
Fecha fin.
2022-05-16 13:37:00
idcliente_od
Identificador único del cliente.
27
idstatus_pedido_od
Identificador único del status del pedido.
1
num_factura
Número de factura.
852526
num_pedido
Número de pedido.
224
comentario
Comentario sobre el pedido.
productos nuevos
iddomicilio
Identificador único del domicilio.
436
pago
Pago del pedido.
0
tiempo_servicio
Tiempo de servicio.
10
afecta_inventario
Afecta inventario.
1
idalmacen_od
Identificador único del almacén.
13
detalle
Detalle de los productos.
[ {"idproducto_od":"41","cantidad":"5" }]
peso_total
Peso total.
200
volumen_total
Volumen total,
50
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/editOrder' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'order_id="5309"' \
--form 'inicio="2022-05-13 13:37:00"' \
--form 'fin="2022-05-16 13:37:00"' \
--form 'idcliente_od="27"' \
--form 'idstatus_pedido_od="1"' \
--form 'num_factura="852526"' \
--form 'numero_pedido="224"' \
--form 'comentario="productos edit nuevos"' \
--form 'iddomicilio="436"' \
--form 'pago="0"' \
--form 'tiempo_servicio="10"' \
--form 'afecta_inventario="1"' \
--form 'idalmacen_od="13"' \
--form 'detalle="[{\"idproducto_od\":\"41\",\"cantidad\":\"3\"}]"' \
--form 'detalle_productos="productos nuevos"' \
--form 'peso_total="200"' \
--form 'volumen_total="50"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "5309",
"costo_total": 0,
"timestamp_inicio": "2022-05-13 13:37:00",
"timestamp_fin": "2022-05-16 13:37:00",
"idcliente_od": "27",
"idalmacen_od": "13",
"idstatus_pedido_od": 1,
"subtotal": 0,
"impuesto": 0,
"idmoneda": "57",
"num_factura": "852526",
"peso_total": "200",
"volumen_total": "50",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idusuario_sistema": "5163",
"comentarios": "productos edit nuevos",
"iddomicilio_cliente_od": "436",
"pagado": false,
"numero_pedido": "",
"tiempo_servicio": "10",
"cantidad": 0,
"inventario_afectado": "1",
"estado": "1",
"codigo_rastreo": "5808491360879",
"cliente": "cliente x",
"status_pedido": "Pendiente",
"moneda": "EUR",
"idvehiculo_od": null
}
}
Eliminar orden - deleteOrder
POST https://api.service24gps.com/api/v1/ondelivery/deleteOrder
Este método permite editar una orden.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
order_id
Identificador único de la orden.
5309
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/ondelivery/deleteOrder' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SwfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'order_id="5307"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": "El pedido ha sido eliminado"
}
}
En caso de no encontrarse la orden muestra la siguiente respuesta.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "error",
"message": "No se encontró el pedido"
}
}
Listar accounts - getAccounts
POST https://api.service24gps.com/api/v1/ondelivery/getAccounts
Obtiene el listado de cuentas de los clientes.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAccounts' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "9",
"idcliente_od": "6",
"cliente": "super deux 1",
"idmoneda": "4",
"moneda": "COP",
"saldo": "-10684.56"
},
{
"id": "528",
"idcliente_od": "721",
"cliente": "David Segura",
"idmoneda": "4",
"moneda": "COP",
"saldo": "-343.36"
},
{
"id": "529",
"idcliente_od": "37",
"cliente": "Test propietario",
"idmoneda": "4",
"moneda": "COP",
"saldo": "-487.2"
},
{
"id": "789",
"idcliente_od": "4",
"cliente": "cliente x",
"idmoneda": "57",
"moneda": "EUR",
"saldo": "-3648.2"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del account.
Entero
idcliente_od
Identificador único del cliente.
Entero
cliente
Nombre del cliente
Cadena de Texto
idmoneda
Identificador único de la moneda.
Entero
moneda
Moneda.
Cadena de Texto
saldo
Saldo.
Flotante
Crear Account - createAccount
POST https://api.service24gps.com/api/v1/ondelivery/createAccount
Crea una cuenta para un cliente de OnDelivery ya sea con saldo o sin saldo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente_od
Identificador único del cliente.
4
amount
Monto de la cuenta.
500
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/ondelivery/createAccount' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcliente_od="4"' \
--form 'amount="500"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"account_id": "792"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
account_id
Identificador único del account.
Entero
Editar Account - editAccount
POST https://api.service24gps.com/api/v1/ondelivery/editAccount
Modifica el monto de una cuenta y registra un movimiento de cuenta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
account_id
Identificador único de la cuenta.
792
amount
Monto de la cuenta.
5000
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/ondelivery/editAccount' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'account_id="792"' \
--form 'amount="5000"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"account_id": "792"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
account_id
Identificador único del account.
Entero
Eliminar Account - deleteAccount
POST https://api.service24gps.com/api/v1/ondelivery/deleteAccount
Elimina la cuenta de un cliente y todos los movimientos asociados a la misma.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
account_id
Identificador único de la cuenta.
792
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/ondelivery/editAccount' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'account_id="792"' \
Respuesta de ejemplo:
{
"status": 200,
"data": {
"account": "792"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
account
Identificador único del account.
Entero
Listar detalle de la cuenta - getAccountDetail
POST https://api.service24gps.com/api/v1/ondelivery/getAccountDetail
Obtiene el saldo de la cuenta junto con todos los movimientos realizados.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente
Identificador único del cliente.
4
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/ondelivery/getAccountDetail' \
--header 'Cookie: PHPSESSID=bk9ighpj0cmprh88e7nift0kkb' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'idcliente_od="4"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"cuenta": {
"id": "790",
"cliente": "cliente x",
"saldo": "50",
"moneda": "EUR"
},
"movimientos": [
{
"fecha_realizado": "2022-05-13 10:48:00",
"saldo_anterior": "1500",
"monto_operacion": "-1500",
"realizado_por": "DEMO test"
},
{
"fecha_realizado": "2022-05-13 09:39:53",
"saldo_anterior": "0",
"monto_operacion": "3698.2",
"realizado_por": "DEMO test"
}
],
"monto": 3698.2
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del account (cuenta).
Entero
cliente
Nombre del cliente (cuenta).
Cadena de Texto
moneda
Moneda (cuenta).
Cadena de Texto
saldo
Saldo (cuenta).
Flotante
fecha_realizado
Fecha de movimiento (movimientos).
Timestamp
saldo_anterior
Saldo anterior (movimientos).
Flotante
monto_operacion
Monto agregado (movimientos).
Flotante
realizado_por
Movimiento realizado (movimientos).
Cadena de Texto
monto
Monto total de la cuenta.
Flotante
Listar información del dashboard - getDashboardData
POST https://api.service24gps.com/api/v1/ondelivery/getDashboardData
Obtiene la información para mostrar en el dashboard.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getDashboardData' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"deliveries": [],
"orders": [
{
"status": "Pendiente",
"total": "3"
}
],
"clients": [
{
"status": "Con pedido",
"total": 0
},
{
"status": "Sin pedido",
"total": 22
},
{
"status": "Total",
"total": 22
}
],
"vehicles": [
{
"status": "Con entregas",
"total": 0
},
{
"status": "Sin entregas",
"total": 82
},
{
"status": "Total",
"total": 82
}
],
"in_route": []
}
}
Listar almacenes - getAllWareHouse
POST https://api.service24gps.com/api/v1/ondelivery/getAllWareHouse
Obtiene todos los almacenes de un distribuidor - cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllWareHouse' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": {
"0": {
"id": "1",
"nombre": "Almacen del sur",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Se encuentra al sur de la ciudad",
"idpais": "2",
"idprovincia": "21",
"ciudad": "Puebla",
"calle": "Av 21 poniente",
"numero_int": "2",
"numero_ext": "3315",
"cp": "72160",
"latitud": "19.0494123",
"longitud": "-98.2281553",
"estado": "1"
},
"1": {
"id": "2",
"nombre": "Almacen del centro",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Almacen del centro de la ciudad",
"idpais": "0",
"idprovincia": "0",
"ciudad": "",
"calle": "Av 21 poniente",
"numero_int": "2",
"numero_ext": "3314",
"cp": "72160",
"latitud": "",
"longitud": "",
"estado": "1"
},
"2": {
"id": "3",
"nombre": "Almacen del norte",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Almacen del norte de la ciudad",
"idpais": "0",
"idprovincia": "0",
"ciudad": "",
"calle": "Av 21 poniente",
"numero_int": "2",
"numero_ext": "3314",
"cp": "72160",
"latitud": "",
"longitud": "",
"estado": "1"
},
"3": {
"id": "4",
"nombre": "Almacen del noreste",
"idvehiculo": null,
"idcliente_sistema": "4221",
"idcliente_distribuidor": "4220",
"descripcion": "Se encuentra del noreste.....",
"idpais": "0",
"idprovincia": "0",
"ciudad": "",
"calle": "Av 23 Poniente",
"numero_int": "",
"numero_ext": "3000",
"cp": "72180",
"latitud": "",
"longitud": "",
"estado": "1"
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del almacén.
Entero
nombre
Nombre del almacén.
Cadena de texto
idvehiculo
Identificador único del vehículo.
Entero
idcliente_sistema
Identificador único del cliente.
Entero
idcliente_distribuidor
Identificador único del distribuidor.
Entero
descripcion
Descripción del almacén.
Cadena de texto
idpais
Identificador único del país.
Entero
idprovincia
Identificador único de la provincia.
Entero
ciudad
Nombre de la ciudad.
Cadena de texto
calle
Calle.
Cadena de texto
numero_int
Número de interior.
Entero
numero_ext
Número de exterior.
Entero
cp
Código postal.
Cadena de texto
latitud
Latitud.
Cadena de texto
longitud
Longitud.
Cadena de texto
estado
Estado del almacén.
Entero
Listar zonas - getAllZones
POST https://api.service24gps.com/api/v1/ondelivery/getAllZones
Obtiene todas las zonas de un cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllZones' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": {
"1": {
"id": "2",
"nombre": "Almacen Centro",
"descripcion": "Se encuentra en el centro de la ciudad",
"almacen": "Almacen del sur",
"idalmacen": "1"
},
"2": {
"id": "3",
"nombre": "Almacen Norte.",
"descripcion": "Se encuentra al Norte de la ciudad",
"almacen": "Almacen del sur",
"idalmacen": "1"
},
"3": {
"id": "4",
"nombre": "Almacen Oestre",
"descripcion": "Se encuentra al sur de la ciudad",
"almacen": "Almacen del sur",
"idalmacen": "1"
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la zona
Entero
nombre
Nombre de la zona.
Cadena de texto
descripcion
Descripción de la zona.
Cadena de texto
almacen
Nombre del almacén.
Cadena de texto
idalmacen
Identificador único del almacén.
entero
Listar contactos - getAllContactClient
POST https://api.service24gps.com/api/v1/ondelivery/getAllContactClient
Obtiene todos los contactos de un cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente
Identificador único del cliente.
5
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getAllContactClient' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'idcliente="5"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": [
{
"id": "56",
"nombre": "Maria Dolores",
"notas": "RH",
"idcliente_od": "5",
"datos_contacto": "{\"2\":[\"55443322\"],\"4\":[\"ma@gmail.com\"]}",
"estado": "1"
},
{
"id": "57",
"nombre": "Marco",
"notas": "Test",
"idcliente_od": "5",
"datos_contacto": "{\"2\":[\"222275546\"]}",
"estado": "1"
},
{
"id": "208",
"nombre": "Jose Maria",
"notas": "",
"idcliente_od": "5",
"datos_contacto": "{\"2\":[\"66332200\"],\"4\":[\"jmaria@hotmail.com\"]}",
"estado": "1"
},
{
"id": "209",
"nombre": "Juliana Hernandez",
"notas": "",
"idcliente_od": "5",
"datos_contacto": "{\"3\":[\"2223635958\"]}",
"estado": "1"
},
{
"id": "343",
"nombre": "Contacto x",
"notas": "",
"idcliente_od": "5",
"datos_contacto": "{\"3\":[\"1234567890\"],\"4\":[\"my_fake_email@xdxd.com\"]}",
"estado": "1"
}
]
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del contacto.
Entero
nombre
Nombre del contacto.
Cadena de texto
notas
Notas.
Cadena de texto
idcliente_od
Identificador único del cliente.
Entero
datos_contacto
Datos del contacto.
Json
estado
Estado
Entero
Listar información del contacto - getInfoContact
POST https://api.service24gps.com/api/v1/ondelivery/getInfoContact
Obtiene la información de un contacto.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcontacto
Identificador único del contacto.
56
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getInfoContact' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcontacto="56"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": {
"nombre": "Maria Dolores",
"notas": "RH",
"telefono": "55443322",
"email": "ma@gmail.com"
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
nombre
Nombre del contacto.
Cadena de texto
notas
Notas.
Cadena de texto
telefono
Teléfono del contacto.
Cadena de texto
email
Email del contacto.
Cadena de texto
Listar opciones del vehículo - getOptionsVehicle
POST https://api.service24gps.com/api/v1/ondelivery/getOptionsVehicle
Obtiene las opciones del vehículo.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idvehiculo
Identificador único del vehículo.
37922
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getOptionsVehicle' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idvehiculo="37922"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": {
"0": {
"id": "6",
"idvehiculo": "37922",
"peso_maximo": "1500.00",
"volumen_maximo": "800.00",
"tipo_lugar_salida": "LUGAR",
"lugar_salida": "36609",
"unidad_peso": "0",
"unidad_volumen": "0",
"cantidad": "0",
"idtipo_activo_producto_od": null,
"inicio_labores": "06:00:00",
"fin_labores": "22:00:00",
"datos_tipo_activo": "{}",
"tipo_carga": "1"
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único.
Entero
idvehiculo
Identificador único del vehículo.
Entero
peso_maximo
Peso máximo.
Flotante
volumen_maximo
Volumen máximo
Flotante
tipo_lugar_salida
Tipo del lugar.
Cadena de texto
unidad_peso
Unidad de peso.
Entero
unidad_volumen
Unidad de volumen.
Entero
cantidad
Cantidad.
Entero
idtipo_activo_producto_od
Identificador único del tipo activo.
Entero
inicio_labores
Fecha de inicio.
time
fin_labores
Fecha fin.
time
datos_tipo_activo
Datos del tipo activo.
Json
tipo_carga
Tipo de carga.
Entero
Listar inventarios - getInventories
POST https://api.service24gps.com/api/v1/ondelivery/getInventories
Obtiene los inventarios de un cliente - distribuidor.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getInventories' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": {
"1": {
"id": "2",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idalmacen_od": "0",
"idzona_od": "2",
"idproducto_od": "1",
"cantidad": "75",
"subtotal": "4650",
"total": "5394",
"impuesto": "744",
"idmoneda": "2",
"timestamp": "2020-06-25 16:11:08",
"estado": "1",
"nombre_zona": "Almacen Centro",
"nombre_almacen": null,
"nombre_producto": "Mi Prodducto 1.1",
"nombre_moneda": "MXN",
"idproducto": "1"
},
"2": {
"id": "3",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idalmacen_od": "0",
"idzona_od": "2",
"idproducto_od": "2",
"cantidad": "79",
"subtotal": "8295",
"total": "9622.2",
"impuesto": "1327.2",
"idmoneda": "2",
"timestamp": "2020-06-25 16:11:23",
"estado": "1",
"nombre_zona": "Almacen Centro",
"nombre_almacen": null,
"nombre_producto": "Mi Prodducto 2",
"nombre_moneda": "MXN",
"idproducto": "2"
},
"3": {
"id": "4",
"idcliente_distribuidor": "4220",
"idcliente_sistema": "4221",
"idalmacen_od": "0",
"idzona_od": "2",
"idproducto_od": "5",
"cantidad": "74",
"subtotal": "6364",
"total": "7382.24",
"impuesto": "1018.24",
"idmoneda": "2",
"timestamp": "2020-07-02 17:43:30",
"estado": "1",
"nombre_zona": "Almacen Centro",
"nombre_almacen": null,
"nombre_producto": "Mi Prodducto 5",
"nombre_moneda": "MXN",
"idproducto": "5"
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del inventario.
Entero
idcliente_distribuidor
Identificador único del distribuidor.
Entero
idcliente_sistema
Identificador único del cliente.
Entero
idalmacen_od
Identificador único del almacén.
Entero
cantidad
Cantidad.
Entero
subtotal
Subtotal.
Entero
total
Total.
Flotante
impuesto
Impuesto
Flotante
idmoneda
Identificador único de la moneda.
Entero
timestamp
Tiempo.
TimeStamp
estado
Estado.
Entero
nombre_zona
Nombre de la zona.
Cadena de texto
nombre_almacen
Nombre del almacén.
Cadena de texto
nombre_producto
Nombre del producto.
Cadena de texto
nombre_moneda
Nombre de la moneda.
Cadena de texto
idproducto
Identificador único del producto.
Entero
Listar pedidos - getDelivers
POST https://api.service24gps.com/api/v1/ondelivery/getDelivers
Este método lista los pedidos del cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
begin_date
Fecha de inicio.
2022-05-01
end_date
Fecha fin.
2022-05-30
add_past_orders
-Mostrar pedidos pasados cuando no hay en la fecha solicitada: 1
-Mostrar solo pedidos con la fecha indicada: 0
0
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getDelivers' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'begin_date="2022-05-01"' \
--form 'end_date="2022-05-30"' \
--form 'add_past_orders=1'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"message": "Mostrando entregas del día seleccionado",
"deliveries": [
{
"id": "420",
"comentarios": "",
"timestamp_inicio": "2021-04-10 09:00:00",
"timestamp_fin": "2021-04-10 18:00:00",
"idformulario": "15",
"idvehiculo_od": "6",
"idvehiculo": "37922",
"idconductor": "25731",
"peso_maximo": "1500.00",
"volumen_maximo": "800.00",
"lugar_salida": "36609",
"tipo_lugar_salida": "LUGAR",
"pedidos": [
{
"order_id": "3850",
"id_form": "0",
"comments": "",
"timestamp": "2021-04-07 17:14:00",
"status_order": "5",
"orden_entrega": "1",
"iddomicilio_cliente_od": "1995",
"numero_pedido": "",
"codigo_rastreo": "0817131360451",
"subtotal": "103.44",
"impuesto": "16.56",
"costo_total": "120",
"cantidad": "0",
"volumen": "12.00",
"peso": "12.00",
"nombre_cliente": "client 1.1",
"idcliente_od": "1"
}
],
"salida_iniciada": true
},
{
"id": "405",
"comentarios": "",
"timestamp_inicio": "2021-03-26 09:00:00",
"timestamp_fin": "2021-03-26 18:00:00",
"idformulario": "0",
"idvehiculo_od": "6",
"idvehiculo": "37922",
"idconductor": "25731",
"peso_maximo": "1500.00",
"volumen_maximo": "800.00",
"lugar_salida": "36609",
"tipo_lugar_salida": "LUGAR",
"pedidos": [
{
"order_id": "3796",
"id_form": "0",
"comments": "",
"timestamp": "2021-03-26 14:44:51",
"status_order": "7",
"orden_entrega": "3",
"iddomicilio_cliente_od": "666",
"numero_pedido": "",
"codigo_rastreo": "3412171360495",
"subtotal": "296",
"impuesto": "47.36",
"costo_total": "343.36",
"cantidad": "0",
"volumen": "172.00",
"peso": "399.96",
"nombre_cliente": "David Segura",
"idcliente_od": "721"
},
{
"order_id": "3797",
"id_form": "0",
"comments": "",
"timestamp": "2021-03-26 14:44:50",
"status_order": "8",
"orden_entrega": "1",
"iddomicilio_cliente_od": "434",
"numero_pedido": "",
"codigo_rastreo": "1312181360628",
"subtotal": "600",
"impuesto": "96",
"costo_total": "696",
"cantidad": "0",
"volumen": "90.00",
"peso": "299.97",
"nombre_cliente": "super deux 1",
"idcliente_od": "6"
},
{
"order_id": "3798",
"id_form": "0",
"comments": "",
"timestamp": "2021-03-26 14:44:51",
"status_order": "2",
"orden_entrega": "2",
"iddomicilio_cliente_od": "1994",
"numero_pedido": "",
"codigo_rastreo": "1812201360512",
"subtotal": "420",
"impuesto": "67.2",
"costo_total": "487.2",
"cantidad": "0",
"volumen": "356.00",
"peso": "399.96",
"nombre_cliente": "Test propietario",
"idcliente_od": "37"
}
],
"salida_iniciada": true
}
]
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la orden.
Entero
comentarios
Comentario sobre la orden.
Cadena de texto
timestamp_inicio
Fecha inicio.
Timestamp
timestamp_fin
Fecha fin.
Timestamp
idformulario
Identificador único del formulario.
Entero
idvehiculo_od
Identificador único del vehículo od.
Entero
idvehiculo_od
Identificador único del vehículo.
Entero
idconductor
Identificador único del conductor.
Entero
peso_maximo
Peso máximo.
Flotante
volumen_maximo
Volumen máximo.
Flotante
lugar_salida
Identificador único del lugar.
Entero
tipo_lugar_salida
Tipo del lugar.
Cadena de texto
pedidos
Detalle del pedido
Json
salida_iniciada
Salida iniciada.
Bolean
Listar vehículos - vehicleGetAllComplete
POST https://api.service24gps.com/api/v1/ondelivery/vehicleGetAllComplete
Este método devuelve el listado de los vehículos.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/vehicleGetAllComplete' \
--header 'Cookie: PHPSESSID=6g5p2n9vso19j8vgdc9fcuind1' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "13952",
"nombre": "Activo Simulado 1...",
"patente": "MYA-4323",
"idgps": "19567",
"gatewayip": "107.170.254.11",
"conductor": "",
"grupo": null,
"marca": "Porsche",
"modelo": "911",
"color": "",
"anio": "1967",
"numero_serie": "1234567890",
"tipo_vehiculo": "Automovil",
"latitud_salida": "",
"longitud_salida": ""
},
{
"id": "13953",
"nombre": "Lancer123",
"patente": "POP-1234",
"idgps": null,
"gatewayip": null,
"conductor": "Juan Pedro Lopez Diaz",
"grupo": "prueba grupo 2",
"marca": "RAM",
"modelo": "Lancer",
"color": "",
"anio": "2015",
"numero_serie": "1234567890",
"tipo_vehiculo": "Camion",
"latitud_salida": "19.027047",
"longitud_salida": "-98.207274"
},
{
"id": "13954",
"nombre": "Activo Simulado 3",
"patente": "TXT-123",
"idgps": "123123123125",
"gatewayip": "",
"conductor": "",
"grupo": "Grupo NOrte",
"marca": "",
"modelo": "Civic Type R",
"color": "",
"anio": "2018",
"numero_serie": "1234567890",
"tipo_vehiculo": "",
"latitud_salida": "",
"longitud_salida": ""
},
{
"id": "181677",
"nombre": "PRUEBATIPOCOMANDO_",
"patente": "",
"idgps": "PRUEBATIPOCOMANDO",
"gatewayip": "",
"conductor": "",
"grupo": null,
"marca": "",
"modelo": "",
"color": "",
"anio": "0",
"numero_serie": "",
"tipo_vehiculo": "Automovil",
"latitud_salida": "",
"longitud_salida": ""
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del vehículo.
Entero
nombre
Nombre asignado al vehículo
Cadena de Texto
patente
Patente del vehículo
Cadena de Texto
idgps
identificador gps
Entero
gatewayip
ip del gateway
Cadena de Texto
conductor
Nombre del conductor
Cadena de Texto
grupo
Nombre del grupo
Cadena de Texto
marca
Marca del vehículo
Cadena de Texto
modelo
Modelo del vehículo
Cadena de Texto
color
Color de vehículo
Cadena de Texto
anio
Año del vehículo
Cadena de Texto
numero_serie
Numero de serie
Cadena de Texto
latitud_salida
latitud
Cadena de Texto
longitud_salida
longitud
Cadena de texto
Listar status - getStatuses
POST https://api.service24gps.com/api/v1/ondelivery/getStatuses
Este método devuelve los status que puede tener un pedido.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getStatuses' \
--header 'Cookie: PHPSESSID=6g5p2n9vso19j8vgdc9fcuind1' \
--form 'apikey="9e815ce8b91e40379407320cd0a13a98"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "1",
"nombre": "Pendiente"
},
{
"id": "2",
"nombre": "En tránsito"
},
{
"id": "3",
"nombre": "Entregado"
},
{
"id": "4",
"nombre": "Cancelado"
},
{
"id": "5",
"nombre": "Programado para entrega"
},
{
"id": "6",
"nombre": "Cliente no encontrado"
},
{
"id": "7",
"nombre": "Entregado y confirmado"
},
{
"id": "8",
"nombre": "En proceso de entrega"
}
]
}
Obtener latitud y longitud - getPositionFromAddress
POST https://api.service24gps.com/api/v1/ondelivery/getPositionFromAddress
Obtener latitud y longitud a través del domicilio.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
address
Domicilio.
Av. Paseo de la Reforma, Juárez, Cuauhtémoc, 06500 Ciudad de México, CDMX
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/getPositionFromAddress' \
--header 'Cookie: PHPSESSID=999egj9j5mnaevhamfu16s90a9' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
--form 'address="Av. Paseo de la Reforma, Juárez, Cuauhtémoc, 06500 Ciudad de México, CDMX"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"lat": 19.42911,
"lng": -99.16227
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
lat
Latitud
Cadena de texto
lng
Longitud
Cadena de texto
Listar direcciones - getAllAddressClient
POST https://api.service24gps.com/api/v1/ondelivery/getAllAddressClient
Lista las direcciones de un cliente especifico.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente
Identificador único del cliente. El id se puede obtener en el método getAllClient
1792
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/ondelivery/getAllAddressClient' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
--data-urlencode 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
--data-urlencode 'idcliente=1792'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"message": [
{
"id": "8956",
"nombre": "Bosques Sebastian",
"idpais": "2",
"idprovincia": "21",
"ciudad": "bosques del pilar",
"calle": "Cd. Judicial",
"numero_int": "500",
"numero_ext": "0",
"codigo_postal": "72899",
"idtipo_domicilio": "0",
"idcliente_od": "87898",
"idcontacto_cliente_od": "0",
"latitud": "19.78991114",
"longitud": "-98.789250017746",
"datos_extras": null,
"estado": "1",
"pais": "México",
"provincia": "Puebla",
"contacto": "",
"domicilio_completo": "Cd. Judicial #0 int. 500, bosques del pilar, Puebla, México; C.P. 72899"
},
{
"id": "8957",
"nombre": "Bodega Aurrera Bosques",
"idpais": "2",
"idprovincia": "21",
"ciudad": "bosques de san sebastian",
"calle": "bouleard mexico",
"numero_int": "",
"numero_ext": "78",
"codigo_postal": "0",
"idtipo_domicilio": "0",
"idcliente_od": "21134",
"idcontacto_cliente_od": "167786",
"latitud": "19.789117552307",
"longitud": "-98.2654467144165",
"datos_extras": null,
"estado": "1",
"pais": "México",
"provincia": "Puebla",
"contacto": "Gerente Aurrera",
"domicilio_completo": "bouleard mexico #78, bosques de san sebastian, Puebla, México",
}
]
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del domicilio.
Numérico
nombre
Nombre de la dirección.
texto
idpais
Identificador único del país.
Numérico
idprovincia
Identificador único de la provincia.
Numérico
ciudad
Nombre de la ciudad.
texto
calle
Nombre de la calle.
texto
numero_int
Número de interior del domicilio.
Numérico
numero_ext
Número de exterior del domicilio.
Numérico
codigo_postal
Código postal.
texto
idtipo_domicilio
Identificador único del tipo de domicilio.
Numérico
idcliente_od
Identificador único del cliente.
Numérico
idcontacto_cliente_od
Identificador único del contacto del cliente.
Numérico
latitud
Latitud
texto
longitud
Longitud
texto
datos_extras
Información adicional
JSON
estado
Nombre del estado.
texto
pais
Nombre del país.
texto
provincia
Nombre de la provincia.
texto
contacto
Nombre del contacto.
texto
domicilio_completo
Domicilio completo.
texto
Crear cliente - addClient
POST https://api.service24gps.com/api/v1/ondelivery/addClient
Crear cliente en la plataforma de OnDelivery.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
(Requerido) Nombre del cliente.
Test Client
razon_social
(Opcional) Razón social.
RS-0001
identificador
(Requerido) Identificador único del cliente.
ID-001
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/ondelivery/addClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test Client"' \
--form 'razon_social="RS-0001"' \
--form 'identificador="ID-001"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": "ok",
"data": {
"id_cliente": "90194"
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id_cliente
Identificador único del cliente.
Entero
Listar información del cliente - getClientByIdentifier
POST https://api.service24gps.com/api/v1/ondelivery/getClientByIdentifier
Lista la información de un cliente registrado en OnDelivery mediante su identificador.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
identifier
Identificador del cliente en OnDelivery.
ID-001
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/ondelivery/getClientByIdentifier' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'identifier="ID-001"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "5598891",
"nombre": "Cliente GPS",
"contacts": [
{
"id": "788",
"nombre": "Pedro Gerente",
"notas": "Gerente zona sur",
"idcliente_od": "78977",
"datos_contacto": "{\"2\":[\"55228899557\"],\"3\":[\"7352222221\"],\"4\":[\"gerentesur@gmail.com\"]}",
"estado": "1"
},
{
"id": "789",
"nombre": "Efrain Gerente",
"notas": "Supervisor de Almacen Bosques",
"idcliente_od": "78978",
"datos_contacto": "{\"2\":[\"2222258974\"],\"3\":[\"5589541123\"],\"4\":[\"supervisor@gmail.com\"]}",
"estado": "1"
}
],
"address": [
{
"id": "87878",
"nombre": "Avenida Sur 1525",
"idpais": "2",
"idprovincia": "21",
"ciudad": "Puebla",
"calle": "calle 9b",
"numero_int": "1590",
"numero_ext": "60",
"codigo_postal": "79810",
"idtipo_domicilio": "1",
"idcliente_od": "78977",
"idcontacto_cliente_od": "788",
"latitud": "19.061688",
"longitud": "-98.1344889",
"datos_extras": null,
"estado": "1"
}
],
"razon_social": "RZ-05801",
"identificador": "ID-001"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del cliente.
Entero
nombre
Nombre del cliente.
Texto
contacts
Contacto del cliente.
JSON
address
Dirección del cliente.
JSON
razon_social
Razón social del cliente.
Texto
identificador
Identificador del cliente.
Texto
Plataforma - OnDriving
Lista de viajes calculados - getOnDrivingInfo
POST https://api.service24gps.com/api/v1/getOnDrivingInfo
Obtiene el listado de todos los viajes calculados en OnDriving para un activo perteneciente a un usuario o cliente en un rango de fechas.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idvehiculo
Identificador único del vehículo dentro de la plataforma.
53008
equipo
IMEI / Identificador del equipo GPS en plataforma.
354148072188807
fecha_ini
Fecha de inicio del rango sobre el cual se va a realizar la búsqueda de información del viaje
2021-05-05
fecha_fin
Fecha fin del rango sobre el cual se va a realizar la búsqueda de información del viaje
2021-05-05
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getOnDrivingInfo' \
--data-urlencode 'apikey=f77c31ce81907cc5f0ecffeda60fb4f6' \
--data-urlencode 'token=SJx5eXC7PtRJwHcSY8O8Da3WZTOlUZCHrOsfmvYFMU/MckoIQjPytg==' \
--data-urlencode 'idvehiculo=53008' \
--data-urlencode 'equipo=354148072188807' \
--data-urlencode 'fecha_ini=2021-05-05' \
--data-urlencode 'fecha_fin=2021-05-05'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"inicio_viaje": {
"fecha_hora": "2021-05-05 12:21:53",
"domicilio": "Boulevard Esteban de Antuñano 112, Luz Obrera, 72110 Puebla, Pue., México"
},
"final_viaje": {
"fecha_hora": "2021-05-05 14:51:39",
"domicilio": "Boulevard Esteban de Antuñano, Reforma, 72160 Puebla, Puebla"
},
"duracion_viaje": "8986",
"distancia_viaje": "30980",
"calificacion_viaje": "0.7",
"categorias": [
{
"categoria": "Velocidades",
"calificacion": 0.7,
"calificacion_categoria": 6.28,
"duracion_evento": "3211",
"distancia": "30980",
"configuracion": {
"velocidad": "70",
"activo": "1",
"importancia": "1.1110888888888888"
},
"eventos": []
}
]
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
inicio_viaje
Contiene la información de inicio del viaje (fecha, hora y domicilio)
Objeto
final_viaje
Contiene la información de fin de viaje (fecha, hora y domicilio)
Objeto
duracion_viaje
Tiempo total de viaje (en segundos)
Entero
distancia_viaje
Distancia total recorrida durante el viaje (en metros)
Entero
calificacion_viaje
Calificación final del viaje
Flotante
categorias
Información de las categorías evaluadas durante el viaje
Arreglo de Objetos
Plataforma - OnForms
Método para obtener las respuestas de un formulario - getAnswersForms
POST https://api.service24gps.com/api/v1/onforms/getAnswersForms
Para obtener el listado de todas las respuestas de un formulario en un rango de fechas.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
username
Un usuario autorizado para usar el servicio por parte del cliente y debe estar definido previamente.
usuario
password
Contraseña asociada al usuario.
contraseña
form_id
Id del formulario a consultar.
41
start_date
Fecha de inicio de la búsqueda.
2025-11-01
end_date
Fecha de fin de la búsqueda
2025-12-01
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/onforms/getAnswersForms' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'username="usuario"' \
--form 'password="contraseña"'
--form 'form_id="41"' \
--form 'start_date="2025-11-01"' \
--form 'end_date="2025-12-01"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "5682",
"duration": "2021-12-31",
"header": {
"imagen1": "",
"imagen2": "",
"nombre": "TEST ELEMENTOS2",
"showFolio": "1"
},
"general": {
"cmp-DtoGeneral-6": "20/10/2021",
"cmp-DtoGeneral-4": "3",
"cmp-DtoGeneral-2": "-1"
},
"categories": {
"cmp-DtoCategoria-7": "20/10/2021",
"cmp-DtoCategoria-2": "3",
"cmp-DtoCategoria-1": "-1"
},
"footer": {},
"patent": "TZF-38",
"driver_name": "Juan",
"location": "37.32984161,-122.02685809",
"folio": "333",
"date": "2021-12-18",
"hour": "21:14:20",
"form_id": "41"
},
]
}
Plataforma - OnReports
Listar reportes - getReports
POST https://api.service24gps.com/api/v1/getReports
Obtiene el listado de reportes asignados al usuario.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getReports' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "33",
"nombre": "Distancia recorrida",
"descripcion": "En este reporte podrá ver la distancia recorrida en kilometros que realizó el activo en diferentes días, horarios y rango de fechas (puede utilizar horario o jornada laboral)",
"columnas": [
"Activo",
"Conductor",
"Placa",
"Fecha inicial",
"Hora inicial",
"Lugar inicio",
"Fecha final",
"Hora final",
"Lugar final",
"Tiempo de viaje",
"Distancia recorrida"
],
"filtros": {
"sino_mostrar_detalle": {
"tipo": "boolean",
"titulo": "Detalle de la distancia recorrida",
"descripcion": "Muestra el total de km del periodo de tiempo que se haya elegido y no por dia."
},
"sino_calcular_paradas": {
"tipo": "boolean",
"titulo": "Calcular paradas",
"descripcion": "Muestra un mejor detalle cuando los vehiculos tienen una velocidad menor a 10 km/h"
},
"sino_horario_trabajo": {
"tipo": "boolean",
"titulo": "¿Usar horario de trabajo?",
"descripcion": "Utiliza el horario configurado para obtener por cada dia los reportes dentro de ese rango."
},
"detalle_distancia_recorrida": {
"tipo": "boolean",
"titulo": "Detalle de distancia recorrida",
"descripcion": "Muestra todos los puntos reportados por el equipo en el periodo de fechas seleccionados y agrega las columnas: Odometro, Velocidad y Evento",
"valor": "0"
}
},
"columnas_no_seleccionadas": [
1,
5,
8,
9
]
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del reporte.
Entero
nombre
Nombre asignado al reporte.
Cadena de Texto
descripcion
Breve descripción del reporte.
Cadena de Texto
columnas
Columnas del reporte.
Cadena de Texto
filtros
Filtros del reporte.
Cadena de Texto
columnas _no_seleccionadas
Columnas no seleccionadas del reporte.
Entero
Listar los reportes programados - getProgrammedReports
POST https://api.service24gps.com/api/v1/onreports/getProgrammedReports
Este método devuelve el listado de los reportes programados de la plataforma OnReports.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/onreports/getProgrammedReports' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "000001",
"name_report": "Reporte de paradas",
"attached_format": [
"XLS",
"PDF",
"JSON"
],
"asset_groups": [],
"assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"start_date": "2024-09-25",
"start_time": "00:00:00",
"end_date": "2024-09-25",
"end_time": "23:59:59",
"time_range": "Hoy",
"days_to_send_report": [
"Lunes",
"Martes",
"Miércoles",
"Jueves",
"Viernes",
"Sábado",
"Domingo"
],
"columns": [
"Activo",
"Fecha",
"Hora",
"Placa",
"Descripcion",
"Tiempo parado",
"Latitud",
"Longitud",
"Domicilio",
"Lugar",
"Geocerca",
"Grupo Vehiculo",
"Ver mapa"
],
"send_report": "1",
"send_report_email": "test@gmail.com"
},
{
"id": "000002",
"name_report": "Sensores: Ignición",
"attached_format": [
"XLS",
"PDF",
"JSON"
],
"asset_groups": [],
"assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"start_date": "2024-09-25",
"start_time": "00:00:00",
"end_date": "2024-09-25",
"end_time": "23:59:59",
"time_range": "Hoy",
"days_to_send_report": [
"Lunes",
"Martes",
"Miércoles",
"Jueves",
"Viernes",
"Sábado",
"Domingo"
],
"columns": [],
"send_report": "1",
"send_report_email": "test@gmail.com"
},
{
"id": "000003",
"name_report": "Seguimiento completo",
"attached_format": [
"XLS",
"PDF"
],
"asset_groups": [],
"assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"start_date": "2024-09-25",
"start_time": "00:00:00",
"end_date": "2024-09-25",
"end_time": "23:59:59",
"time_range": "Hoy",
"days_to_send_report": [
"Lunes",
"Martes",
"Miércoles",
"Jueves",
"Viernes",
"Sábado",
"Domingo"
],
"columns": [
"Fecha",
"Hora",
"Activo",
"Conductor",
"Direccion",
"Orientacion",
"Velocidad",
"Evento",
"Latitud",
"Longitud",
"Odometro",
"Lugar mas cercano",
"Placa",
"Temperatura",
"Temperatura2",
"Ver mapa",
"Buffer",
"TimeStamp",
"Geocerca"
],
"send_report": "1",
"send_report_email": "test@gmail.com"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del reporte programado.
Entero
name_report
Nombre del reporte programado.
Cadena de Texto
attached_format
Adjuntos que generara el reporte.
Arreglo
asset_groups
Grupos de Activos seleccionados
Arreglo
assets
Activos seleccionados.
Arreglo
start_date
Fecha de inicio del reporte.
Cadena de Texto
start_time
Hora de inicio del reporte.
Cadena de Texto
end_date
Fecha final del reporte.
Cadena de Texto
end_time
Hora final del reporte.
Cadena de Texto
time_range
Rango de fechas de ejecución del reporte.
Cadena de Texto
days_to_send_report
Días de la semana que se enviara el reporte programado.
Arreglo
columns
Columnas seleccionadas.
Arreglo
send_report
Enviar automáticamente el reporte por correo.
Entero
send_report_email
Correo electrónico en donde se enviara el reporte programado.
Cadena de Texto
Obtener la información del reporte programado - getScheduledReportResult
POST https://api.service24gps.com/api/v1/onreports/getScheduledReportResult
Este método devuelve la información de la última ejecución del reporte programado en la plataforma OnReports.
NOTA: Para enviar la solicitud del método getScheduledReportResult es necesario tener seleccionado la opción JSON en el formato del reporte en OnReports.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken .
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
report_id
(Requerido) Identificador único del reporte programado.
El id del reporte programado se puede consultar en el método getProgrammedReports.
000001
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/onreports/getScheduledReportResult' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'report_id="000001"'
Respuesta de ejemplo:
{
"status": 200,
"headers": {
"last_execution": "2024-09-25 12:00:00",
"start_datetime": "2024-09-25 00:00:00",
"end_datetime": "2024-09-25 23:59:59",
"execution_id": "87ddc52d2e65e",
"client_id": "123456",
"destination_url": "https://google.com/getTestRequest",
"saved_report_id": "000001",
"saved_report_name": "Reporte de paradas",
"report_type": "",
"selected_assets": {
"000001": "Activo Simulado 1",
"000002": "Activo Simulado 2"
},
"assets_groups": []
},
"data": {
"columns": {
"IdVehiculo": "Activo",
"Fecha": "Fecha",
"Hora": "Hora",
"Placa": "Placa",
"Descripcion": "Descripcion",
"Tiempo_parado": "Tiempo parado",
"Latitud": "Latitud",
"Longitud": "Longitud",
"Domicilio": "Domicilio",
"Lugar": "Lugar",
"Geocerca": "Geocerca",
"grupo_activo": "Grupo Vehiculo",
"link_gm": "Ver mapa"
},
"result": {
{
"activo": "Activo",
"fecha": "2024-09-25",
"hora": "00:00:00",
"placa": "Simulado 1",
"descripcion": "Parado desde 2024-09-25 00:00:00 hasta 2024-09-25 12:00:00",
"tiempo_parado": "12:00:00",
"latitud": "19.032639",
"longitud": "-98.200619",
"domicilio": "1er Rtno. Osa Menor 2-oficina 301, 72810 San Bernardino Tlaxcalancingo, Pue.",
"lugar": "Almacen general",
"geocerca": "Centro de distribución",
"grupo_activo": "",
"link_gm": "Ver mapa "
}
}
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
columns
Columnas del reporte programado.
JSON
result
Información del reporte programado.
JSON
headers
JSON con información extra del reporte programado.
JSON
Formato de respuesta headers
Ver formato:
Nombre
Descripción
Valor de la propiedad
Ejemplo
Headers
Formato de respuesta de la petición.
last_execution: Fecha y hora de ultima ejecución del reporte programado.
start_datetime: Fecha y hora de inicio del reporte programado.
end_datetime: Fecha y hora final del reporte programado.
execution_id: Id único del reporte programado.
client_id: Id cliente sistema.
destination_url: Url de destino en donde se enviara una petición POST cuando se termine de procesar el reporte programado.
saved_report_id: Id del reporte programado.
saved_report_name: Nombre del reporte programado.
report_type: Tipo de reporte.
selected_assets: Activos seleccionados.
assets_groups: Grupos de Activos seleccionados.
{ "last_execution": "2024-09-25 12:00:00", "start_datetime": "2024-09-25 00:00:00", "end_datetime": "2024-09-25 23:59:59", "execution_id": "87ddc52d2e65e", "client_id": "123456",
"destination_url": "https://google.com/getTestRequest", "saved_report_id": "000001", "saved_report_name": "Reporte de paradas", "report_type": "", "selected_assets": { "000001": "Activo Simulado 1", "000002": "Activo Simulado 2" }, "assets_groups": [] }
Plataforma - OnRouting
Crear programación de ruta - programRoute
POST https://api.service24gps.com/api/v1/programRoute
Permite crear la definición o serie de puntos que conforman una ruta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador único de la ruta en el sistema.
1382123
idruta
Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.
34534
idactivo
Identificador único del activo que realizará el recorrido de la ruta seleccionada.
245855
nombre
Nombre con el que se identificará la ruta dentro de la plataforma.
Prueba nombre ruta
definición
Definición de puntos.
{
"distancia":80, "lugares": [
{ "id":"36589", "tipo":1, "orden":"1", "nombre":"Departamento 1", "dist_pa":0, "latLng":"18.900479,-98.435602", "fEstimada":"", "tolerancia":0, "timeBetween":0, "distLleg":0, "orientacion":"" } ], "waypoints":[ ], "puntos":[ ], "rutas":[ ], "sinoGarmin":0, "useRoutePlaces":0
}
fecha_inicio
Fecha en la que deberá iniciar la salida de ruta.
2022-02-27
hora_inicio
Hora en la que deberá iniciar la salida de ruta.
15:30:00
fecha_fin
Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
2022-02-28
hora_fin
Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
20:00:00
dias
Días de la semana en que se ejecutará la salida de ruta, los valores aceptados son: Lu, Ma, Mi, Ju, Vi. Sa, Do; los días se separan con el signo “-”.
Lu-Mi-Vi-Sa
periodo
Periodo en que se reprogramará la ruta, los valores aceptados son: 1 = Todos los días 2 = Todas las semanas 3 = Todos los meses 4 = Todos los años 5 = Continuamente
2
repetir
Indica la frecuencia de días, semanas, meses o años en que se debe repetir la ruta.
1
veces
Número de veces que se debe cumplir la ruta antes de finalizarla (enviar 0 en caso de no utilizarlo).
0
termina
Indica cuando se debe considerar la ruta como finalizada. Los valores aceptados son: 1 = Nunca, la ruta se repite indefinidamente 2 = Después de n veces (la cantidad de repeticiones se especifica en el parámetro anterior “veces”) 3 = Finaliza en una fecha y hora específica (la fecha se indica en “fecha_fin” y “hora_fin”) 4 = Finaliza automáticamente al llegar al último punto.
4
Nota: La definición debe tener el mismo formato que el utilizado en el método createRoute .
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/programRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'idruta="34534"' \
--form 'idactivo="245855"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"distancia":80,"lugares":[{"id":"36589","tipo":1,"orden":"1","nombre":"Departamento 1","dist_pa":0,"latLng":"18.900479,-98.435602","fEstimada":"","tolerancia":0,"timeBetween":0,"distLleg":0,"orientacion":""}],"waypoints":{},"puntos":{},"rutas":[],"sinoGarmin":0,"useRoutePlaces":0}"' \
--form 'fecha_inicio="2022-02-27"' \
--form 'hora_inicio="15:30:00"' \
--form 'fecha_fin=""' \
--form 'hora_fin=""' \
--form 'dias="Lu-Mi-Vi-Sa"' \
--form 'periodo="2"' \
--form 'repetir="1"' \
--form 'veces="0"' \
--form 'termina="4"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Listar rutas programadas - getScheduledRoutes
POST https://api.service24gps.com/api/v1/getScheduledRoutes
Obtiene todas las rutas programadas que se encuentren en proceso o iniciadas.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getScheduledRoutes' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status":200,
"data":[
{
"id":"35124391",
"nombre":"Ruta test programada",
"fecha_inicio":"2022-02-25",
"hora_inicio":"17:00:00",
"fecha_fin":"0000-00-00",
"hora_fin":"00:00:00",
"idruta":"35124391",
"fecha_completado":"0000-00-00",
"hora_completado":"00:00:00",
"activo":"prueba",
"placa":"prueba",
"comentario":"",
"sino_creacion_manual":"1",
"icono":"./Iconos/Vehiculos/CarIcon.png",
"equipo":"prueba",
"idactivo":"148762",
"estado":"Pendiente",
"definicion":{
"distancia":80,
"lugares":[
{
"id":"36589",
"tipo":1,
"orden":"1",
"nombre":"Departamento",
"dist_pa":0,
"latLng":"18.900479,-98.435602",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
},
{
"id":"36609",
"tipo":1,
"orden":"2",
"nombre":"Departamento 2",
"dist_pa":31528,
"latLng":"19.027292,-98.208708",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
},
{
"id":"38686",
"tipo":1,
"orden":"5",
"nombre":"Departamento 3",
"dist_pa":20511,
"latLng":"19.153059,-98.243021",
"fEstimada":"",
"tolerancia":0,
"timeBetween":0,
"distLleg":0,
"orientacion":""
}
],
"waypoints":[
],
"puntos":[
],
"rutas":[
],
"sinoGarmin":0,
"useRoutePlaces":0
}
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la ruta programada.
Entero
nombre
Información de los lugares que conforman la ruta.
Arreglo de objetos
fecha_inicio
Fecha programada de inicio de la ruta.
Date (aaaa-mm-dd)
hora_inicio
Hora programada de inicio de la ruta.
Time (hh:mm:ss)
fecha_fin
Fecha programada para finalizar la ruta.
Date (aaaa-mm-dd)
hora_fin
Hora programada para finalizar la ruta.
Time (hh:mm:ss)
idruta
Identificador único de la ruta de la cual se tomaron los puntos.
Entero
fecha_completado
Fecha en que se finalizó la ruta.
Date (aaaa-mm-dd)
hora_completado
Hora en que se finalizó la ruta
Time (hh:mm:ss)
activo
Nombre del activo que está realizando la ruta.
Cadena de texto
placa
Placa / patente correspondiente al activo.
Cadena de texto
comentario
Comentario o descripción breve sobre la ruta
Cadena de texto
icono
Icono asignado al activo para identificarlo en el sistema.
Cadena de texto
equipo
Equipo GPS asignado al activo.
Entero
idactivo
Identificador único del activo que está realizando la ruta.
Entero
estado
Indica el estado actual de la ruta.
Cadena de texto
distancia
Distancia en metros para considerar que se llegó a un lugar, éste valor aplica para los lugares que tengan distLleg = 0.
Entero
lugares
Información de los lugares que conforman la ruta.
Arreglo de objetos
waypoints
Puntos de referencia entre lugares de la ruta.
Arreglo de objetos
puntos
Rutas calculadas a través de la API de Google.
Arreglo de objetos
rutas
Geocercas de tipo ruta.
Arreglo de objetos
sinoGarmin
Indica si el dispositivo GPS tiene integrado un sistema con pantalla Garmin.
Entero
useRoutePlaces
Indica si debe usar los puntos de la ruta original o de la ruta programada.
Entero
Actualizar ruta programada - updateScheduledRoute
POST https://api.service24gps.com/api/v1/updateScheduledRoute
Permite actualizar la programación de una ruta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador único de la ruta en el sistema.
1382123
idruta
Identificador único de la ruta que se va a utilizar para la programación de salida de ruta.
34534
idactivo
Identificador único del activo que realizará el recorrido de la ruta seleccionada.
245855
nombre
Nombre con el que se identificará la ruta dentro de la plataforma.
Prueba nombre ruta
definición
Definición de puntos.
{
"distancia":80, "lugares": [
{ "id":"36589", "tipo":1, "orden":"1", "nombre":"Departamento 1", "dist_pa":0, "latLng":"18.900479,-98.435602", "fEstimada":"", "tolerancia":0, "timeBetween":0, "distLleg":0, "orientacion":"" } ], "waypoints":[ ], "puntos":[ ], "rutas":[ ], "sinoGarmin":0, "useRoutePlaces":0
}
fecha_inicio
Fecha en la que deberá iniciar la salida de ruta.
2022-02-27
hora_inicio
Hora en la que deberá iniciar la salida de ruta.
15:30:00
fecha_fin
Fecha en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
2022-02-28
hora_fin
Hora en la que finalizará la ruta (se debe enviar vacío en caso de no utilizarlo).
20:00:00
dias
Días de la semana en que se ejecutará la salida de ruta, los valores aceptados son: Lu, Ma, Mi, Ju, Vi. Sa, Do; los días se separan con el signo “-”.
Lu-Mi-Vi-Sa
periodo
Periodo en que se reprogramará la ruta, los valores aceptados son: 1 = Todos los días 2 = Todas las semanas 3 = Todos los meses 4 = Todos los años 5 = Continuamente
2
repetir
Indica la frecuencia de días, semanas, meses o años en que se debe repetir la ruta.
1
veces
Número de veces que se debe cumplir la ruta antes de finalizarla (enviar 0 en caso de no utilizarlo).
0
termina
Indica cuando se debe considerar la ruta como finalizada. Los valores aceptados son: 1 = Nunca, la ruta se repite indefinidamente 2 = Después de n veces (la cantidad de repeticiones se especifica en el parámetro anterior “veces”) 3 = Finaliza en una fecha y hora específica (la fecha se indica en “fecha_fin” y “hora_fin”) 4 = Finaliza automáticamente al llegar al último punto.
4
Nota: La definición debe tener el mismo formato que el utilizado en el método createRoute .
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateScheduledRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'idruta="34534"' \
--form 'idactivo="245855"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"distancia":80,"lugares":[{"id":"36589","tipo":1,"orden":"1","nombre":"Departamento 1","dist_pa":0,"latLng":"18.900479,-98.435602","fEstimada":"","tolerancia":0,"timeBetween":0,"distLleg":0,"orientacion":""}],"waypoints":{},"puntos":{},"rutas":[],"sinoGarmin":0,"useRoutePlaces":0}"' \
--form 'fecha_inicio="2022-02-27"' \
--form 'hora_inicio="15:30:00"' \
--form 'fecha_fin=""' \
--form 'hora_fin=""' \
--form 'dias="Lu-Mi-Vi-Sa"' \
--form 'periodo="2"' \
--form 'repetir="1"' \
--form 'veces="0"' \
--form 'termina="4"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Eliminar ruta programada - deleteScheduledRoute
POST https://api.service24gps.com/api/v1/deleteScheduledRoute
Este método permite eliminar una ruta especifica.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idRuta
Identificador único de la ruta en el sistema.
138225
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteScheduledRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si en la respuesta de la solicitud aparece "status": 30700 es un error al obtener los datos.
Respuesta de ejemplo:
{
"status": 30700,
"data": ""
}
Crear ruta - createRoute
POST https://api.service24gps.com/api/v1/createRoute
Permite crear la definición o serie de puntos que conforman una ruta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
Nombre con el que se identificará la ruta dentro de la plataforma.
Prueba nombre ruta
definición
Definición de puntos, geocercas lineales, distancia, etc.
{
"distancia":80, "lugares": [
{ "id":"36589", "tipo":1, "orden":"1", "nombre":"Departamento 1", "dist_pa":0, "latLng":"18.900479,-98.435602", "fEstimada":"", "tolerancia":0, "timeBetween":0, "distLleg":0, "orientacion":"" } ], "waypoints":[ ], "puntos":[ ], "rutas":[ ], "sinoGarmin":0, "useRoutePlaces":0
}
Nota: En caso de que no se requiera la información de waypoints , puntos o rutas ; enviar como un objeto o arreglo vacío según corresponda.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"distancia":80,"lugares":[{"id":"36589","tipo":1,"orden":"1","nombre":"Departamento 1","dist_pa":0,"latLng":"18.900479,-98.435602","fEstimada":"","tolerancia":0,"timeBetween":0,"distLleg":0,"orientacion":""}],"waypoints":{},"puntos":{},"rutas":[],"sinoGarmin":0,"useRoutePlaces":0}"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Listar rutas - getRoutes
POST https://api.service24gps.com/api/v1/getRoutes
Obtiene todas las rutas activas que pertenecen al usuario o cliente.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getRoutes' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"distancia": 80,
"lugares": [
{
"id": "365891",
"tipo": 1,
"orden": "1",
"nombre": "Departamento",
"dist_pa": 0,
"latLng": "18.900479,-98.435602",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": 0,
"orientacion": ""
},
{
"id": "395782",
"tipo": 1,
"orden": "3",
"nombre": "Punta del Cielo",
"dist_pa": 198,
"latLng": "19.027047,-98.207274",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": 0,
"orientacion": ""
},
{
"id": "386863",
"tipo": 1,
"orden": "5",
"nombre": "Casa",
"dist_pa": 20511,
"latLng": "19.153059,-98.243021",
"fEstimada": "",
"tolerancia": 0,
"timeBetween": 0,
"distLleg": 0,
"orientacion": ""
}
],
"waypoints": [],
"puntos": [],
"rutas": [],
"sinoGarmin": 0,
"useRoutePlaces": 0,
"id": "2298289",
"nombre": "PruebaRuta"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
distancia
Distancia en metros para considerar que se llegó a un lugar, éste valor aplica para los lugares que tengan distLleg = 0.
Entero
lugares
Información de los lugares que conforman la ruta.
Arreglo de objetos
waypoints
Puntos de referencia entre lugares de la ruta.
Arreglo de objetos
puntos
Rutas calculadas a través de la API de Google.
Arreglo de objetos
rutas
Geocercas de tipo ruta.
Arreglo de objetos
sinoGarmin
Indica si el dispositivo GPS tiene integrado un sistema con pantalla Garmin.
Entero
useRoutePlaces
Indica si debe usar los puntos de la ruta original o de la ruta programada.
Entero
id
Identificador único de la ruta en el sistema.
Entero
nombre
Nombre con el que se identifica la ruta en el sistema.
Cadena de texto
Actualizar ruta - updateRoute
POST https://api.service24gps.com/api/v1/updateRoute
Permite actualizar la definición o puntos que conforman una ruta.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador único de la ruta en el sistema.
1382123
nombre
Nombre con el que se identificará la ruta dentro de la plataforma.
Prueba nombre ruta
definición
Definición de puntos, geocercas lineales, distancia, etc.
{
"distancia":80, "lugares": [
{ "id":"36589", "tipo":1, "orden":"1", "nombre":"Departamento 1", "dist_pa":0, "latLng":"18.900479,-98.435602", "fEstimada":"", "tolerancia":0, "timeBetween":0, "distLleg":0, "orientacion":"" } ], "waypoints":[ ], "puntos":[ ], "rutas":[ ], "sinoGarmin":0, "useRoutePlaces":0
}
Nota: La definición debe tener el mismo formato que el utilizado en el método createRoute .
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'id="1382123"' \
--form 'nombre="Prueba nombre ruta"' \
--form 'definicion="{"distancia":80,"lugares":[{"id":"36589","tipo":1,"orden":"1","nombre":"Departamento 1","dist_pa":0,"latLng":"18.900479,-98.435602","fEstimada":"","tolerancia":0,"timeBetween":0,"distLleg":0,"orientacion":""}],"waypoints":{},"puntos":{},"rutas":[],"sinoGarmin":0,"useRoutePlaces":0}"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Eliminar ruta - deleteRoute
POST https://api.service24gps.com/api/v1/deleteRoute
Este método permite eliminar una ruta especifica.
Ver parámetros de solicitud:
Parámetros
Descripción
Ejemplo
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idRuta
Identificador único de la ruta en el sistema.
138225
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/deleteRoute' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idRuta="138225"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Nota: Si en la respuesta de la solicitud aparece "status": 30700 es un error al obtener los datos.
Respuesta de ejemplo:
{
"status": 30700,
"data": ""
}
Plataformas
Administra plataformas
Crear / actualizar una plataforma - setPlatform
POST https://api.service24gps.com/api/v1/setPlatform
Crea o actualiza una plataforma. NOTA: Una vez que se crea o actualiza, para verse reflejados los cambios se tiene que esperar alrededor de 5 minutos, ya que se maneja una cache.
Ver parámetros de solicitud:
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
Nombre para la plataforma
My Platform
url
Url de redireccionamiento para la plataforma
https://sitio.com/my_platform
icono
Campo opcional, detalle visual para la plataforma (.svg, .png); en caso de no proporcionarse se toma uno por defecto.
https://sitio.com/my_icon.svg
estado
Campo opcional, bandera para activar (1) o desactivar (0) la plataforma. Si no se proporciona por defecto es 1.
1
id
Campo opcional, sólo se manda el identificador único cuando se va actualizar
11
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/setPlatform' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="My platform"' \
--form 'url="https://sitio.com/my_platform"' \
--form 'icono="https://sitio.com/my_icon.svg"' \
--form 'estado="1"' \
--form 'id="11"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"id": "11",
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la plataforma.
Entero
Obtener plataformas - getPlatforms
POST https://api.service24gps.com/api/v1/getPlatforms
Obtiene el listado de plataformas disponibles que se hayan dado de alta anteriormente. NOTA: Una vez que se crea o actualiza, para verse reflejados los cambios se tiene que esperar alrededor de 5 minutos, ya que se maneja una cache.
Ver parámetros de solicitud:
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getPlatforms' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"estado": "1",
"icono": "https://sitio.com/my_icon.svg",
"id": "11",
"nombre": "My plataform",
"url": "https://sitio.com/my_platform"
},
{
"estado": "1",
"icono": "https://sitio.com/icon_test.svg",
"id": "12",
"nombre": "My plataform 2",
"url": "https://sitio.com/my_platform_test"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la plataforma.
Entero
nombre
Nombre que va tener la plataforma
Texto
estado
Bandera que indica si la plataforma es activa o no
(1 = activo, 0 = inactiva)
Entero
url
Url dónde va redireccionar cuando se de clic en el icono.
Texto
icono
Descripción visual de la plataforma.
Texto
Obtener plataforma - getPlatform
POST https://api.service24gps.com/api/v1/getPlatform
Obtiene la plataforma especifica que se haya dado de alta anteriormente. NOTA: Una vez que se crea o actualiza, para verse reflejados los cambios se tiene que esperar alrededor de 5 minutos, ya que se maneja una cache.
Ver parámetros de solicitud:
apikey
Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
id
Identificador de la plataforma.
11
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getPlatform' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'\
--form 'id="11"'\
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"estado": "1",
"icono": "https://sitio.com/my_icon.svg",
"id": "11",
"nombre": "My plataform",
"url": "https://sitio.com/my_platform"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único de la plataforma.
Entero
nombre
Nombre que va tener la plataforma
Texto
estado
Bandera que indica si la plataforma es activa o no
(1 = activo, 0 = inactiva)
Entero
url
Url dónde va redireccionar cuando se de clic en el icono.
Texto
icono
Descripción visual de la plataforma.
Texto
Códigos de respuesta
La respuesta de los servicios es devuelta en formato JSON e incluyen los campos status
y data , las aplicaciones de los clientes siempre deben verificar los códigos de error HTTP que se pueden producir en la petición, la tabla que anexamos a continuación son códigos de error específicos de los Servicios Web.
Tipos de respuestas:
Respuesta correcta OK.
{
"status":200,
"data":""
}
Acceso denegado.
{
"status":403,
"data":""
}
Solicitud incorrecta.
{
"status":30300,
"data":""
}
Token incorrecto, se debe solicitar uno nuevo.
{
"status":30400,
"data":""
}
Credenciales no válidas.
{
"status":30500,
"data":""
}
Dispositivo incorrecto o no autorizado.
{
"status":30600,
"data":""
}
Error al obtener los datos.
{
"status":30700,
"data":""
}
No se encontraron datos para las unidades.
{
"status":40100,
"data":""
}
Llave duplicada.
{
"status":40200,
"data":""
}
No se pudo modificar.
{
"status":40300,
"data":""
}
Intento acceder a un método/acción no autorizado.
{
"status":60500,
"data":""
}
El servicio no se encuentra disponible.
{
"status":99500,
"data":""
}
Respuesta con Error (401):
Devuelve un JSON
"Invalid API Key or User Token"
Gestión de WebServices
Administrar WebServices que se crean por el distribuidor.
Crear WebService
POST https://api.service24gps.com/api/v1/createWebservice
Crea un WebService a nivel distribuidor.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
nombre
(Requerido) Nombre del repetidor.
Mi repetidor de datos
tipo_transmision
(Requerido) Tipo de transmisión. Valores aceptados: TCP, UDP, SOAP, RESTful.
TCP
tipo_envio
(Opcional) Tipo del envío, valores aceptados: JSON, XML, string, otro. Si no se proporciona este campo, su valor por defecto será JSON.
json
host
(Requerido) Dirección Host por establecer al WebService, este campo es obligatorio sólo si el tipo de transmisión seleccionado es SOAP o RESTful. Representa el valor del host necesario para realizar la comunicación de envío.
https://192.168.1.100/my-endpoint
ip
(Requerido) Dirección IP por establecer al WebService, este campo es obligatorio sólo si el tipo de transmisión seleccionado es TCP o UDP. Representa el valor de la IP necesaria para realizar la comunicación de envío.
192.168.1.100
port
(Requerido) Puerto por establecer al WebService, este campo es obligatorio sólo si el tipo de transmisión seleccionado es TCP o UDP. Representa el valor del puerto necesario para realizar la comunicación de envío.
80
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/createWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'nombre=Mi repetidor de datos' \
-F 'tipo_transmision=RESTful' \
-F 'host=https://192.168.1.100/my-endpoint' \
-F 'tipo_envio=json'
Respuesta de ejemplo:
{
"status":200,
"data":{
"idws":151,
"webservice":"Mi repetidor de datos",
"tipo_transmision":"RESTful",
"tipo_envio":"json",
"host":"https://192.168.1.100/my-endpoint"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idws
Identificador único del repetidor del WebService.
Entero
webservice
Nombre del repetidor del WebService, no se admiten duplicados.
Cadena de Texto
tipo_transmision
Tipo de transmisión establecido al WebService
Cadena de Texto
tipo_envio
Tipo de envío establecido al WebService
Cadena de Texto
host
Dirección Host establecida al WebService.
Cadena de Texto
ip
Dirección IP establecida al WebService.
Cadena de Texto
port
Puerto establecido al WebService.
Entero
En la plataforma Partners se puede apreciar la creación del nuevo WebService:
Actualizar WebService
POST https://api.service24gps.com/api/v1/updateWebservice
Actualizar un WebService.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService a actualizar.
151
nombre
(Opcional) Nombre del WebService a actualizar.
Mi repetidor de datos
tipo_transmision
(Opcional) Tipo de transmisión. Valores aceptados: TCP, UDP, SOAP, RESTful. En el caso de una actualización si este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo.
TCP
tipo_envio
(Opcional) Tipo del envío, valores aceptados: JSON, XML, string, otro. Si no se proporciona este campo su valor por defecto será JSON. En el caso de una actualización si este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo.
json
host
(Opcional) Dirección Host por establecer al WebService, este campo es obligatorio sólo si el tipo de transmisión es SOAP o RESTful. Representa el valor del host necesario para realizar la comunicación de envío. En el caso de una actualización, si el tipo de envío es compatible y este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo.
https://192.168.1.100/my-endpoint
ip
(Opcional) Dirección IP por establecer al WebService, este campo es obligatorio sólo si el tipo de transmisión seleccionado es TCP o UDP. Representa el valor de la IP necesaria para realizar la comunicación de envío. En el caso de una actualización, si el tipo de envío es compatible y este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo.
192.168.1.100
port
(Opcional) Puerto por establecer al WebService, este campo es obligatorio sólo si el tipo de transmisión seleccionado es TCP o UDP. Representa el valor del puerto necesario para realizar la comunicación de envío. En el caso de una actualización, si el tipo de envío es compatible y este campo tiene un valor anterior, es posible omitirlo ya que continuará almacenado con el valor previo.
80
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/updateWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'nombre=Mi repetidor de datos actualizado' \
-F 'idws=151' \
-F 'tipo_transmision=SOAP' \
-F 'tipo_envio=xml' \
-F 'host=https://192.168.1.100/my-endpoint'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idws": 151,
"webservice": "Mi repetidor de datos actualizado",
"tipo_transmision": "SOAP",
"tipo_envio": "xml",
"host": "http://192.168.1.100/actual_endpoint"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idws
Identificador único del repetidor del WebService.
Entero
webservice
Nombre del repetidor del WebService, no se admiten duplicados.
Cadena de Texto
tipo_transmision
Tipo de transmisión establecido al WebService
Cadena de Texto
tipo_envio
Tipo de envío establecido al WebService
Cadena de Texto
host
Dirección Host establecida al WebService.
Cadena de Texto
ip
Dirección IP establecida al WebService.
Cadena de Texto
port
Puerto establecido al WebService.
Entero
Eliminar WebService
POST https://api.service24gps.com/api/v1/deleteWebservice
Eliminar un WebService.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService a eliminar.
151
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/deleteWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=151';
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idws": 151,
"message": "WebService Deleted"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idws
Identificador único del repetidor del WebService.
Entero
message
Mensaje de estado de la operación.
Cadena de Texto
Información de un WebService
POST https://api.service24gps.com/api/v1/getWebserviceDetails
Obtener información detallada de un WebService.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService a actualizar
151
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getWebserviceDetails' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=151'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idws": 151,
"webservice": "Mi repetidor de datos actualizado",
"tipo_transmision": "SOAP",
"tipo_envio": "xml",
"host":"https://192.168.1.100/my-endpoint"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idws
Identificador único del repetidor del WebService.
Entero
webservice
Nombre del WebService.
Cadena de Texto
tipo_transmision
Tipo de transmisión para el WebService.
Cadena de Texto
tipo_envio
Tipo de envío para el WebService.
Cadena de Texto
host
Dirección Host establecida para el WebService.
Cadena de Texto
ip
Dirección IP establecida para el WebService.
Cadena de Texto
port
Puerto establecido para el WebService.
Cadena de Texto
Lista de WebServices
POST https://api.service24gps.com/api/v1/getWebservicesList
Obtener información detallada de todos los WebServices creados por el distribuidor.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getWebserviceDetails' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=='
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idws": 151,
"webservice": "Webservice API Create Pruebas",
"tipo_transmision": "RESTful",
"tipo_envio": "json",
"host": "http://192.168.1.100/actual_endpoint"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idws
Identificador único del repetidor del WebService.
Entero
webservice
Nombre del WebService.
Cadena de Texto
tipo_transmision
Tipo de transmisión para el WebService.
Cadena de Texto
tipo_envio
Tipo de envío para el WebService.
Cadena de Texto
host
Dirección Host establecida para el WebService.
Cadena de Texto
ip
Dirección IP establecida para el WebService.
Cadena de Texto
port
Puerto establecido para el WebService.
Entero
Lista de WebService asignados por cliente
POST https://api.service24gps.com/api/v1/getWebservicesByClient
Obtener la lista de todas las asignaciones de un WebService realizadas a un cliente o a los clientes existentes.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
IdCliente
(Opcional) Identificador único del cliente, si se proporciona se obtiene la lista de Webservices asignados solo a ese cliente. Si no se proporciona un identificador de cliente se obtiene una lista de todas las asignaciones de todos los clientes en todos los WebServices del distribuidor.
661
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getWebservicesByClient' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'IdCliente=661'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idasignacion": "4909",
"idws": "151",
"webservice": "Mi repetidor de datos actualizado",
"tipo_transmision": "SOAP",
"tipo_envio": "xml",
"clientenombre": "Cliente",
"idcliente": "661",
"host": "http://192.168.1.100/actual_endpoint"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Identificador único de la asignación por cliente al WebService.
Entero
idws
Identificador único del repetidor del WebService.
Entero
webservice
Nombre del WebService.
Cadena de Texto
tipo_transmision
Tipo de transmisión para el WebService.
Cadena de Texto
tipo_envio
Tipo de envío para el WebService.
Cadena de Texto
clientenombre
Nombre del cliente.
Cadena de Texto
idcliente
Identificador único del cliente.
Entero
host
Dirección Host establecida para el WebService.
Cadena de Texto
ip
Dirección IP establecida para el WebService.
Cadena de Texto
port
Puerto establecido para el WebService.
Entero
Apagar / detener envío de datos al WebService
POST https://api.service24gps.com/api/v1/shutdownWebservice
Se detiene el envío de datos al WebService, es decir, se desactivan todas las asignaciones a nivel cliente y activo previamente asignadas al WebService.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService
151
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/shutdownWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=151'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idasignacion": "4910",
"idcliente": "29138",
"estatus": "0",
"activos": [
{
"idasignacion": "29627",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29628",
"idactivo": "287121",
"activo": "test2",
"dispositivo": "e9bc2805a621fa35",
"placa": "test2",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29629",
"idactivo": "337446",
"activo": "pruebas_spalestina",
"dispositivo": null,
"placa": "TXT-999",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29630",
"idactivo": "139608",
"activo": "Iphone 15 Pro de Tom",
"dispositivo": "84ED6A45873B4AB9BF919C2482B0E725",
"placa": "XTR-1807",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
}
]
},
{
"idasignacion": "4911",
"idcliente": "66481",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4912",
"idcliente": "64056",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4913",
"idcliente": "9",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4914",
"idcliente": "589",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4915",
"idcliente": "0",
"estatus": "0",
"activos": [
{
"idasignacion": "29627",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29628",
"idactivo": "287121",
"activo": "test2",
"dispositivo": "e9bc2805a621fa35",
"placa": "test2",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29629",
"idactivo": "337446",
"activo": "pruebas_spalestina",
"dispositivo": null,
"placa": "TXT-999",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29630",
"idactivo": "139608",
"activo": "Iphone 15 Pro de Tom",
"dispositivo": "84ED6A45873B4AB9BF919C2482B0E725",
"placa": "XTR-1807",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29662",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29663",
"idactivo": "139608",
"activo": "Iphone 15 Pro de Tom",
"dispositivo": "84ED6A45873B4AB9BF919C2482B0E725",
"placa": "XTR-1807",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29664",
"idactivo": "287121",
"activo": "test2",
"dispositivo": "e9bc2805a621fa35",
"placa": "test2",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
},
{
"idasignacion": "29665",
"idactivo": "337446",
"activo": "pruebas_spalestina",
"dispositivo": null,
"placa": "TXT-999",
"webservice": "Paquetes",
"idws": "150",
"estatus": "0"
}
]
},
{
"idasignacion": "4916",
"idcliente": "69729",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4917",
"idcliente": "77874",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4918",
"idcliente": "78791",
"estatus": "0",
"activos": []
},
{
"idasignacion": "4919",
"idcliente": "78124",
"estatus": "0",
"activos": []
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Identificador único de la asignación entre el cliente y el WebService
Entero
idcliente
Identificador único del cliente
Entero
estatus
Estado de la asignación entre el cliente y el WebService: 1 = Encendido, 0 = Apagado
Entero
activos
Listado de activos asignados a la relación entre el cliente y WebService, dónde muestra los estatus para saber sí está habilitado o no (1 = Encendido, 0 = Apagado)
Arreglo
Encender/ permitir envío de datos al WebService
POST https://api.service24gps.com/api/v1/turnOnWebservice
Se inicia el envío de datos al WebService, es decir, se activan todas las asignaciones a nivel cliente y activo previamente configuradas al WebService.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del Webservice
151
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/turnOnWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=151'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idasignacion": "4910",
"idcliente": "29138",
"estatus": "1",
"activos": [
{
"idasignacion": "29627",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29628",
"idactivo": "287121",
"activo": "test2",
"dispositivo": "e9bc2805a621fa35",
"placa": "test2",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29629",
"idactivo": "337446",
"activo": "pruebas_spalestina",
"dispositivo": null,
"placa": "TXT-999",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29630",
"idactivo": "139608",
"activo": "Iphone 15 Pro de Tom",
"dispositivo": "84ED6A45873B4AB9BF919C2482B0E725",
"placa": "XTR-1807",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
}
]
},
{
"idasignacion": "4911",
"idcliente": "66481",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4912",
"idcliente": "64056",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4913",
"idcliente": "9",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4914",
"idcliente": "589",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4915",
"idcliente": "0",
"estatus": "1",
"activos": [
{
"idasignacion": "29627",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29628",
"idactivo": "287121",
"activo": "test2",
"dispositivo": "e9bc2805a621fa35",
"placa": "test2",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29629",
"idactivo": "337446",
"activo": "pruebas_spalestina",
"dispositivo": null,
"placa": "TXT-999",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29630",
"idactivo": "139608",
"activo": "Iphone 15 Pro de Tom",
"dispositivo": "84ED6A45873B4AB9BF919C2482B0E725",
"placa": "XTR-1807",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29662",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29663",
"idactivo": "139608",
"activo": "Iphone 15 Pro de Tom",
"dispositivo": "84ED6A45873B4AB9BF919C2482B0E725",
"placa": "XTR-1807",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29664",
"idactivo": "287121",
"activo": "test2",
"dispositivo": "e9bc2805a621fa35",
"placa": "test2",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
},
{
"idasignacion": "29665",
"idactivo": "337446",
"activo": "pruebas_spalestina",
"dispositivo": null,
"placa": "TXT-999",
"webservice": "Paquetes",
"idws": "150",
"estatus": "1"
}
]
},
{
"idasignacion": "4916",
"idcliente": "69729",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4917",
"idcliente": "77874",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4918",
"idcliente": "78791",
"estatus": "1",
"activos": []
},
{
"idasignacion": "4919",
"idcliente": "78124",
"estatus": "1",
"activos": []
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Identificador único de la asignación entre el cliente y el WebService
Entero
idcliente
Identificador único del cliente
Entero
estatus
Estado de la asignación entre el cliente y el WebService: 1 = Encendido, 0 = Apagado
Entero
activos
Listado de activos asignados a la relación entre el cliente y WebService, dónde muestra los estatus para saber sí está habilitado o no (1 = Encendido, 0 = Apagado)
Arreglo
Lista de activos asignados a un WebService por cliente.
POST https://api.service24gps.com/api/v1/getWebservicesDevices
Obtener la lista de todos los activos asignados a un WebService por cliente.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService.
661
IdCliente
(Requerido) Identificador único de cliente.
67421
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getWebservicesDevices' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=661' \
-F 'IdCliente=29138'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"idasignacion": "29631",
"idactivo": "127537",
"activo": "Nothing Phone de Tom's",
"dispositivo": "2771d7ea2cf7a18b",
"placa": "SM-A50",
"webservice": "Webservice API Create Pruebas",
"idws": "151",
"estatus": "1"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Identificador único de la asignación de un activo a un WebService por cliente.
Entero
idactivo
Identificador único del activo asignado al WebService por cliente.
Entero
activo
Nombre del activo asignado al WebService por cliente.
Cadena de Texto
dispositivo
Imei del dispositivo del activo asignado al WebService por cliente.
Cadena de Texto
placa
Placa del dispositivo del activo asignado al WebService por cliente.
Cadena de Texto
webservice
Nombre del WebService.
Cadena de Texto
idws
Identificador único del repetidor del WebService.
Cadena de Texto
estatus
Estado de la asignación del dispositivo en el WebService por cliente.
Entero
Asignar WebService a un cliente
POST https://api.service24gps.com/api/v1/assignWebserviceToClient
Asignar un WebService a un cliente.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService.
661
IdCliente
(Requerido) Identificador único de cliente.
67421
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/assignWebserviceToClient' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=661' \
-F 'IdCliente=29138'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idasignacion": "4908",
"idcliente": "29138",
"idws": "151"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Estado de la asignación del cliente a el WebService.
Entero
idcliente
Identificador único del cliente.
Entero
idws
Identificador único del repetidor del WebService.
Entero
Desasignar un WebService de un cliente.
POST https://api.service24gps.com/api/v1/unassignWebserviceFromClient
Desasignar un WebService a un cliente.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService.
661
IdCliente
(Requerido) Identificador único de cliente.
67421
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/unassignWebserviceFromClient' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=661' \
-F 'IdCliente=29138'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idasignacion": "4908",
"idcliente": "29138",
"idws": "151"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Estado de la asignación del cliente a el WebService.
Entero
idcliente
Identificador único del cliente.
Entero
idws
Identificador único del repetidor del WebService.
Entero
Asignar un activo a un WebService por cliente.
POST https://api.service24gps.com/api/v1/assignVehicleToClientWebservice
Asignar un activo a un WebService por cliente.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService.
661
IdCliente
(Requerido) Identificador único de cliente.
67421
IdActivo
(Requerido) Identificador único de activo.
1234
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/assignVehicleToClientWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=661' \
-F 'IdCliente=29138' \
-F 'IdActivo=127537'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idasignacion": "29631",
"idcliente": "29138",
"idws": "151",
"idactivo": "127537"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Estado de la asignación del activo a el WebService del cliente.
Entero
idcliente
Identificador único del cliente.
Entero
idws
Identificador único del repetidor del WebService.
Entero
idactivo
Identificador único del activo asignado al WebService.
Entero
Desasignar un activo a un WebService por cliente.
POST https://api.service24gps.com/api/v1/unassignVehicleFromClientWebservice
Desasignar un activo a un WebService por cliente.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idws
(Requerido) Identificador único del WebService.
661
IdCliente
(Requerido) Identificador único de cliente.
67421
IdActivo
(Requerido) Identificador único de activo.
12345
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/unassignVehicleFromClientWebservice' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'idws=661' \
-F 'IdCliente=29138' \
-F 'IdActivo=127537'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"idasignacion": "29631",
"idcliente": "29138",
"idws": "151",
"idactivo": "127537"
}
}
Ver campos de respuesta:
Campo
Descripción
Formato
idasignacion
Estado de la asignación del activo a el WebService del cliente.
Entero
idcliente
Identificador único del cliente.
Entero
idws
Identificador único del repetidor del WebService.
Entero
idactivo
Identificador único del activo asignado al WebService.
Entero
Gestión de Mantenimientos
Administrar Mantenimientos a nivel distribuidor.
Lista de mantenimientos preventivos
POST https://api.service24gps.com/api/v1/getMaintenanceRecords
Obtener registros de mantenimientos preventivos.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
fecha
(Opcional) Fecha de inicio en formato DD-MM-AAAA.
10-10-2024
activo
(Opcional) Nombre del activo en plataforma.
Ruta 1
estado
(Opcional) Estado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado.
Pendiente
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getMaintenanceRecords' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'fecha=01-09-2021' \
-F 'estado=Alertado' \
-F 'activo=Carro Demo'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"nombre_mantenimiento": "Cambio de filtro de gasolina",
"nombre_activo": "Carro Demo",
"estado": "Alertado",
"concepto": "Servicio en General",
"descripcion": "",
"tiempo_configuracion": "60",
"tiempo_transcurrido_activo": "758",
"kilometros_recorridos_configuracion": "400",
"kilometros_recorridos_activo": "2304.653987698",
"hrs_uso_motor_mantenimiento": "300",
"hrs_uso_motor_activo": "0",
"fecha_sig_revision": "2021-10-01",
"fecha": "2021-09-01"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
nombre_mantenimiento
Nombre del mantenimiento configurado.
Cadena de Texto
nombre_activo
Nombre del activo en plataforma.
Cadena de Texto
estado
Estado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado.
Cadena de Texto
concepto
Concepto del mantenimiento.
Cadena de Texto
descripcion
Descripción del mantenimiento.
Cadena de Texto
tiempo_configuracion
Tiempo en horas configuradas del mantenimiento.
Cadena de Texto
tiempo_transcurrido_activo
Tiempo en horas transcurrido del activo.
Cadena de Texto
kilometros_recorridos_configuracion
Kilómetros recorridos configuradas del mantenimiento.
Cadena de Texto
kilometros_recorridos_activo
Kilómetros recorridos del activo.
Cadena de Texto
hrs_uso_motor_configuracion
Horas uso del motor configuradas del mantenimiento.
Cadena de Texto
hrs_uso_motor_activo
Horas uso del motor del activo.
Cadena de Texto
fecha_sig_revision
Fecha estimada siguiente revision.
Cadena de Texto
fecha
Fecha de inicio mantenimiento del activo.
Cadedna de Texto
Consultar Datos de último mantenimiento
POST https://api.service24gps.com/api/v1/getLastMaintenanceRecords
Obtener el último mantenimiento realizado por el activo.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
estado_mantenimiento
(Opcional) E stado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado.
10-10-2024
activo
(Opcional) Nombre del activo en plataforma.
Ruta 1
nombre_mantenimiento
(Opcional) Nombre del mantenimiento.
Respuesto de Llantas
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getLastMaintenanceRecords' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'estado_mantenimiento=Alertado' \
-F 'activo=Carro Demo'
-F 'nombre_mantenimiento=Respuesto de Llantas'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"nombre_mantenimiento": "Vencimiento de revisiones técnicas",
"nombre_activo": "DEMO1",
"estado": "Pendiente",
"concepto": "Verificacion tecnica vehicular",
"descripcion": "Fecha de vencimiento de revisiones técnicas",
"tiempo_configuracion": "0",
"tiempo_transcurrido_activo": "0",
"kilometros_recorridos_configuracion": "0",
"kilometros_recorridos_activo": "0",
"hrs_uso_motor_configuracion": "0",
"hrs_uso_motor_activo": "0",
"fecha_ultimo_mantenimiento": "2024-12-24",
"numero_orden": "",
"total_orden": "",
"detalle_subtotal": "0",
"detalle_monto": "0",
"monto_factura": ""
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
nombre_mantenimiento
Nombre del mantenimiento configurado.
Cadena de Texto
activo
Nombre del activo que efectuó el mantenimiento.
Cadena de Texto
estado
Estado del mantenimiento. Valores posibles: Pendiente, Alertado, Realizado.
Cadena de Texto
concepto
Concepto del mantenimiento.
Cadena de Texto
tiempo_configuracion
Tiempo en horas configuradas del mantenimiento.
Cadena de Texto
tiempo_transcurrido_activo
Tiempo en horas transcurrido del activo.
Cadena de Texto
kilometros_recorridos_configuracion
Kilómetros recorridos configuradas del mantenimiento.
Cadena de Texto
kilometros_recorridos_activo
Kilómetros recorridos del activo.
Cadena de Texto
hrs_uso_motor_configuracion
Horas uso del motor configuradas del mantenimiento.
Cadena de Texto
hrs_uso_motor_activo
Horas uso del motor del activo.
Cadena de Texto
fecha_ultimo_mantenimiento
Fecha ultimo mantenimiento del activo.
Cadena de Texto
numero_orden
Número orden del mantenimiento.
Cadena de Texto
total_orden
Total orden del mantenimiento.
Cadena de Texto
detalle_subtotal
Detalle subtotal del mantenimiento
Cadena de Texto
detalle_monto
Detalle monto del mantenimiento
Cadena de Texto
monto_factura
Monto de la factura del mantenimiento.
Cadena de Texto
Lista de mantenimientos correctivos
POST https://api.service24gps.com/api/v1/getCorrectiveMaintenanceRecords
Obtener registros de mantenimientos correctivos.
Ver parámetros de solicitud:
apikey
(Requerido) Llave de autorización para uso de los Servicios Web.
25sdsd234234aa93sdsdsd37c70118e72
token
(Requerido) Token devuelto por el método getToken.
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
fecha_realizado
(Opcional) Fecha realizado en formato DD-MM-AAAA.
10-10-2024
activo
(Opcional) Nombre del activo en plataforma.
Ruta 1
nombre_mantenimiento
(Opcional) Nombre del mantenimiento.
Respuesto de Llantas
Solicitud de ejemplo:
curl -X 'POST' \
'https://api.service24gps.com/api/v1/getCorrectiveMaintenanceRecords' \
-H 'accept: application/json' \
-H 'Content-Type: multipart/form-data' \
-F 'apikey=25sdsd234234aa93sdsdsd37c70118e72' \
-F 'token=wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==' \
-F 'fecha_realizado=01-09-2021' \
-F 'activo=Carro Demo'
-F 'nombre_mantenimiento=Respuesto de Llantas'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"nombre_mantenimiento": "Respuesto de Llantas",
"taller": "Taller Mexico",
"id_proveedor": "1264",
"numero_factura": "Factura2323",
"tipo_repuesto": "Llanta",
"valor_factura": "4500",
"cantidad": "4",
"patente": "patente",
"activo": "Activo",
"proveedor": "Proveedor Pruebas",
"fecha_realizado": "2021-08-20"
}
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
nombre_mantenimiento
Identificador único del repetidor del WebService.
Cadena de Texto
taller
Taller donde se realizó el mantenimiento.
Cadena de Texto
numero_factura
Número de la factura del mantenimiento.
Cadena de Texto
tipo_repuesto
Tipo de repuesto utilizado en el mantenimiento.
Cadena de Texto
valor_factura
Valor de de la factura del mantenimiento.
Cadena de Texto
cantidad
Cantidad de repuesto utilizado en el mantenimiento.
Cadena de Texto
patente
Patente del activo que efectuó el mantenimiento.
Cadena de Texto
activo
Nombre del activo que efectuó el mantenimiento.
Cadena de Texto
proveedor
Nombre del proveedor que efectuó el mantenimiento.
Cadena de Texto
fecha_realizado
Fecha en que se realizó el mantenimiento.
Cadena de Texto
Listado de Web Services - getAllWebServices
POST https://api.service24gps.com/api/v1/getAllWebServices
Este método devuelve el listado de todos los Web Services disponibles en nuestra plataforma
Parámetros de solicitud:
Parámetros
Descripción
Longitud
Ejemplo
token
Token devuelto por el método getToken .
500
wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
apikey
Llave de autorización para uso de los Servicios Web.
50
25sdsd234234aa93sdsdsd37c70118e72
lang
Idioma en que se mostrará la información
2
'en', 'es', 'pt'
El parámetro lang no es obligatorio.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getAllWebServices' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'lang="es"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
"id": "1",
"webservice": "Assistcargo",
"descripcion": "Reenvío de datos de identificación del activo e información telemática a la plataforma Assistcargo.",
"categorias": "Logística, Rastreamento de Veículos",
"tipo_envio": "XML",
"tipo_transmision": "SOAP",
"link": "https://www.example.com/example/example/",
"logo": "https://newexample1.example.com/logo_example.jpg",
"logo_detail": "https://example.nyc3.example.com/example_Assistcargo.jpg",
"fecha_alta": "2016-05-11",
"uso": "",
"idpais": "X",
"pais": "Argentina"
]
}
Ver campos de respuesta:
Campo
Descripción
Formato
id
Identificador único del web service.
Entero
webservice
Nombre asignado al web service.
Cadena de Texto
descripcion
Descripcion de función del web service.
Cadena de Texto
categorias
Categoría del web service
Cadena de Texto
tipo_envio
Formato de envío de datos
Cadena de Texto
tipo_transmision
Transmisión utilizada por el web service
Cadena de Texto
link
Url asignado para el web service
Cadena de Texto
logo
Nombre del logo
Cadena de Texto
logo_detail
Url del logo asignado al webservice
Cadena de Texto
fecha_alta
Fecha de integración en plataforma
Cadena de Texto
uso
Cadena de Texto
idpais
Identificador único del país en el que está habilitado
Entero
pais
País en el que el web service está habilitado
Cadena de Texto
Historial de actualización del Web Service
En la siguiente tabla se describen las actualizaciones importantes del Web Service.
Método
Cambio
Descripción
Fecha
getAlerts
Actualización
Obtiene las alertas asociadas a un grupo de Activos o a un equipo GPS, dentro de un rango de fechas determinado.
12 de Agosto de 2026
getAssetGroups
Nuevo endpoint
Obtiene el listado de los grupos de activos.
08 de Julio de 2026
getClientByIdentifier
Nuevo endpoint
Lista la información de un cliente registrado en OnDelivery mediante su identificador.
15 de octubre de 2025
updateAsset
Actualización
Se agregaron validaciones en los campos obligatorios del método.
03 de junio de 2025
deleteDevice
Nuevo endpoint
Método para la eliminación de un equipo GPS
18 de septiembre de 2024
deleteAsset
Nuevo endpoint
Método para la eliminación de un Activo
18 de septiembre de 2024
getDevices
Actualización de documentación.
Se actualizó la documentación en el apartado de la respuesta de la solicitud, se agregaron los campos idcliente_propietario y cliente_propietario .
18 de septiembre de 2024
getClientAssetsInfo
Actualización de documentación.
Se actualizó la documentación en el apartado de la respuesta de la solicitud. Se agregó en la respuesta el campo de placa .
19 de junio de 2024
getTicketAnswer
Nuevo endpoint
Obtiene el detalle del ticket.
13 de mayo de 2024
getScheduledReportResult
Nuevo endpoint
Obtiene la información de la última ejecución del reporte programado en la plataforma OnReports. (Versión beta)
25 de marzo de 2024
getProgrammedReports
Nuevo endpoint
Obtiene el listado de los reportes programados de la plataforma OnReports
25 de marzo de 2024
gettickets
Actualización de documentación.
Actualización general de la documentación del método.
08 de marzo de 2024
historyGetEvents
Actualización de documentación.
Se actualizó la documentación en el apartado de respuesta de la solicitud.
04 de enero de 2024
getVehiclesBrands
Nuevo endpoint
Catálogo de marcas de activos.
10 de octubre de 2023
getVehiclesType
Nuevo endpoint
Catálogo de tipos de activos.
10 de octubre de 2023
createAsset
Campos nuevos
Se agregaron los campos tipo_vehiculo y marca en la solicitud.
10 de octubre de 2023
createDevice
Campos nuevos
Se agregaron los campos idzona_horaria e imei en la solicitud.
10 de octubre de 2023
getTimeZone
Nuevo endpoint
Catálogo de zonas horarias.
10 de octubre de 2023
setUser
Campos nuevos
Se agregaron los campos idzona_horaria, parar_motor, enviar_sms y cargar_geocercas_al_inicio en la solicitud.
10 de octubre de 2023
setClient
Campo nuevo
idzona_horaria
Se agrega el campo id zona horaria en la solicitud. El campo contiene el id para crear o actualizar la zona horaria.
10 de octubre de 2023
InsertPositioData
Actualización de documentación.
Se actualizó la documentación en el apartado de parámetros de solicitud y en la tabla de parámetros reportes.
10 de mayo de 2023
historyGet
Actualización de documentación.
Se actualizó la documentación en el apartado de respuesta de ejemplo y en la tabla de campos de respuesta.
12 de abril de 2023
getData
Campo nuevo UrlLocation
Se agrega un nuevo campo en la respuesta de solicitud del método. El campo contiene la URL de localización del último reporte.
24 de febrero de 2023