# Distribuidor
Métodos / endpoints exclusivos para cuando el apikey es a nivel distribuidor.
# Obtener la lista de todos los clientes - getClients
##### POST https://api.service24gps.com/api/v1/getClients
Obtiene el listado de todos los clientes del distribuidor.
Ver parámetros de solicitud:
**Parámetros** **Descripción** **Ejemplo** apikey Llave de autorización para uso de los Servicios Web. 25sdsd234234aa93sdsdsd37c70118e72 token Token devuelto por el método getToken. wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== Ver campos de respuesta:
**Campo** **Descripción**
**Formato** id Identificador único del cliente
Entero nombre Nombre asignado al cliente
Texto es\_suspendido Bandera o estado si está o no suspendido,.
1 = suspendido
0 = no suspendido
Booleano razon\_social Razón social del cliente
Texto cuit\_rfc RFC del cliente
Texto ciudad Ciudad de dónde es el cliente
Texto domicilio Domicilio o dirección de dónde es el cliente
Texto telefonos Teléfono(s) del cliente
Texto Contacto(s) del cliente
Texto email Correo electrónico del cliente
Texto last\_update Fecha Hora de la última actualización del cliente
FechaHora fecha\_suspendido Fecha de cuándo se suspendió el cliente
Fecha es\_activo Bandera o estado si está activo o no el cliente.
1 = activo
0 = no activo
Booleano 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== **(Opcional)** Identificador único del cliente. **Sólo cuando se va actualizar.** 11 **(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 Ver campos de respuesta:
**Campo** **Descripción**
**Formato** id Identificador único del cliente
Entero Ver parámetros de solicitud:
**Parámetros** **Parámetros** **Ejemplo** apikey Llave de autorización para uso de los Servicios Web. 25sdsd234234aa93sdsdsd37c70118e72 token Token devuelto por el método getToken. wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== Identificador único del cliente. 11 Valor a actualizar:
1 = suspende
0 = activa
1
razon\_suspend Razón, motivo o causa del porque se suspende. motivo test Ver parámetros de solicitud:
**Parámetros** **Descripción** **Ejemplo** apikey Llave de autorización para uso de los Servicios Web. 25sdsd234234aa93sdsdsd37c70118e72 token Token devuelto por el método getToken. wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== Identificador único del cliente 11 Ver campos de respuesta:
**Campo** **Descripción**
**Formato** id Identificador único del usuario
Entero nombre Nombre asignado al usuario
Texto usuario Nombre del usuario, para después iniciar sesión en plataforma
Texto last\_update Fecha hora de la última actualización del usuario
FechaHora last\_update\_password Fecha hora de la última actualización de la contraseña del usuario
FechaHora es\_activo Bandera o estado si está activo o no el cliente, 1 = activo, 0 = no activo
Booleano loginas Link o url para el inicio de sesión de la plataforma
Texto 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== **(Opcional)** Identificador único del usuario. **Sólo cuando se va actualizar.** 1 **(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 Ver campos de respuesta:
**Campo** **Descripción**
**Formato** id Identificador único del usuario
Entero 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== **(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 Ver campos de respuesta:
**Campo** **Descripción**
**Formato** id Identificador único del activo.
Entero 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 **(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 **(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 } ```Campo | **Descripción** | **Formato** |
---|---|---|
id | Identificador único del vehículo | Entero |
apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idvehiculo | **(Requerido)** Identificador único del vehículo. | 110011 |
idcliente | **(Opcional)** Identificador único del cliente | 42106 |
cliente | **(Requerido)** Nombre del cliente | User Test |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Campo** | **Descripción** | **Formato** |
id | Identificador único de la tarjeta sim | Entero |
nombre | Nombre asignado a la tarjeta sim | Texto |
compania | Nombre de la compañía de la tarjeta sim | Texto |
numero | Número de la tarjeta sim | Entero |
nip | Número personal de la tarjeta sim | Entero |
notas | Descripción para la tarjeta sim | Texto |
fecha\_alta | Fecha de cuando se creó la tarjeta sim | Fecha |
mb\_plan | Megabytes del plan (sólo si tiene) | Entero |
es\_prepago | Bandera o estado si de prepago la tarjeta sim, 1 = prepago, 0 = no prepago | Booleano |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idsim | Identificador único de la tarjeta sim. **Sólo cuando se va actualizar.** | 11 |
nombre | Nombre que va tener la tarjeta sim \* | Sim 01 |
nro\_tel | Número telefónico de la tarjeta sim \* | 2224567810 |
nro\_nip | NIP de la tarjeta sim \* | 1120 |
id_compania | Identificado único de la compania (Se obtiene del endpoint: **getCompaniasCelular**) | 2 |
es_prepago | Bandera, para establecer si es prepago o no. 1 = Prepago 2 = No prepago | 1 |
notas | Descripción o información extra de las notas | Esta es mi sim 01 |
mb_plan | Cantidad de megabytes en el plan | 10 |
**Campo** | **Descripción** | **Formato** |
id | Identificador único de la tarjeta sim | Entero |
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | **(Requerido)** Token devuelto por el método getToken. | SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw== |
imei | **(Requerido)** Identificador único / imei del dispositivo gps. | 6d7b91026765abcd |
checksum | **(Requerido)** Primeros 4 caracteres del md5 de reports. | e71a |
reports | **(Requerido)** String en formato json de ubicaciones | \[ { "stamp": "20220502184600", "latlng": "4.6892583,-74.1159799", "direction": 0, "speed": 0, "sig": 10, "satellites": 15, "event": 1, "battery": 40, "bat": 100, "odm": 500, "bato": 50, "acc": 1, "alt": "10", } \] |
Nota: **reports** es un array de objetos, así sea un solo reporte debe estar dentro de un array.
Parámetros | Descripción | Ejemplo |
---|---|---|
stamp | **(Requerido)** Fecha y hora en GMT 0. | "stamp": "20230510235500" |
latlng | **(Requerido)** Latitud y longitud. | "latlng": "4.6892583,-74.1159799" |
direction | **(Requerido)** Dirección. | "direction": 0 |
speed | **(Requerido)** Velocidad del dispositivo. | "speed": 0 |
sig | (Opcional) Señal GSM. Entre 0-10 | "sig": 10 |
satellites | **(Requerido)** Satélite. | "satellites": 15 |
event | **(Requerido)** Tipo de evento. Ejemplo: 1: Ubicación 2: Botón SigMen Obtener listado de eventos en [**getEventTypes**](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" } |
**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 infoextraFormato | Descripción | Nombre de la propiedad | Valor de la propiedad | Ejemplo |
---|---|---|---|---|
**Tipo llave valor** | Este formato solo se completa el nombre y el valor a mostrar, es un modo simple de agregar información. Tiene la limitante que no se puede dar formato o interacción a esta información dentro de la plataforma. | "lampara 1" | "encendido" | "infoextra":{ "lampara 1": "encendido", "lampara 2": "apagado", "lampara 3": "encendido" } |
**Tipo llave valor extendido** | Este formato tiene mas opciones, donde podremos definir las acciones sobre los elementos que vera el cliente dentro del detalle del activo. **Llave:** - **(Requerido)** label - **(Requerido)** value - (Opcional) unit - (Opcional) color - (Opcional) icon - (Opcional) href - (Opcional) onclick | "label" | "Litros" | "infoextra":{ "0":{ "label": "Litros", "value": "11.12", "unit": "litros", "icon": "i-lock-2", "color": "#987456", "href": "https://example.com", "onclick": "function\_litro(\_litro\_)" }, "1":{ "label": "Litros 2", "value": "114.2", "unit": "litros", "icon": "i-lock-2", "color": "#158456" } } |
**Tipo llave texto** | Este formato sirve para mostrar un mensaje de tipo texto dentro de la plataforma. **Llave:** - **(Requerido)** text - (Opcional) color - (Opcional) bgcolor - (Opcional) href - (Opcional) onclick | "text" | "Mensaje de prueba" | "infoextra":{ "0":{ "text": "Mensaje de prueba", "color": "#987456", "bcolor": "#284650", "href": "https://example.com", "onclick": "function\_msg(\_msg\_)" }, "1":{ "text": "Mensaje a plataforma", "color": "#458756", } } |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Campo** | **Descripción** | **Formato** |
id | Identificador único del dispositivo | Entero |
nombre | Nombre asignado al dispositivo, regularmente es el IMEI. | Texto |
tipo | Tipo de dispositivo. | Texto |
marca | Marca del dispositivo | Texto |
modelo | Modelo del dispositivo | Texto |
imei | Código pregrabado del dispositivo | Texto |
numero telefónico | Número celular del dispositivo | Texto |
estado | Bandera o estado si está activo o no el dispositivo, 1 = activo, 0 = no activo | Booleano |
notas | Nota extra o descripción del dispositivo | Texto |
idsim | Identificador único de la tarjeta sim (chip telefónico) | Entero |
fecha\_alta | Fecha de la alta del dispositivo | Fecha |
idcliente\_propietario | ID del cliente propietario del Activo | Entero |
cliente\_propietario | Nombre del cliente propietario del Activo | Texto |
**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 |
**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" } } ```**Campo** | **Descripción** | **Formato** |
Nombre | Nombre del equipo. | Texto |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | **(Requerido)** Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
iddevice | **(Opcional)** Identificador único del dispositivo a actualizar | 11 |
idsim | **(Opcional)** Identificador único de la tarjeta sim (chip telefónico). Ver endpoint: **getSims** | 9 |
nombre | **(Requerido)** Nombre que va ocupar el dispositivo, puede ser el imei del equipo, según el tipo de marca. | 87198978126384923 |
tipo_equipo | **(Opcional)** Identificador único de los tipos disponibles. Ver en endpoint: **getTypesDevices** | 1 |
marca | **(Opcional)** Identificador único de las marcas disponibles. Ver en endpoint: **getBrands** | 2 |
modelo | **(Opcional)** Identificador único de los modelos disponibles. Ver en endpoint: **getModels** | 1 |
estado | **(Opcional)** Bandera, para establecer si está activo o no el dispositivo. 1 = Activo 0 = No activo | 0 |
imei | **(Opcional)** Imei del dispositivo | 87198978126384923 |
notas | **(Opcional)** Descripción o texto extra para el dispositivo | Este es un dispositivo nuevo, de la marca Suntech |
**Campo** | **Descripción** | **Formato** |
id | Identificador único del dispositivo | Entero |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método [**getToken**](https://docs.redgps.com/books/webservice/page/metodo-de-autenticacion-gettoken-7ef). | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idmodelo | Identificador único del modelo del equipo a consultar. Los modelos disponibles en plataforma se obtienen en el método [**getModels**](https://docs.redgps.com/books/webservice/page/getmodel). | 1 |
• 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.
" } ] } ``` # 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.**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idCliente | Identificador único del cliente. | 11 |
**Campo** | **Descripción** | **Formato** |
imei | Imei del dispositivo | Texto |
dispositivo | Nombre del dispositivo | Texto |
sim | Nombre del chip telefónico o sim | Texto |
nro\_telefonico | Número del chip telefónico o sim | Texto |
activo | Nombre del activo o vehículo | Texto |
placa | Placa del vehículo. | Texto |
fecha\_de\_alta\_sim | Fecha de cuando se creó la sim en el sistema | Texto |
fecha\_de\_alta\_imei | Fecha de cuando se creó el dispositivo | Texto |
fecha\_de\_alta\_activo | Fecha de cuando se creó el activo/vehículo | Texto |
marca | Nombre de la marca del dispositivo | Texto |
modelo | Nombre del modelo del dispositivo | Texto |
idvehiculo | Identificador único del vehículo | Texto |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
**Campo** | **Descripción** | **Formato** |
id | Identificador único del tipo tributario. | Entero |
nombre | Nombre del tipo tributario. | Texto |
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | **(Requerido)** Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | **(Requerido)** Token devuelto por el método getToken. | SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw== |
client | **(Requerido) String en formato json de datos del cliente a crear** | { "city":"ciudad", "country\_id":"2", "time\_zone\_id":"16", "state\_id":"21", "postal\_code":"72000", "phone":"1234567890", "email":"correo@host.com", "name":"nombre", "register\_number":"numero registro", "business\_name":"nombre", "full\_address":"direccion", "custom\_field":\[ { "name":"nombre campo uno", "value":"valor uno" }, { "name":"nombre campo dos", "value":"valor dos" } \] } |
users | **(Requerido) String en formato json de** datos para crear usuarios.. | \[ { "name": "nombre usuario", "username": "usuario", "password": "contraseña", "email": "correo@host.com", "assets": \[ "placa" \], "profile\_id": 1, "send\_email\_welcome": 1 }, { "name": "nombre usuario", "username": "usuario", "password": "contraseña", "email": "correo@host.com", "assets": \[ "placa" \], "profile\_id": 1, "send\_email\_welcome": 0 } \] |
assets | **(Requerido)** String en formato json de datos para crear equipos, activos y sims | \[ { "asset": { "name": "activo", "plate": "placa", "asset\_type\_id": "1", "asset\_brand\_id": "5", "model": "2022", "year": "2022", "custom\_field": \[ { "name": "nombre campo uno", "value": "valor uno asset" }, { "name": "nombre campo dos", "value": "valor uno asset" } \] }, "device": { "device\_type\_id": "1", "name": "equipo", "imei\_uid": "2022202220222022", "brand\_id": "1", "model\_id": "1", "time\_zone\_id": "16", "unlink\_vehicle": "2023-01-01" }, "sim": { "name": "nombre", "company\_id": "1", "phone\_number": "12345678900", "nip\_number": "123456" }, "IdSensors\_template": 1415 } \] |
Nota: users y assets son un array de objetos, así sea un solo elemento debe estar dentro de un array.
Parámetros | Descripción | Ejemplo |
---|---|---|
city | **(Requerido)** Ciudad. | "city": "ciudad" |
country\_id | **(Requerido)** Id pais. | "country\_id": "2" |
time\_zone\_id | **(Requerido)** Id zona horaria. | "time\_zone\_id":"16" |
state\_id | (Opcional) Estado. | "state\_id":"21", |
postal\_code | (Opcional) Código postal. | "postal\_code": 72000 |
phone | (Opcional) Teléfono. | "phone":"1234567890" |
(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"
}
\] |
Parámetros | Descripción | Ejemplo |
---|---|---|
name | (Opcional) Nombre del usuario. | "name": "nombre usuario" |
username | **(Requerido)** Usuario. | "username": "usuario" |
password | (Opcional) Contraseña. | "password": "contraseña" |
**(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 |
Parámetros | Descripción | Ejemplo |
---|---|---|
asset | **(Requerido)** String en formato json de vehículo | "name": "nombre usuario" { "name": "activo", "plate": "placa", "asset\_type\_id": "1", "asset\_brand\_id": "5", "model": "2022", "year": "2022", "custom\_field": \[ { "name": "nombre campo uno", "value": "valor uno asset" }, { "name": "nombre campo dos", "value": "valor uno asset" } \] } |
device | **(Requerido)** String en formato json de Equipo. | { "device\_type\_id": "1", "name": "equipo", "imei\_uid": "202220222022202212055", "brand\_id": "1", "model\_id": "1", "time\_zone\_id": "16", "unlink\_vehicle": "2023-01-01" } |
sim | **(Requerido)** String en formato json de chip. | { "name": "sim12055", "company\_id": "1", "phone\_number": "1234567890012055", "nip\_number": "123456" } |
IdSensors\_template | (Opcional) Plantilla. | "IdSensors\_template": 1415 |
Parámetros | Descripción | Ejemplo |
---|---|---|
name | **(Requerido)** Nombre. | "name": "activo12055", |
plate | **(Requerido)** Placa. | "plate": "placa" |
asset\_type\_id | **(Requerido)** Id tipo. | "asset\_type\_id": "1" |
marca | (Opcional) Id Marca. | "asset\_brand\_id": "5" |
model | (Opcional) Modelo. | "model": "2022" |
year | (Opcional) Año. | "year": "2022", |
assets | (Opcional) Campos personalizados. | "custom\_field": \[ { "name":"nombre campo uno", "value":"valor uno asset" }, { "name":"nombre campo dos", "value":"valor uno asset" }\] |
Parámetros | Descripción | Ejemplo |
---|---|---|
device\_type\_id | **(Requerido)** Id tipo dispositivo. | "device\_type\_id": "1" |
name | **(Requerido)** Nombre. | "name": "equipo" |
imei\_uid | (Opcional) Imei. | "imei\_uid": "202220222022202212055" |
brand\_id | **(Requerido)** Id marca. | "brand\_id": "1" |
model\_id | **(Requerido)** Id modelo. | "model\_id": "1" |
time\_zone\_id | (Opcional) Id zona horaria. | "time\_zone\_id": "16" |
unlink\_vehicle | (Opcional) Fecha. | "unlink\_vehicle": "2023-01-01" |
Parámetros | Descripción | Ejemplo |
---|---|---|
name | **(Requerido)** Nombre. | "name": "sim12055" |
company | (Opcional) Id compania. | "company\_id": "1" |
phone\_number | **(Requerido)** Númeor de telefono. | "phone\_number": "1234567890012055" |
nip\_number | (Opcional) nip. | "nip\_number": "123456" |
**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 |
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== |
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== |
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== |
**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
asset\_id | **(Requerido)** Identificador único del Activo en el sistema. | 123456 |
**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.**Parámetros** | **Descripción** | **Ejemplo** |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
device\_id | **(Requerido)** Identificador único del Equipo GPS en el sistema. El identificador se puede obtener en el método [**getDevices.**](https://docs.redgps.com/books/webservice/page/obtener-dispositivos-getdevices) | 123456 |
**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.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== |
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== |
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" } ] } ```Campo | Descripción | Formato |
---|---|---|
id | Identificador único asignado al conductor. | Entero |
numero | Código interno para identificar al conductor. | Cadena de texto |
alias | Nombre alterno para identificar al conductor. | Cadena de texto |
nombre | Nombre del conductor. | Cadena de texto |
apellido | Apellido del conductor. | Cadena de texto |
identificador | Código de iButton o RFID asignado al conductor. | Cadena de texto |
fecha\_alta | Fecha en que se creó el conductor en el sistema. | Date (aaaa-mm-dd) |
telefono | Identificador único de la ruta en el sistema. | Cadena de texto |
cedula | Número de cédula. | Cadena de texto |
licencia | Número de licencia. | Cadena de texto |
vigencia | Fecha en que expira la licencia del conductor. | Date (aaaa-mm-dd) |
direccion | Ubicación del domicilio del conductor. | Cadena de texto |
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 |
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Campo | Descripción | Formato |
---|---|---|
id | Identificador único del vehículo. | Entero |
nombre | Nombre asignado al vehículo | Cadena de Texto |
patente | Patente del vehículo | Cadena de Texto |
idgps | identificador gps | Cadena de Texto |
gatewayip | ip del gateway | Cadena de Texto |
conductor | Nombre del conductor | Cadena de Texto |
grupo | Nombre del grupo | Cadena de Texto |
marca | Marca del vehículo | Cadena de Texto |
modelo | Modelo del vehículo | Cadena de Texto |
color | Color de vehículo | Cadena de Texto |
anio | Año del vehículo | Cadena de Texto |
numero\_serie | Numero de serie | Cadena de Texto |
num\_economico | Número económico | Cadena de Texto |
tipo\_vehiculo | Tipo de activo (Automovil, Camión, etc...) | Cadena de Texto |
icono\_vehiculo | Icono asignado al activo en la plataforma | Cadena de Texto |
ignorar\_equipo | Indica si se deben descartar las tramas del equipo | Entero |
idequipo_gps | Identificador único del equipo gps | Entero |
idtipo_vehiculo | Identificador único del tipo de activo | Entero |
idmarca_vehiculo | Identificador único de la marca del activo | Entero |
idconductor | Identificador único del conductor | Entero |
idgrupo_vehiculo | Identificador único del grupo al que pertenece el activo | Entero |
idclientepropietario | Id del cliente propietario del activo | Entero |
clientepropietario | Nombre del cliente propietario del activo | Cadena de Texto |