WebService
Especificación técnica para la integración de los Servicios Web.
Versión Documento 2.5
25 de Marzo de 2024.
Historial de actualización del webservice.
Introducción
El objetivo del presente documento es explicar brevemente la interface de integración con los dif...
Método de autenticación - getToken
POST https://api.service24gps.com/api/v1/gettoken Para obtener acceso las aplicaciones y herrami...
Obtener token con información extra - gettoken
POST https://api.service24gps.com/api/v1/gettoken Para obtener acceso las aplicaciones y herrami...
Datos del cliente - getClientData
POST https://api.service24gps.com/api/v1/getClientData Este método devuelve la información del c...
Datos de unidades - getData
POST https://api.service24gps.com/api/v1/getdata Este método devuelve un array de datos con la ú...
Obtener la información del usuario - getMyUser
POST https://api.service24gps.com/api/v1/getMyUser Obtener la información del usuario y cliente ...
Activos
Métodos relacionados a los activos
Lista de vehículos - vehicleGetAll
POST https://api.service24gps.com/api/v1/vehicleGetAll Lista los vehículos asignados al usuario ...
Lista de vehículos + infoextra - vehicleGetAllComplete
POST https://api.service24gps.com/api/v1/vehicleGetAllComplete Lista los vehículos asignados al ...
Listar los contenedores de activos - getDataContainers
POST https://api.service24gps.com/api/v1/getDataContainers Lista todos los contenedores de uno o...
Odómetro de activo(s) - getOdometer
POST https://api.service24gps.com/api/v1/getOdometer Este método permíte consultar el odómetro d...
Listar clientes que pertenecen a un activo - getClientsByVehicle
POST https://api.service24gps.com/api/v1/getClientsByVehicle Lista los clientes que están asigna...
Obtener / visualizar los tanques para PEMEX - showTanks
POST https://api.service24gps.com/api/v1/showTanks Se obtiene los reportes de las unidades de lo...
Conductores
Listar conductores - driverGetAll
POST https://api.service24gps.com/api/v1/driverGetAll Obtiene la lista de todos los conductores ...
Crear conductor - createDriver
POST https://api.service24gps.com/api/v1/createDriver Permite realizar el alta de un conductor a...
Actualizar conductor - updateDriver
POST https://api.service24gps.com/api/v1/updateDriver Permite realizar la modificación de la inf...
Eliminar conductor - deleteDriver
POST https://api.service24gps.com/api/v1/deleteDriver Este método permite eliminar un conductor ...
Listar conductores con grupo y vehículo - driverInfoGetAll
POST https://api.service24gps.com/api/v1/driverInfoGetAll Obtiene la lista de todos los conducto...
Listar catálogo de grupos de conductores - driverGetGroups
POST https://api.service24gps.com/api/v1/driverGetGroups Obtiene el catálogo de los grupos de co...
Listar conductor por licencia - getDriverByIdCard
POST https://api.service24gps.com/api/v1/getDriverByIdCard Obtiene la información del conductor ...
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/api/v1/getClients Obtiene el listado de todos los clien...
Crea o actualiza un cliente - setClient
POST https://api.service24gps.com/api/v1/setClient Crea o actualiza un cliente. Ver parámetros ...
Suspender cliente - allowClient
POST https://api.service24gps.com/api/v1/allowClient Suspende un cliente. Ver parámetros de sol...
Obtener usuarios de algún cliente - getUsers
POST https://api.service24gps.com/api/v1/getUsers Obtiene el listado de los usuarios de un clien...
Crea o actualiza un usuario - setUser
POST https://api.service24gps.com/api/v1/setUser Crea o actualiza un usuario. Ver parámetros de...
Crear activo - createAsset
POST https://api.service24gps.com/api/v1/createAsset Crea un activo. Ver parámetros de solicitu...
Actualizar un activo - updateAsset
POST https://api.service24gps.com/api/v1/updateAsset Actualiza información de un activo. Ver p...
Crear relación activo con cliente - addAssetByClient
POST https://api.service24gps.com/api/v1/addAssetByClient Crea la relación de un activo con un c...
Obtener el listado de las compañías celulares - getCompaniasCelular
POST https://api.service24gps.com/api/v1/getCompaniasCelular Obtiene el listado de todos las com...
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...
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 requ...
Insertar datos de dispositivo - insertPositionData
POST https://api.service24gps.com/api/v1/insertPositionData Basado en el documento de protocolo...
Obtener equipos - getDevices
POST https://api.service24gps.com/api/v1/getDevices Obtiene el listado de los equipos. Ver pará...
Crear un equipo - createDevice
POST https://api.service24gps.com/api/v1/createDevice Crear un equipo. Ver parámetros de solici...
Editar un equipo - updateDevice
POST https://api.service24gps.com/api/v1/updateDevice Actualiza un equipo. Ver parámetros de s...
Obtener listado de marcas - getBrands
POST https://api.service24gps.com/api/v1/getBrands Obtiene el listado de las marcas de los equip...
Obtener listado de modelos - getModels
POST https://api.service24gps.com/api/v1/getModels Obtiene el listado de los modelos de equipos ...
Obtener listado de tipos de dispositivo - getTypesDevices
POST https://api.service24gps.com/api/v1/getTypesDevices Obtiene el listado de tipos de disposit...
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 d...
Obtener los activos de un cliente - getClientAssetsInfo
POST https://api.service24gps.com/api/v1/getClientAssetsInfo Obtiene el listado de los activos a...
Listar tipos tributarios - getTypesTax
POST https://api.service24gps.com/api/v1/api/v1/getTypesTax Obtiene el listado de los tipos de i...
Crear cliente, usuarios, activos, equipos y tarjetas sim - createClientAndElements
POST https://api.service24gps.com/api/v1/createclientandelements Este método permite crear clie...
Obtiene el listado de zonas horarias - getTimeZone
POST https://api.service24gps.com/api/v1/getTimeZone Obtiene el listado de zonas horarias (GMT)....
Obtiene el listado tipos de activos - getVehiclesType
POST https://api.service24gps.com/api/v1/getVehiclesType Obtiene el listado tipos de vehículos. ...
Obtiene el listado marcas de activos - getVehiclesBrands
POST https://api.service24gps.com/api/v1/getVehiclesBrands Obtiene el listado marcas de activos....
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, clasific...
Listado de tickets - gettickets
POST https://api.service24gps.com/api/v1/gettickets Obtiene el listado total de tickets o los ti...
Crear ticket - createticket
POST https://api.service24gps.com/api/v1/createticket Este método permite crear un ticket. Ver ...
Subir imagenes para ticket - uploadimageticket
POST https://api.service24gps.com/api/v1/uploadimageticket Este método permite subir imágenes pa...
Responder ticket - createticketdetalle
POST https://api.service24gps.com/api/v1/createticketdetalle Este método permite responder un ti...
Equipos
Datos históricos de eventos del equipo - historyGetEvents
POST https://api.service24gps.com/api/v1/historyGetEvents Este método permite consultar los dato...
Datos históricos equipo - historyGet
POST https://api.service24gps.com/api/v1/historyGet Este método permite consultar los datos hist...
Obtener listado de marcas y modelos - getBrandsAndModels
POST https://api.service24gps.com/api/v1/getBrandsAndModels Obtiene el listado completo de marca...
Obtener alertas por día - getAlerts
POST https://api.service24gps.com/api/v1/getAlerts Obtiene las alertas generadas en la fecha ind...
Lista de eventos - getEventTypes
POST https://api.service24gps.com/api/v1/getEventTypes Obtiene el listado de todos los eventos d...
Lista de sensores - GetSensors
POST https://api.service24gps.com/api/v1/getSensors Obtiene el listado de todos los sensores dis...
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 po...
Crear geocerca - createGeofence
POST https://api.service24gps.com/api/v1/createGeofence Este método permite crear una geocerca d...
Actualizar geocerca - updateGeofence
POST https://api.service24gps.com/api/v1/updateGeofence Este método permite actualizar cualquier...
Eliminar geocerca - deleteGeofence
POST https://api.service24gps.com/api/v1/deleteGeofence Este método permite eliminar una geocerc...
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 p...
Crear Lugar - createPlace
POST https://api.service24gps.com/api/v1/createPlace Este método permite crear un lugar. Ver pa...
Actualizar lugar - updatePlace
POST https://api.service24gps.com/api/v1/updatePlace Este método permite actualizar cualquier va...
Eliminar lugar - deletePlace
POST https://api.service24gps.com/api/v1/deletePlace Este método permite eliminar un lugar espec...
Modulos
Reportes
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 fech...
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ám...
Insertar o encolar un mensaje - insertMessage
POST https://api.service24gps.com/api/v1/insertMessage Registra o encola un nuevo mensaje SMS. ...
Inserta o encola un mensaje por dispositivo - insertMessageDevice
POST https://api.service24gps.com/api/v1/insertMessageDevice Registra o encola un nuevo mensaje ...
Plataforma - OnApp
Comprende métodos de procesamiento para la aplicación tracker, generalmente esta particularidad s...
Método de autenticación - auth
POST https://api.service24gps.com/api/v1/auth Este método genera el token de autenticación que l...
Datos del dispositivo - getdata_device
POST https://api.service24gps.com/api/v1/getdata_device Obtiene la información del dispositivo. ...
Listar rondines - getRondinesProceso
POST https://api.service24gps.com/api/v1/getRondinesProceso Este método lista la información de ...
Listar puntos de rondín - getPuntosRondinProceso
POST https://api.service24gps.com/api/v1/getRondinesProceso Este método lista la información de ...
Obtener formularios - getForms
POST https://api.service24gps.com/api/v1/onapp/getForms Obtiene el listado de todos los formular...
Listar formularios - getformatos
POST https://api.service24gps.com/api/v1/getformatos Este método lista los formularios asignados...
Listar equipos compartidos - getSharedApps
POST https://api.service24gps.com/api/v1/getSharedApps Este método lista los equipos que son de ...
Liberar y asignar equipo compartido - switchApp
POST https://api.service24gps.com/api/v1/switchApp Este método libera y asigna los equipos que s...
Listar menú - getMenuTracker
POST https://api.service24gps.com/api/v1/getMenuTracker Este método lista el menú que se le debe...
Finalizar Sesión - logout
POST https://api.service24gps.com/api/v1/logout Finaliza la sesión del dispositivo. Ver parámet...
Plataforma - OnBus
Listar rutas programadas OnBus - getProgrammedRoutesOnBus
POST https://api.service24gps.com/api/v1/getProgrammedRoutesOnBus Obtiene el listado de todas la...
Programar ruta OnBus - programRouteOnBus
POST https://api.service24gps.com/api/v1/programRouteOnBus Programa la salida de una ruta para e...
Actualizar ruta programada OnBus - updateRouteOnBus
POST https://api.service24gps.com/api/v1/updateRouteOnBus Actualiza la información de salida de ...
Eliminar ruta programda OnBus - deleteProgrammedRouteOnBus
POST https://api.service24gps.com/api/v1/deleteProgrammedRouteOnBus Elimina una ruta programada....
Listar rutas OnBus - getRoutesOnBus
POST https://api.service24gps.com/api/v1/getRoutesOnBus Obtiene la lista de todas las rutas OnBu...
Crear ruta OnBus - createRouteOnBus
POST https://api.service24gps.com/api/v1/createRouteOnBus Permite crear la definición o serie de...
Actualizar ruta OnBus - updateRouteOnBus
POST https://api.service24gps.com/api/v1/updateRouteOnBus Permite realizar la modificación de la...
Eliminar ruta OnBus - deleteRouteOnBus
POST https://api.service24gps.com/api/v1/deleteRouteOnBus Este método permite eliminar una ruta ...
Plataforma - OnDelivery
Listar todos los productos - getAllProducts
POST https://api.service24gps.com/api/v1/ondelivery/getAllProducts Obtiene todos los productos d...
Listar clientes - getAllClient
POST https://api.service24gps.com/api/v1/ondelivery/getAllClient Obtiene todos los clientes crea...
Listar detalle del pedido - getOrderDetail
POST https://api.service24gps.com/api/v1/ondelivery/getOrderDetail Devuelve el detalle del pedid...
Listar ordenes- getOrders
POST https://api.service24gps.com/api/v1/ondelivery/getOrders Este método lista las ordenes crea...
Crear orden - createOrder
POST https://api.service24gps.com/api/v1/ondelivery/createOrder Este método permite crear una or...
Editar orden - editOrder
POST https://api.service24gps.com/api/v1/ondelivery/editOrder Este método permite editar una ord...
Eliminar orden - deleteOrder
POST https://api.service24gps.com/api/v1/ondelivery/deleteOrder Este método permite editar una o...
Listar accounts - getAccounts
POST https://api.service24gps.com/api/v1/ondelivery/getAccounts Obtiene el listado de cuentas de...
Crear Account - createAccount
POST https://api.service24gps.com/api/v1/ondelivery/createAccount Crea una cuenta para un client...
Editar Account - editAccount
POST https://api.service24gps.com/api/v1/ondelivery/editAccount Modifica el monto de una cuenta ...
Eliminar Account - deleteAccount
POST https://api.service24gps.com/api/v1/ondelivery/deleteAccount Elimina la cuenta de un client...
Listar detalle de la cuenta - getAccountDetail
POST https://api.service24gps.com/api/v1/ondelivery/getAccountDetail Obtiene el saldo de la cuen...
Listar información del dashboard - getDashboardData
POST https://api.service24gps.com/api/v1/ondelivery/getDashboardData Obtiene la información para...
Listar almacenes - getAllWareHouse
POST https://api.service24gps.com/api/v1/ondelivery/getAllWareHouse Obtiene todos los almacenes ...
Listar zonas - getAllZones
POST https://api.service24gps.com/api/v1/ondelivery/getAllZones Obtiene todas las zonas de un cl...
Listar contactos - getAllContactClient
POST https://api.service24gps.com/api/v1/ondelivery/getAllContactClient Obtiene todos los contac...
Listar información del contacto - getInfoContact
POST https://api.service24gps.com/api/v1/ondelivery/getInfoContact Obtiene la información de un ...
Listar opciones del vehículo - getOptionsVehicle
POST https://api.service24gps.com/api/v1/ondelivery/getOptionsVehicle Obtiene las opciones del v...
Listar inventarios - getInventories
POST https://api.service24gps.com/api/v1/ondelivery/getInventories Obtiene los inventarios de un...
Listar pedidos - getDelivers
POST https://api.service24gps.com/api/v1/ondelivery/getDelivers Este método lista los pedidos de...
Listar vehículos - vehicleGetAllComplete
POST https://api.service24gps.com/api/v1/ondelivery/vehicleGetAllComplete Este método devuelve e...
Listar status - getStatuses
POST https://api.service24gps.com/api/v1/ondelivery/getStatuses Este método devuelve los status ...
Obtener latitud y longitud - getPositionFromAddress
POST https://api.service24gps.com/api/v1/ondelivery/getPositionFromAddress Obtener latitud y lon...
Plataforma - OnDriving
Plataforma - OnForms
Plataforma - OnReports
Listar los reportes programados - getProgrammedReports
POST https://api.service24gps.com/api/v1/onreports/getProgrammedReports Este método devuelve el ...
Obtener la información del reporte programado - getScheduledReportResult
POST https://api.service24gps.com/api/v1/onreports/getScheduledReportResult Este método devuelve...
Plataforma - OnRouting
Crear programación de ruta - programRoute
POST https://api.service24gps.com/api/v1/programRoute Permite crear la definición o serie de pun...
Listar rutas programadas - getScheduledRoutes
POST https://api.service24gps.com/api/v1/getScheduledRoutes Obtiene todas las rutas programadas ...
Actualizar ruta programada - updateScheduledRoute
POST https://api.service24gps.com/api/v1/updateScheduledRoute Permite actualizar la programación...
Eliminar ruta programada - deleteScheduledRoute
POST https://api.service24gps.com/api/v1/deleteScheduledRoute Este método permite eliminar una r...
Crear ruta - createRoute
POST https://api.service24gps.com/api/v1/createRoute Permite crear la definición o serie de punt...
Listar rutas - getRoutes
POST https://api.service24gps.com/api/v1/getRoutes Obtiene todas las rutas activas que pertenece...
Actualizar ruta - updateRoute
POST https://api.service24gps.com/api/v1/updateRoute Permite actualizar la definición o puntos q...
Eliminar ruta - deleteRoute
POST https://api.service24gps.com/api/v1/deleteRoute Este método permite eliminar una ruta espec...
Plataforma - OnService
Listar servicios - getServiceStatus
POST https://api.service24gps.com/api/v1/onservice/getServiceStatus Obtiene todos los servicios ...
Listar servicio con formulario - getTypeService
POST https://api.service24gps.com/api/v1/onservice/getTypeService Obtiene todos los servicios co...
Agregar servicio - addTypeService
POST https://api.service24gps.com/api/v1/onservice/addTypeService Agregar un servicio. Ver pará...
Eliminar servicio - deleteTypeService
POST https://api.service24gps.com/api/v1/onservice/deleteTypeService Eliminar un servicio. Ver ...
Listar turnos - getShift
POST https://api.service24gps.com/api/v1/onservice/getShift Lista todos los turnos creados. Ver...
Listar equipos - getEquipment
POST https://api.service24gps.com/api/v1/onservice/getEquipment Lista todos los equipos. Ver pa...
Agregar equipo - addEquipment
POST https://api.service24gps.com/api/v1/onservice/addEquipment Agrega un equipo. Ver parámetro...
Eliminar equipo - deleteEquipment
POST https://api.service24gps.com/api/v1/onservice/deleteEquipment Elimina un equipo. Ver parám...
Listar clientes - getPerson
POST https://api.service24gps.com/api/v1/onservice/getPerson Lista todos los clientes. Ver pará...
Listar personal - getPersonal
POST https://api.service24gps.com/api/v1/onservice/getPersonal Lista todo el personal. Ver pará...
Obtener dirección - getAddressByLocation
POST https://api.service24gps.com/api/v1/onservice/getAddressByLocation Obtiene la dirección a t...
Listar notificaciones - getNotifications
POST https://api.service24gps.com/api/v1/onservice/getNotifications Lista las notificaciones gen...
Obtener historial chat - getHistoryChatsPersonal
POST https://api.service24gps.com/api/v1/onservice/getHistoryChatsPersonal Obtiene el historial ...
Listar personal con vehiculo - getPersonVehicle
POST https://api.service24gps.com/api/v1/onservice/getPersonVehicle Lista todo el personal que t...
Obtener equipo - getTypeEquipment
POST https://api.service24gps.com/api/v1/onservice/getTypeEquipment Obtiene el equipo por id que...
Agregar equipo por servicio - addTypeEquipment
POST https://api.service24gps.com/api/v1/onservice/addTypeEquipment Agrega el equipo al tipo ser...
Obtener dirección - getAddress
POST https://api.service24gps.com/api/v1/onservice/getAddress Obtiene la dirección especifica po...
Listar preguntas - getFAQ
POST https://api.service24gps.com/api/v1/onservice/getFAQ Lista las preguntas disponibles. Ver ...
Agregar pregunta - addQuestion
POST https://api.service24gps.com/api/v1/onservice/addQuestion Agregar una pregunta. Ver paráme...
Eliminar pregunta - deleteQuestion
POST https://api.service24gps.com/api/v1/onservice/deleteQuestion Eliminar una pregunta. Ver pa...
Listar equipo con servicio - getEquipmentService
POST https://api.service24gps.com/api/v1/onservice/getEquipmentService Lista todos los equipos q...
Listar equipo por tipo de servicio - getEquipmentToTypeService
POST https://api.service24gps.com/api/v1/onservice/getEquipmentToTypeService Lista todos los equ...
Listar servicio con dirección - getLocationService
POST https://api.service24gps.com/api/v1/onservice/getLocationService Lista todos los servicios ...
Listar personal con servicio - getPersonToService
POST https://api.service24gps.com/api/v1/onservice/getPersonToService Lista todo el personal con...
Listar vehículo por servicio - getVehicleToTypeService
POST https://api.service24gps.com/api/v1/onservice/getVehicleToTypeService Lista todos los vehíc...
Listar servicio con estatus - getTypeServiceWithStatus
POST https://api.service24gps.com/api/v1/onservice/getTypeServiceWithStatus Obtiene todos los se...
Plataformas
Administra plataformas
Crear / actualizar una plataforma - setPlatform
POST https://api.service24gps.com/api/v1/setPlatform Crea o actualiza una plataforma. NOTA: Una ...
Obtener plataformas - getPlatforms
POST https://api.service24gps.com/api/v1/getPlatforms Obtiene el listado de plataformas disponib...
Obtener plataforma - getPlatform
POST https://api.service24gps.com/api/v1/getPlatform Obtiene la plataforma especifica que se hay...
Códigos de respuesta
La respuesta de los servicios es devuelta en formato JSON e incluyen los campos status y data , ...
Historial de actualización del Web Service
En la siguiente tabla se describen las actualizaciones importantes del Web Service. Método C...