# 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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getClients' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
idIdentificador único del cliente Entero
nombreNombre asignado al cliente Texto
es\_suspendidoBandera o estado si está o no suspendido,. 1 = suspendido 0 = no suspendido Booleano
razon\_socialRazón social del cliente Texto
cuit\_rfcRFC del cliente Texto
ciudadCiudad de dónde es el cliente Texto
domicilioDomicilio o dirección de dónde es el cliente Texto
telefonosTeléfono(s) del cliente Texto
contactos
Contacto(s) del cliente Texto
emailCorreo electrónico del cliente Texto
last\_updateFecha Hora de la última actualización del cliente FechaHora
fecha\_suspendidoFecha de cuándo se suspendió el cliente Fecha
es\_activoBandera 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](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-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](https://docs.redgps.com/books/webservice/page/listar-tipos-tributarios-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: ```shell 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: ```JSON { "status": 200, "data": 11 } ``` ##### Solicitud de ejemplo editar un cliente: ```shell 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: ```JSON { "status": 200, "data": 11 } ```
Ver campos de respuesta:
**Campo****Descripción** **Formato**
idIdentificador ú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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken 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\_suspendRazón, motivo o causa del porque se suspende.motivo test
##### Solicitud de ejemplo: ```shell 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: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idcliente
Identificador único del cliente11
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getUsers' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \ --form 'idcliente=11' ``` ##### Respuesta de ejemplo: ```JSON { "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**
idIdentificador único del usuario Entero
nombreNombre asignado al usuario Texto
usuarioNombre del usuario, para después iniciar sesión en plataforma Texto
last\_updateFecha hora de la última actualización del usuario FechaHora
last\_update\_passwordFecha hora de la última actualización de la contraseña del usuario FechaHora
es\_activoBandera o estado si está activo o no el cliente, 1 = activo, 0 = no activo Booleano
loginasLink 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ámetrosDescripciónLongitudEjemplo
apikeyLlave de autorización para uso de los Servicios Web.5025sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método **[getToken](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)** o token devuelto por plataforma.500wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getMyUser' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="SJx5eXC7PtGHwHcSY8O8DVLVjXycEFKiQ/kQ9A3NcWfiy7iqrjrkVw=="' ``` ##### Respuesta de ejemplo: ```JSON { "status": 200, "data": { "iduser": "11", "user": "user_01", "nameuser": "Usuario uno", "idclient": "12", "nameclient": "Empresa SA de CV" } } ```
Ver campos de respuesta:
CampoDescripción Formato
iduserIdentificador único del usuario en plataforma.Entero
idclienteIdentificador único del cliente en plataforma.Entero
nameuserNombre 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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). 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](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-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: ```shell 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: ```JSON { "status": 200, "data": 1 } ``` ##### Solicitud de ejemplo editar un usuario: ```shell 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: ```JSON { "status": 200, "data": 1 } ```
Ver campos de respuesta:
**Campo****Descripción** **Formato**
idIdentificador ú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](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-tipo-de-vehiculos-getvehiclestype)[.](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-tipo-de-vehiculos-getvehicletype)**1
marca**(Opcional)** Identificador único de marca del activo. - Obtener los tipos en el método **[getVehiclesBrands](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-marcas-de-activos-getvehiclesbrands)**[**.**](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-marcas-de-activos-getbrandtype)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: ```shell 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: ```JSON { "status": 200, "data": "194311" } ```
Ver campos de respuesta:
**Campo****Descripción** **Formato**
idIdentificador ú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**](https://docs.redgps.com/books/webservice/page/obtener-dispositivos-getdevices)123123123156

**Nota:** El **equipo\_gps** no debe estar asignado a otro activo, debe estar disponible.

##### Solicitud de ejemplo: ```shell 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: ```JSON { "status": 200, "data": 11 } ```
Ver campos de respuesta:
Campo**Descripción** **Formato**
idIdentificador ú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 cliente42106
cliente**(Requerido)** Nombre del clienteUser Test
##### Solicitud de ejemplo: ```shell 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: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getCompaniasCelular' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getSims' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
idIdentificador único de la tarjeta sim Entero
nombreNombre asignado a la tarjeta sim Texto
companiaNombre de la compañía de la tarjeta sim Texto
numeroNúmero de la tarjeta sim Entero
nipNúmero personal de la tarjeta sim Entero
notasDescripción para la tarjeta sim Texto
fecha\_altaFecha de cuando se creó la tarjeta sim Fecha
mb\_planMegabytes del plan (sólo si tiene) Entero
es\_prepagoBandera 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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idsimIdentificador único de la tarjeta sim. **Sólo cuando se va actualizar.** 11
nombre
Nombre que va tener la tarjeta sim \*Sim 01
nro\_telNúmero telefónico de la tarjeta sim \*2224567810
nro\_nipNIP 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 notasEsta es mi sim 01
mb_plan
Cantidad de megabytes en el plan10
##### Solicitud de ejemplo: ```shell 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: ```JSON { "status": 200, "data": 11 } ```
Ver campos de respuesta:
**Campo****Descripción** **Formato**
idIdentificador ú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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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**](https://docs.redgps.com/books/webservice/page/lista-de-eventos-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: ```JSON 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: ```JSON { "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 si el checksum no coincide: ```JSON { "status": 200, "data": { "checksum": "3824", "match_checksum": 0 } } ``` ##### Tipos de formato en infoextra
Ver formatos:
FormatoDescripción Nombre de la propiedadValor de la propiedadEjemplo
**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: ```JSON 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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getDevices' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
idIdentificador único del dispositivo Entero
nombreNombre asignado al dispositivo, regularmente es el IMEI. Texto
tipoTipo de dispositivo. Texto
marcaMarca del dispositivo Texto
modeloModelo del dispositivo Texto
imeiCódigo pregrabado del dispositivo Texto
numero telefónicoNúmero celular del dispositivo Texto
estadoBandera o estado si está activo o no el dispositivo, 1 = activo, 0 = no activo Booleano
notasNota extra o descripción del dispositivo Texto
idsimIdentificador único de la tarjeta sim (chip telefónico) Entero
fecha\_altaFecha de la alta del dispositivo Fecha
idcliente\_propietarioID del cliente propietario del Activo Entero
cliente\_propietarioNombre 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](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
tipo_equipo
**(Opcional)** Tipo de equipo. - Obtener los tipos en el método **[getTypesDevices](https://docs.redgps.com/books/webservice/page/gettypesdevice).**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.](https://docs.redgps.com/books/webservice/page/getbrands)** 1
modelo**(Requerido)** Modelo del equipo. - Obtener los tipos en el método **[getModels.](https://docs.redgps.com/books/webservice/page/getmodel)**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](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-zonas-horarias-gettimezone).** 1
idpais**(Opcional)** Identificador único del país. \- Obtener los países en el método **[getCountrys](https://docs.redgps.com/books/webservice/page/obtiene-el-listado-de-paises-getcountrys)** 1
##### Solicitud de ejemplo crear un equipo: ```shell 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: ```JSON { "status": 200, "data": "000123" } ```

**Nota:** Cuando supere el límite permitido para crear equipos se mostrará la siguiente respuesta.

##### Respuesta de ejemplo: ```JSON { "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**
NombreNombre 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 actualizar11
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 dispositivo87198978126384923
notas**(Opcional)** Descripción o texto extra para el dispositivoEste es un dispositivo nuevo, de la marca Suntech
##### Solicitud de ejemplo: ```shell 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: ```JSON { "status": 200, "data": 11 } ```
Ver campos de respuesta:
**Campo****Descripción** **Formato**
idIdentificador ú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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getBrands' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef).wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getModels' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getTypesDevices' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idmodeloIdentificador único del modelo del equipo a consultar. Los modelos disponibles en plataforma se obtienen en el método [**getModels**](https://docs.redgps.com/books/webservice/page/getmodel).1
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getDeviceDetail' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \ --form 'idmodelo="1"' ``` ##### Respuesta de ejemplo: ```JSON { "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ámetrosDescripciónLongitudEjemplo
apikeyLlave de autorización para uso de los Servicios Web.5025sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método **[getToken](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef)**.500wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getClientData' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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:
CampoDescripción Formato
idIdentificador único del cliente.Entero
nombreNombre asignado al cliente.Cadena de Texto
razon\_socialRazó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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
idClienteIdentificador único del cliente.11
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getClients' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \ --form 'idCliente="11"' ``` ##### Respuesta de ejemplo: ```JSON { "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**
imeiImei del dispositivo Texto
dispositivoNombre del dispositivoTexto
simNombre del chip telefónico o sim Texto
nro\_telefonicoNúmero del chip telefónico o sim Texto
activoNombre del activo o vehículo Texto
placaPlaca del vehículo. Texto
fecha\_de\_alta\_simFecha de cuando se creó la sim en el sistema Texto
fecha\_de\_alta\_imeiFecha de cuando se creó el dispositivo Texto
fecha\_de\_alta\_activoFecha de cuando se creó el activo/vehículo Texto
marcaNombre de la marca del dispositivo Texto
modeloNombre del modelo del dispositivo Texto
idvehiculoIdentificador ú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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/getTypesTax' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
idIdentificador único del tipo tributario. Entero
nombreNombre del tipo tributario. Texto
# insertPositionData + infoextra Basado en el documento de protocolo de comunicación service24gps generic. estamos necesitando ingresar información en los reportes del equipo GPS y la misma queremos que se muestre en la plataforma tanto en el detalle nuevo del activo como en los eventos ó alertas. A continuación se muestra donde se debe mostrar esta información personalizada por el cliente. es importante agregar un título llamado “información extra” sobre las filas que se agregaran. **Nuevo detalle de eventos y alertas Nuevo detalle del activo. en columna o ventana.** ![](https://lh4.googleusercontent.com/-i07-iAogQBQws7O8KquDwqy9kC-riW7R0jz-awfW2bIkWuV8AP1X7tA-4pT7Fmdr72yfiU9zY3CaZbnQBJ77h_y-XFOBhLMePjEgUqF2orOyB65LnEEm6N82sgD0ouGqJ-8chZqZm_o) ![](https://lh3.googleusercontent.com/hRGOA82Nrz9GYg0Xf89S0m7V0Wo87HTg-gaaSimt_FXcOtYUJx8natP8dTnLBWk8656uaiKCro4WZ6h5yf37swSXelDGbBJzsNMKyz1oOtyklZ6xQP1-lQHKb0LVy6TzIKHWNQkMc70C) [![image-1643540213628.png](https://docs.redgps.com/uploads/images/gallery/2022-01/scaled-1680-/image-1643540213628.png)](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1643540213628.png) La información se enviará en los reportes utilizando la llave existente “infoextra” con el método del webservice **api/v1/onapp/insertPositionData** . Límites, el largo total de “infoextra” + “sensor” y “ad” no debe superar los 5 kb. [![image-1643540346163.png](https://docs.redgps.com/uploads/images/gallery/2022-01/scaled-1680-/image-1643540346163.png)](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1643540346163.png) [![image-1643540460047.png](https://docs.redgps.com/uploads/images/gallery/2022-01/scaled-1680-/image-1643540460047.png)](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1643540460047.png) [![image-1643540546803.png](https://docs.redgps.com/uploads/images/gallery/2022-01/scaled-1680-/image-1643540546803.png)](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1643540546803.png) [![image-1643540604270.png](https://docs.redgps.com/uploads/images/gallery/2022-01/scaled-1680-/image-1643540604270.png)](https://docs.redgps.com/uploads/images/gallery/2022-01/image-1643540604270.png) # 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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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ámetrosDescripciónEjemplo
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: ```JSON 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: ```JSON { "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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location 'https://api.service24gps.com/api/v1/getTimeZone' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location 'https://api.service24gps.com/api/v1/getVehiclesType' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location 'https://api.service24gps.com/api/v1/getVehiclesBrands' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
asset\_id**(Requerido)** Identificador único del Activo en el sistema. 123456
##### Solicitud de ejemplo: ```shell 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: ```JSON { "status": 200, "data": "" } ```

**Nota:** Si no existe el registro del Activo se mostrará un mensaje de error.

##### Respuesta de ejemplo: ```JSON { "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**
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken 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.**](https://docs.redgps.com/books/webservice/page/obtener-dispositivos-getdevices) 123456
##### Solicitud de ejemplo: ```shell 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: ```JSON { "status": 200, "data": "" } ```

**Nota:** Si no existe el registro del Equipo GPS se mostrará un mensaje de error.

##### Respuesta de ejemplo: ```JSON { "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**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell curl --location 'https://api.service24gps.com/api/v1/getCountrys' \ --form 'apikey="9e815ce8b91e40379407320cd0a13a98"' \ --form 'token="dS4cs7M/gkR8in6Y5Jd3KLO9qKBO4btc4wFTmb69JfVDslam2j+vJw=="' ``` ##### Respuesta de ejemplo: ```JSON { "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ámetrosDescripciónEjemplo
apikey**(Requerido)** Llave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
token**(Requerido)** Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef).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: ```shell curl --location --request POST 'https://api.service24gps.com/api/v1/driverGetAll' \ --form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \ --form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' ``` ##### Respuesta de ejemplo: ```JSON { "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:
CampoDescripción Formato
idIdentificador único asignado al conductor. Entero
numeroCódigo interno para identificar al conductor. Cadena de texto
aliasNombre 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)
telefonoIdentificador ú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](https://docs.redgps.com/books/webservices-de-retransmision-de-datos/page/webservice-de-reenvio-generico/es).

Ver parámetros de solicitud:
ParámetrosDescripciónEjemplo
apikeyLlave de autorización para uso de los Servicios Web.25sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método getToken.wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
##### Solicitud de ejemplo: ```shell 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: ```JSON { "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:
CampoDescripción Formato
idIdentificador único del vehículo.Entero
nombreNombre asignado al vehículoCadena de Texto
patentePatente 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ículoCadena 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ámetrosDescripciónLongitud Ejemplo
apikeyLlave de autorización para uso de los Servicios Web. 5025sdsd234234aa93sdsdsd37c70118e72
tokenToken devuelto por el método **getToken**.500wfszR/oPIQKjt5HT5NgjDnZ2SAZQ==
num\_facturaNúmero de la factura8**23435**
##### Solicitud de ejemplo: ```shell 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: ```JSON { "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 } ] } ```