Distribuidor
Métodos / endpoints exclusivos para cuando el apikey es a nivel distribuidor.
- Obtener la lista de todos los clientes - getClients
- Crea o actualiza un cliente - setClient
- Suspender cliente - allowClient
- Obtener usuarios de algún cliente - getUsers
- Crea o actualiza un usuario - setUser
- Crear activo - createAsset
- Actualizar un activo - updateAsset
- Crear relación activo con cliente - addAssetByClient
- Obtener el listado de las compañías celulares - getCompaniasCelular
- Obtener las tarjetas sim (chips telefónicos) - getSims
- Crea o actualiza una tarjeta sim (chip telefónico) - setSim
- Insertar datos de dispositivo - insertPositionData
- Obtener equipos - getDevices
- Crear un equipo - createDevice
- Editar un equipo - updateDevice
- Obtener listado de marcas - getBrands
- Obtener listado de modelos - getModels
- Obtener listado de tipos de dispositivo - getTypesDevices
- Obtener listado del detalle de un modelo de equipo - getDeviceDetail
- Obtener los activos de un cliente - getClientAssetsInfo
- Listar tipos tributarios - getTypesTax
- Crear cliente, usuarios, activos, equipos y tarjetas sim - createClientAndElements
- Obtiene el listado de zonas horarias - getTimeZone
- Obtiene el listado tipos de activos - getVehiclesType
- Obtiene el listado marcas de activos - getVehiclesBrands
Obtener la lista de todos los clientes - getClients
POST https://api.service24gps.com/api/v1/api/v1/getClients
Obtiene el listado de todos los clientes del distribuidor.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getClients' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "10",
"nombre": "cliente 1",
"es_suspendido": "0",
"razon_social": "cliente sa de cv",
"cuit_rfc": "cliente01",
"ciudad": "Puebla",
"domicilio": "Avenida principal",
"telefonos": "1343243241",
"contactos": "Test1 2245789645",
"email": "cliente01@gmail.com",
"last_update": "2021-12-09 15:15:16",
"fecha_suspendido": "0000-00-00",
"es_activo": "1"
},
{
"id": "11",
"nombre": "cliente 2",
"es_suspendido": "1",
"razon_social": "cliente 2 sa de cv",
"cuit_rfc": "cliente02",
"ciudad": "Monterrey",
"domicilio": "Avenida central",
"telefonos": "3245643",
"contactos": "Test2 5589568989",
"email": "cliente02@gmail.com",
"last_update": "2021-12-17 10:41:25",
"fecha_suspendido": "0000-00-00",
"es_activo": "1"
},
]
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del cliente |
Entero |
nombre |
Nombre asignado al cliente |
Texto |
es_suspendido |
Bandera o estado si está o no suspendido,. 1 = suspendido 0 = no suspendido |
Booleano |
razon_social |
Razón social del cliente |
Texto |
cuit_rfc |
RFC del cliente |
Texto |
ciudad |
Ciudad de dónde es el cliente |
Texto |
domicilio |
Domicilio o dirección de dónde es el cliente |
Texto |
telefonos |
Teléfono(s) del cliente |
Texto |
contactos
|
Contacto(s) del cliente |
Texto |
Correo electrónico del cliente |
Texto | |
last_update |
Fecha Hora de la última actualización del cliente |
FechaHora |
fecha_suspendido |
Fecha de cuándo se suspendió el cliente |
Fecha |
es_activo |
Bandera o estado si está activo o no el cliente. 1 = activo 0 = no activo |
Booleano |
Crea o actualiza un cliente - setClient
POST https://api.service24gps.com/api/v1/setClient
Crea o actualiza un cliente.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e7 |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idcliente
|
(Opcional) Identificador único del cliente. Sólo cuando se va actualizar. | 11 |
nombre
|
(Requerido) Nombre que va tener el cliente. | Test nombre |
razon_social | (Requerido) Razón social del cliente. | Test Razon Social |
idzona_horaria | (Opcional) Identificador único de la zona horaria - Obtener los tipos en el método getTimeZone. |
1 |
IdTipo_informacion_tributaria |
(Opcional) Identificador del tipo de información tributaria. - Si no requiere tipo, se asigna 0 - Obtener los tipos en el método getTypesTax. |
5 |
(Requerido) Correo del cliente. | test@test.com | |
rfc | (Opcional) RFC del cliente. | RFC0123456789 |
ciudad | (Opcional) Ciudad de dónde es el cliente. | Puebla |
domicilio | (Opcional) Domicilio o dirección del cliente. | Test domicilio |
codpostal | (Opcional) Código postal de la ubicación del cliente. | 72111 |
contactos | (Opcional) Datos del contacto. | test contacto |
telefonos | (Opcional) Teléfono(s) para contactar al cliente. | 2228562144 |
descripcion | (Opcional) Alguna descripción o información del cliente. | Test Cliente Descripcion |
Solicitud de ejemplo crear un cliente:
curl --location 'https://api.service24gps.com/api/v1/setClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test nombre"' \
--form 'razon_social="Test Razon Social"' \
--form 'idzona_horaria="1"' \
--form 'IdTipo_informacion_tributaria="5"' \
--form 'email="test@test.com"' \
--form 'rfc="RFC0123456789"' \
--form 'ciudad="Puebla"' \
--form 'domicilio="Test domicilio"' \
--form 'codpostal="72111"' \
--form 'contactos="test contacto "' \
--form 'telefonos="2228562144"' \
--form 'descripcion="Test Cliente Descripcion"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Solicitud de ejemplo editar un cliente:
curl --location 'https://api.service24gps.com/api/v1/setClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcliente="11"' \
--form 'nombre="Test nombre"' \
--form 'razon_social="Test Razon Social"' \
--form 'idzona_horaria="1"' \
--form 'IdTipo_informacion_tributaria="5"' \
--form 'email="test@test.com"' \
--form 'rfc="RFC0123456789"' \
--form 'ciudad="Puebla"' \
--form 'domicilio="Test domicilio"' \
--form 'codpostal="72111"' \
--form 'contactos="test contacto "' \
--form 'telefonos="2228562144"' \
--form 'descripcion="Test Cliente Descripcion"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del cliente |
Entero |
Suspender cliente - allowClient
POST https://api.service24gps.com/api/v1/allowClient
Suspende un cliente.
Ver parámetros de solicitud:
Parámetros | Parámetros | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idclient
|
Identificador único del cliente. | 11 |
sino_suspend
|
Valor a actualizar: 1 = suspende 0 = activa |
1 |
razon_suspend | Razón, motivo o causa del porque se suspende. | motivo test |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/allowClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idclient="12"' \
--form 'sino_suspend="1"' \
--form 'razon_suspend="motivo test"'
Respuesta de ejemplo:
{
"status": 200,
"data": "OK"
}
Obtener usuarios de algún cliente - getUsers
POST https://api.service24gps.com/api/v1/getUsers
Obtiene el listado de los usuarios de un cliente en específico.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idcliente
|
Identificador único del cliente | 11 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getUsers' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idcliente=11'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "156211",
"nombre": "user01",
"usuario": "usuario primero",
"es_activo": "1",
"last_update": "2021-11-08 17:05:14",
"last_update_password": "",
"loginas": "https://plataforma.service24gps.com/loginas/cred;WE49hX5TngeG8z3kk0yZW_rljZbkHVuEBD9taqOPcD5gaIL4xm-WZ8XdSWN6Mr6_66444443333U_EGEsWd9VqvyZl6msm1MBy4VCTDUizCirgUgTQ34n24BSVV9XkEUfnenPTJuRBEknIJvg11gfdSynXkQ,,"
},
{
"id": "516311",
"nombre": "user02",
"usuario": "usuario dos",
"es_activo": "1",
"last_update": "2022-01-17 22:59:47",
"last_update_password": "",
"loginas": "https://plataforma.service24gps.com/loginas/cred;WE49hX5TngeG8z3kk0yZW_rljZbkHVuEykhXihWJj-EDJb15YcPikU0LbWRv1cl4qjOZXxY444444999128888909T_GgiTA80qFYb1MvsFKv_e7-_-VzWoTXSpqDnwTJ462DHabbD2v7o2RdstNM62wEHbxLclgfzbpLJ2LFnWHQXuXo"
}
]
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del usuario |
Entero |
nombre |
Nombre asignado al usuario |
Texto |
usuario |
Nombre del usuario, para después iniciar sesión en plataforma |
Texto |
last_update |
Fecha hora de la última actualización del usuario |
FechaHora |
last_update_password |
Fecha hora de la última actualización de la contraseña del usuario |
FechaHora |
es_activo |
Bandera o estado si está activo o no el cliente, 1 = activo, 0 = no activo |
Booleano |
loginas |
Link o url para el inicio de sesión de la plataforma |
Texto |
Crea o actualiza un usuario - setUser
POST https://api.service24gps.com/api/v1/setUser
Crea o actualiza un usuario.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo | |
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 | |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== | |
idusuario
|
(Opcional) Identificador único del usuario. Sólo cuando se va actualizar. | 1 | |
nombre
|
(Requerido) Nombre que va tener el usuario. | User 111 | |
user | (Requerido) Usuario con el que se va autenticar. | user_111 | |
password | (Requerido) Contraseña para el usuario. | 123456 | |
(Requerido) Correo electrónico del usuario. | user111@gmail.com | ||
idcliente | (Requerido) Identificador único del cliente al que va pertenecer el usuario. | 11 | |
idzona_horaria | (Opcional) Identificador único de la zona horaria. - Obtener los tipos en el método getTimeZone. |
1 | |
parar_motor | (Opcional) Activar comando de paro de motor. 1 = Si 0 = No |
0 | |
enviar_sms | (Opcional) Enviar comando y alertas por SMS. 1 = Si 0 = No |
0 | |
cargar_geocercas_al_inicio | (Opcional) Cargar geocercas al inicio de cada sesión. 1 = Si 0 = No |
1 |
Solicitud de ejemplo crear un usuario:
curl --location 'https://api.service24gps.com/api/v1/setUser' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="User 111"' \
--form 'user="user_111"' \
--form 'password="123456"' \
--form 'email="user111@gmail.com"' \
--form 'idcliente="11"' \
--form 'idzona_horaria="1"' \
--form 'parar_motor="0"' \
--form 'enviar_sms="0"' \
--form 'cargar_geocercas_al_inicio="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": 1
}
Solicitud de ejemplo editar un usuario:
curl --location 'https://api.service24gps.com/api/v1/setUser' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idusuario="1"' \
--form 'nombre="User 111"' \
--form 'user="user_111"' \
--form 'password="123456"' \
--form 'email="user111@gmail.com"' \
--form 'idcliente="11"' \
--form 'idzona_horaria="1"' \
--form 'parar_motor="0"' \
--form 'enviar_sms="0"' \
--form 'cargar_geocercas_al_inicio="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": 1
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del usuario |
Entero |
Crear activo - createAsset
POST https://api.service24gps.com/api/v1/createAsset
Crea un activo.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e7 |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
nombre
|
(Requerido) Nombre que va tener el activo. | Test nombre |
tipo_vehiculo | (Requerido) Identificador único del tipo del activo. - Obtener los tipos en el método getVehiclesType. |
1 |
marca | (Opcional) Identificador único de marca del activo. - Obtener los tipos en el método getVehiclesBrands. |
1 |
modelo | (Requerido) Modelo del activo. | Mazda |
anio |
(Opcional) Año del activo. |
2017 |
patente | (Opcional) Patente del activo. | test123 |
idcliente | (Opcional) Identificador único del cliente. | 11 |
equipo_gps | (Requerido) Equipo GPS del activo. | 123456789 |
color | (Opcional) Color del activo. | Negro |
numero_serie | (Opcional) Número de serie del activo. | 55500056544 |
numero_motor | (Opcional) Número de motor del activo. | M211 |
numero_economico | (Opcional) Número económico del activo. | 0227 |
rendimiento_combustible | (Opcional) Rendimiento del combustible. | 0 |
Solicitud de ejemplo crear un activo:
curl --location --request POST 'https://api.service24gps.com/api/v1/createAsset' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Test nombre"' \
--form 'tipo_vehiculo="1"' \
--form 'marca="1"' \
--form 'modelo="Mazda"' \
--form 'anio="2017"' \
--form 'patente="test123"' \
--form 'idcliente="11"' \
--form 'equipo_gps="123456789"' \
--form 'color="Negro"' \
--form 'numero_serie="55500056544"' \
--form 'numero_motor="M211"' \
--form 'numero_economico="0227"' \
--form 'rendimiento_combustible="0"'
Respuesta de ejemplo:
{
"status": 200,
"data": "194311"
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del activo. |
Entero |
Actualizar un activo - updateAsset
POST https://api.service24gps.com/api/v1/updateAsset
Actualiza información de un activo.
Ver parámetros de solicitud:
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idvehiculo | (Requerido) Identificador único del vehículo a actualizar. | 11 |
nombre
|
(Requerido) Nombre que va ocupar el vehículo. | Activo 01 |
modelo | (Opcional) Nombre del modelo del vehículo. | Ibiza |
anio | (Opcional) Año del vehículo. | 2021 |
numero_economico | (Opcional) Número económico del vehículo. | 2 |
estado |
(Requerido) Bandera, para establecer si está activo o no el vehículo: 0 = No activo |
1 |
patente | (Opcional) Placa o patente del vehículo. | XX-AAA-10 |
patente_caja | (Opcional) Placa o patente del vehículo, si tiene caja o remolque. | XX-AAA-11 |
color | (Opcional) Color del vehículo. | Rojo |
rendimiento_combustible | (Opcional) El rendimiento del combustible del vehículo. | 1 |
numero_serie | (Opcional) El número de serie del vehículo. | SERIE-XXX-10 |
numero_motor | (Opcional) Número de motor del vehículo. | MOTOR-XXX-11 |
equipo_gps
|
(Requerido) Nombre del equipo GPS del activo. Ver en endpoint: getDevices | 123123123156 |
Nota: El equipo_gps no debe estar asignado a otro activo, debe estar disponible.
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateAsset' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'idvehiculo="11"' \
--form 'nombre="Activo 01"' \
--form 'model="Ibiza"' \
--form 'anio="2021"' \
--form 'numero_economico="11"' \
--form 'estado="1"' \
--form 'patente="XX-AAA-10"' \
--form 'patente_caja="XX-AAA-11"' \
--form 'color="Rojo"' \
--form 'rendimiento_combustible="1"' \
--form 'numero_serie="SERIE-XXX-10"' \
--form 'numero_motor="MOTOR-XXX-11"' \
--form 'equipo_gps="123123123156"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
---|---|---|
id |
Identificador único del vehículo |
Entero |
Crear relación activo con cliente - addAssetByClient
POST https://api.service24gps.com/api/v1/addAssetByClient
Crea la relación de un activo con un cliente.
Ver parámetros de solicitud:
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idvehiculo | Identificador único del vehículo. | 110011 |
idcliente
|
Identificador único del cliente | 42106 |
cliente | Nombre del cliente | User Test |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/addAssetByClient' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'idvehiculo="110011"' \
--from 'idcliente="42106"' \
--form 'cliente="User Test"'
Respuesta de ejemplo:
{
"status": 200,
"data": ""
}
Obtener el listado de las compañías celulares - getCompaniasCelular
POST https://api.service24gps.com/api/v1/getCompaniasCelular
Obtiene el listado de todos las compañías de celular, para utilizar alguna cuando se edite o modifique una tarjeta sim.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getCompaniasCelular' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Movistar",
"2": "Telcel",
"6": "Personal",
"7": "Claro",
"8": "Entel",
"10": "NEXTEL",
"11": "Vodafone",
"12": "TIM",
"13": "TIGO",
"14": "TURKCELL",
"15": "Orange",
"16": "IUSACELL",
"17": "T-Mobile",
"18": "UNITEL",
"19": "Vodacom",
"20": "Optimus",
"21": "Digicel",
"22": "Vivo",
"23": "DIGITEL",
"24": "Elisa",
"25": "ETB",
"26": "Mas Movil",
"27": "KOLBI",
"28": "Avantel",
"29": "T-Mobile",
"30": "Emnify",
"31": "CNT Ecuador",
"32": "F2M",
"33": "bitel",
"34": "Cable Wireless Panama",
"35": "NETT2",
"36": "Bueno Cell",
"37": "AT&T",
"38": "Telefonica",
"39": "Bismark",
"40": "Movilnet",
"41": "Movilnet",
"42": "Matooma",
"43": "Things Mobile",
"44": "POST",
"45": "m2m express",
"46": "IglobalSat",
"47": "M2MDataGlobal",
"48": "WOM",
"49": "Móvil Éxito",
"50": "UffMovil",
"51": "Virgin Mobile",
"52": "UNE",
"53": "Directv",
"54": "Truphone",
"55": "Oi",
"56": "Algar",
"57": "Olivia"
}
}
Obtener las tarjetas sim (chips telefónicos) - getSims
POST https://api.service24gps.com/api/v1/getSims
Obtiene el listado de todas mis tarjetas sims o chips telefónicos.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getSims' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "1155",
"nombre": "sim 1",
"compania": "Telcel",
"numero": "2913403402",
"nip": "123456789012345",
"notas": "este es la primer sim de telcel",
"fecha_alta": "2021-01-28",
"mb_plan": "0",
"es_prepago": "0"
},
{
"id": "1156",
"nombre": "sim 2",
"compania": "Movistar",
"numero": "324234234234",
"nip": "123456789012312",
"notas": "",
"fecha_alta": "",
"mb_plan": "5",
"es_prepago": "1"
}
]
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único de la tarjeta sim |
Entero |
nombre |
Nombre asignado a la tarjeta sim |
Texto |
compania |
Nombre de la compañía de la tarjeta sim |
Texto |
numero |
Número de la tarjeta sim |
Entero |
nip |
Número personal de la tarjeta sim |
Entero |
notas |
Descripción para la tarjeta sim |
Texto |
fecha_alta |
Fecha de cuando se creó la tarjeta sim |
Fecha |
mb_plan |
Megabytes del plan (sólo si tiene) |
Entero |
es_prepago |
Bandera o estado si de prepago la tarjeta sim, 1 = prepago, 0 = no prepago |
Booleano |
Crea o actualiza una tarjeta sim (chip telefónico) - setSim
POST https://api.service24gps.com/api/v1/setSim
Crea o actualiza una tarjeta sim. * Campos requeridos.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idsim |
Identificador único de la tarjeta sim. Sólo cuando se va actualizar. |
11 |
nombre
|
Nombre que va tener la tarjeta sim * | Sim 01 |
nro_tel | Número telefónico de la tarjeta sim * | 2224567810 |
nro_nip | NIP de la tarjeta sim * | 1120 |
id_compania
|
Identificado único de la compania (Se obtiene del endpoint: getCompaniasCelular) | 2 |
es_prepago
|
Bandera, para establecer si es prepago o no. 1 = Prepago 2 = No prepago |
1 |
notas
|
Descripción o información extra de las notas | Esta es mi sim 01 |
mb_plan
|
Cantidad de megabytes en el plan | 10 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/setSim' \
--header 'Cookie: PHPSESSID=0ab8djc97ouk13tev2t9epf1l2' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'nombre="Sim 01"' \
--form 'nro_tel="2224567810"' \
--form 'nro_nip="1120"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único de la tarjeta sim |
Entero |
Insertar datos de dispositivo - insertPositionData
POST https://api.service24gps.com/api/v1/insertPositionData
Basado en el documento de protocolo de comunicación service24gps. Para ingresar información en los reportes del equipo GPS y se muestre en la plataforma, tanto en el detalle nuevo del activo como en los eventos y/o alertas.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | (Requerido) Token devuelto por el método getToken. |
SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw==
|
imei |
(Requerido) Identificador en plataforma del dispositivo |
6d7b91026765abcd |
checksum |
(Requerido) Primeros 4 caracteres del md5 de reports. |
e71a |
reports |
(Requerido) String en formato json de ubicaciones
|
[ "sig": 10, "satellites": 15, "bat": 100, "odm": 500, "bato": 50, "acc": 1, "alt": "10", } |
Nota: reports es un array de objetos, así sea un solo reporte debe estar dentro de un array.
Ver tabla de parámetros reports:
Parámetros | Descripción | Ejemplo |
---|---|---|
stamp | (Requerido) Fecha y hora en GMT 0. | "stamp": "20230510235500" |
latlng | (Requerido) Latitud y longitud. | "latlng": "4.6892583,-74.1159799" |
direction |
(Requerido) Dirección. |
"direction": 0 |
speed |
(Requerido) Velocidad del dispositivo. |
"speed": 0 |
sig |
(Opcional) Señal GSM. |
"sig": 10 |
satellites | (Requerido) Satélite. |
"satellites": 15 |
event |
(Requerido) Tipo de evento. Ejemplo: 1: Ubicación 2: Botón SigMen |
"event": 1 |
battery |
(Requerido) Batería del dispositivo. |
"battery": 40 |
bato |
(Opcional) Batería Vehículo. |
"bato": 100 |
acc |
(Opcional) Estado de ignición. 1: Encendido 0: Apagado |
"acc": 1 |
odm |
(Opcional) Odómetro. |
"odm": 500 |
alt |
(Opcional) Altitud. |
"alt": "10" |
ad |
(Opcional) Información adicional para el envió de información de sensores en formato JSON. |
"ad": {
"t1": 25.5,
"h1": 10,
"h2": 1
}
|
infoextra |
(Opcional) Información extra para el dispositivo en formato JSON. |
"infoextra": {
"qr_buffer": "0",
"qr_idProceso": "2971599",
"qr_uid": "MiLugar1"
}
|
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/insertPositionData' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw=="' \
--form 'imei="6d7b91026765abcd"' \
--form 'checksum="e71a"' \
--form 'reports="[
{
\"stamp\":\"20220119235500\",
\"latlng\":\"4.6892583,-74.1159799\",
\"direction\":0,
\"speed\":0,
\"sig\":10,
\"satellites\":15,
\"event\":501,
\"battery\":40,
\"bat\":100,
\"odm\":500,
\"bato\":50,
\"acc\":1,
\"alt\":\"10\",
\"ad\": {
\"t1\": 25.5,
\"h1\": 10,
\"h2\": 1
}
}
]"'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"checksum": "e71a",
"match_checksum": 1,
"received": 1,
"processed": 1,
"errors": []
}
}
Nota: La key "errors" es un array con todos los errores encontrados al procesar las tramas. En los errores se usa el mismo índice que en las tramas para relacionar en que reporte se originó.
Respuesta de ejemplo si el checksum no coincide:
{
"status": 200,
"data": {
"checksum": "3824",
"match_checksum": 0
}
}
Tipos de formato en infoextra
Ver formatos:
Formato | Descripción | Nombre de la propiedad | Valor de la propiedad | Ejemplo |
---|---|---|---|---|
Tipo llave valor |
Este formato solo se completa el nombre y el valor a mostrar, es un modo simple de agregar información.
Tiene la limitante que no se puede dar formato o interacción a esta información dentro de la plataforma. |
"lampara 1" | "encendido" |
"infoextra":{
"lampara 1": "encendido",
"lampara 2": "apagado",
"lampara 3": "encendido"
}
|
Tipo llave valor extendido |
Este formato tiene mas opciones, donde podremos definir las acciones sobre los elementos que vera el cliente dentro del detalle del activo.
Llave:
|
"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:
|
"text" |
"Mensaje de prueba"
|
"infoextra":{
"0":{
"text": "Mensaje de prueba",
"color": "#987456",
"bcolor": "#284650",
"href": "https://example.com",
"onclick": "function_msg(_msg_)"
},
"1":{
"text": "Mensaje a plataforma",
"color": "#458756",
}
}
|
Solicitud de ejemplo con infoextra:
curl --location --request POST 'https://api.service24gps.com/api/v1/insertPositionData' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw=="' \
--form 'imei="6d7b91026765abcd"' \
--form 'checksum="e71a"' \
--form 'reports="[
{
\"stamp\": \"20220502184600\",
\"latlng\": \"4.6892583,-74.1159799\",
\"direction\": 0,
\"speed\": 0,
\"satellites\": 15,
\"event\": 501,
\"battery\": 4.013,
\"infoextra\":{
\"lampara 1\": \"encendido\",
\"lampara 2\": \"apagado\",
\"lampara 3\": \"encendido\"
},
}
]"'
Obtener equipos - getDevices
POST https://api.service24gps.com/api/v1/getDevices
Obtiene el listado de los equipos.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getDevices' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"id": "11",
"nombre": "351234567891920",
"tipo": "GPS",
"marca": "Android",
"modelo": "Android",
"imei": "0323292803",
"nro_telefonico": "5558795106",
"estado": "0",
"notas": "",
"idsim": "0",
"fecha_alta": "2020-11-17"
},
{
"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"
}
]
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del dispositivo |
Entero |
nombre |
Nombre asignado al dispositivo, regularmente es el IMEI. |
Texto |
tipo |
Tipo de dispositivo. |
Texto |
marca |
Marca del dispositivo |
Texto |
modelo |
Modelo del dispositivo |
Texto |
imei |
Código pregrabado del dispositivo |
Texto |
numero telefónico |
Número celular del dispositivo |
Texto |
estado |
Bandera o estado si está activo o no el dispositivo, 1 = activo, 0 = no activo |
Booleano |
notas |
Nota extra o descripción del dispositivo |
Texto |
idsim |
Identificador único de la tarjeta sim (chip telefónico) |
Entero |
fecha_alta |
Fecha de la alta del dispositivo |
Fecha |
Crear un equipo - createDevice
POST https://api.service24gps.com/api/v1/createDevice
Crear un equipo.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e7 |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
tipo_equipo
|
(Opcional) Tipo de equipo. - Obtener los tipos en el método getTypesDevices. |
1 |
nombre | (Requerido) Nombre del equipo. | 000123 |
imei | (Opcional) IMEI del equipo. | 000123 |
marca |
(Requerido) Marca del equipo. |
1 |
modelo | (Requerido) Modelo del equipo. - Obtener los tipos en el método getModels. |
1 |
chip_telefonico | (Opcional) Número telefónico. | 2222112233 |
idzona_horaria | (Opcional) Identificador único de la zona horaria. - Obtener los tipos en el método getTimeZone. |
1 |
Solicitud de ejemplo crear un equipo:
curl --location 'https://api.service24gps.com/api/v1/createDevice' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e7"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'tipo_equipo="1"' \
--form 'nombre="000123"' \
--form 'imei="000123"' \
--form 'marca="1"' \
--form 'modelo="1"' \
--form 'chip_telefonico="2222112233"' \
--form 'idzona_horaria="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": "000123"
}
Nota: Cuando supere el límite permitido para crear equipos se mostrará la siguiente respuesta.
Respuesta de ejemplo:
{
"status": 200,
"data": {
"status": 30700,
"message": "This is a Free account, it has exceeded the allowed limit of created devices"
}
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
Nombre |
Nombre del equipo. |
Texto |
Editar un equipo - updateDevice
POST https://api.service24gps.com/api/v1/updateDevice
Actualiza un equipo.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
iddevice
|
Identificador único del dispositivo a actualizar | 11 |
idsim | Identificador único de la tarjeta sim (chip telefónico). Ver endpoint: getSims | 9 |
nombre
|
Nombre que va ocupar el dispositivo, puede ser el imei del equipo, según el tipo de marca. | 87198978126384923 |
tipo_equipo
|
Identificador único de los tipos disponibles. Ver en endpoint: getTypesDevices | 1 |
marca
|
Identificador único de las marcas disponibles. Ver en endpoint: getBrands | 2 |
modelo
|
Identificador único de los modelos disponibles. Ver en endpoint: getModels | 1 |
estado |
Bandera, para establecer si está activo o no el dispositivo. 1 = Activo 0 = No activo |
0 |
imei | Imei del dispositivo | 87198978126384923 |
notas | Descripción o texto extra para el dispositivo | Este es un dispositivo nuevo, de la marca Suntech |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/updateDevice' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--from 'iddevice="11"' \
--from 'idsim="9"' \
--form 'nombre="87198978126384923"' \
--form 'tipo_equipo="1"' \
--form 'marca="1"' \
--form 'modelo="2"' \
--form 'estado="1"' \
--form 'imei="87198978126384923"' \
--form 'notas="Este es un dispositivo nuevo, de la marca Suntech"'
Respuesta de ejemplo:
{
"status": 200,
"data": 11
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del dispositivo |
Entero |
Obtener listado de marcas - getBrands
POST https://api.service24gps.com/api/v1/getBrands
Obtiene el listado de las marcas de los equipos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getBrands' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"133": "Zero one technology",
"299": "Zenda",
"150": "Yulongda technology limited",
"136": "Yuangeng",
"351": "Xmetra",
"239": "Xirgo",
"190": "Xintong technology co.",
"18": "Xexun",
"84": "Xact tecnology",
"127": "Wonde Proud Technology",
"151": "Wmcs",
"167": "Wireless links",
"350": "WanWayTech",
"314": "Vjoycar",
"290": "Vivotek",
"129": "Vic-zone"
}
}
Obtener listado de modelos - getModels
POST https://api.service24gps.com/api/v1/getModels
Obtiene el listado de los modelos de equipos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getModels' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"199": "G91S",
"200": "Sniper G797",
"201": "LELL-510",
"202": "Lell-520",
"203": "Lell-530",
"204": "STEPP II",
"205": "RS-1102",
"206": "RS-906",
"207": "RS-909",
"209": "PlugTrack",
"210": "UTP Navigator",
"211": "FORT-300",
"212": "Fort-111",
"213": "TK-106",
"214": "Bitrek",
"215": "Bitrek BI 310",
"216": "Back2you",
"217": "GPS Marker",
"218": "Progress 01",
"220": "Syrus",
"221": "Netvisor 11",
"222": "Evolution",
"223": "CR200",
"224": "Cello-F",
"225": "CelloTrack",
"226": "Compact CAN",
"943": "GV300W",
"227": "Compact Security",
"228": "Cello Can-IQ",
"229": "SmartOne",
"230": "SmartOne LP",
"231": "SmartOneB",
"232": "Gelix-2",
"233": "Gelix-3",
"234": "MasterKit BM8009"
}
}
Obtener listado de tipos de dispositivo - getTypesDevices
POST https://api.service24gps.com/api/v1/getTypesDevices
Obtiene el listado de tipos de dispositivos disponibles en la plataforma.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getTypesDevices' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "GPS",
"2": "Alarma",
"3": "IoT",
"4": "DVR Fijo",
"5": "DVR Movil",
"7": "Tag Multisensor / Tag Sensor",
"8": "Reloj",
"10": "App Tracker Compartida",
"11": "App Tracker"
}
}
Obtener listado del detalle de un modelo de equipo - getDeviceDetail
POST https://api.service24gps.com/api/v1/getDeviceDetail
Obtiene el listado de la información detallada del modelo de un equipo.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idmodelo | Identificador único del modelo del equipo a consultar. Los modelos disponibles en plataforma se obtienen en el método getModels. |
1 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getDeviceDetail' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="' \
--form 'idmodelo="1"'
Respuesta de ejemplo:
{
"status": 200,
"data": [
{
"id": "1",
"tipo_dispositivo": "Rastreador de Vehículos",
"protocolo": "AMBOS",
"entradas_salidas": "3/2",
"bateria": "Sí - Batería Interna",
"fabricante": "Skypatrol",
"fabricante_url": "http://www.skypatrol.com/",
"modelo": "TT8750",
"imagen": "http%3A%2F%2Fadmin.redgps.com%2FFiles%2FMODELO%2F1%2FMiniMt-TT8750K.png",
"caracteristicas": "<p>• 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.</p>",
"descripcion": "<p>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.</p>",
"desc_corta": "<p>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.</p>"
}
]
}
Obtener los activos de un cliente - getClientAssetsInfo
POST https://api.service24gps.com/api/v1/getClientAssetsInfo
Obtiene el listado de los activos asignados a un cliente.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
idCliente | Identificador único del cliente. | 11 |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getClients' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'idCliente="11"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data":[
{
"imei": "86755328129212",
"dispositivo": "1743245914",
"sim": "331384054561792",
"nro_telefonico": "331384054561792",
"activo": "I8W-124",
"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",
"fecha_de_alta_sim": "2021-09-07",
"fecha_de_alta_imei": "2021-09-03",
"fecha_de_alta_activo": "2021-05-11",
"marca": "Suntech",
"modelo": "ST300A",
"idvehiculo": "7537"
},
]
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
imei |
Imei del dispositivo |
Texto |
dispositivo | Nombre del dispositivo | Texto |
sim |
Nombre del chip telefónico o sim |
Texto |
nro_telefonico |
Número del chip telefónico o sim |
Texto |
activo |
Nombre del activo o vehículo |
Texto |
fecha_de_alta_sim |
Fecha de cuando se creó la sim en el sistema |
Texto |
fecha_de_alta_imei |
Fecha de cuando se creó el dispositivo |
Texto |
fecha_de_alta_activo |
Fecha de cuando se creó el activo/vehículo |
Texto |
marca |
Nombre de la marca del dispositivo |
Texto |
modelo |
Nombre del modelo del dispositivo |
Texto |
idvehiculo |
Identificador único del vehículo |
Texto |
Listar tipos tributarios - getTypesTax
POST https://api.service24gps.com/api/v1/api/v1/getTypesTax
Obtiene el listado de los tipos de información tributaria.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
apikey | Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location --request POST 'https://api.service24gps.com/api/v1/getTypesTax' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "RFC",
"2": "CUIT",
"3": "NIT",
"4": "CPF",
"5": "RIF",
"6": "RUT",
"7": "RNC",
"8": "NIF",
"9": "SSN",
"10": "TIN",
"11": "P:IVA",
"12": "RUC",
"13": "RTU",
"14": "RTN",
"15": "CC",
"16": "CNPJ"
}
}
Ver campos de respuesta:
Campo |
Descripción |
Formato |
id |
Identificador único del tipo tributario. |
Entero |
nombre |
Nombre del tipo tributario. |
Texto |
Crear cliente, usuarios, activos, equipos y tarjetas sim - createClientAndElements
POST https://api.service24gps.com/api/v1/createclientandelements
Este método permite crear cliente, usuarios, activos, equipos y tarjetas sim.
Ver parámetros de solicitud:
Parámetros | Descripción | Ejemplo |
---|---|---|
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 |
token | (Requerido) Token devuelto por el método getToken. |
SJXC7PtRJwHcSY8O8DYjpH+c7mMBd0uXmRkw+8DE9TS09wi0Mzw==
|
client |
(Requerido) String en formato json de datos del cliente a crear |
{ |
users |
(Requerido) String en formato json de datos para crear usuarios.. |
[ |
assets |
(Requerido) String en formato json de datos para crear equipos, activos y sims
|
[ { |
Nota: users y assets son un array de objetos, así sea un solo elemento debe estar dentro de un array.
Ver tabla de parámetros client:
Parámetros | Descripción | Ejemplo |
---|---|---|
city | (Requerido) Ciudad. |
"city": "ciudad" |
country_id | (Requerido) Id pais. | "country_id": "2" |
time_zone_id | (Requerido) Id zona horaria. | "time_zone_id":"16" |
state_id | (Opcional) Estado. | "state_id":"21", |
postal_code | (Opcional) Código postal. | "postal_code": 72000 |
phone | (Opcional) Teléfono. |
"phone":"1234567890" |
(Opcional) Correo electrónico. |
"email":"correo@host.com" |
|
name | (Requerido) Nombre. |
"name":"nombre" |
register_number | (Opcional) RFC. |
"register_number":"numero registro" |
business_name | (Opcional) Razón social. |
"business_name":"nombre" |
full_addres | (Opcional) Domicilio. |
"full_address":"direccion" |
custom_fields | (Opcional) Campos personalizados. |
"custom_field":[
{ "name":"nombre campo uno", "value":"valor uno" }, {
"name":"nombre campo dos", "value":"valor dos" } ] |
Ver tabla de parámetros users:
Parámetros | Descripción | Ejemplo |
---|---|---|
name | (Opcional) Nombre del usuario. | "name": "nombre usuario" |
username | (Requerido) Usuario. | "username": "usuario" |
password | (Opcional) Contraseña. | "password": "contraseña" |
(Requerido) Correo. | "email": "correo@host.com" | |
assets | (Opcional) activos. | "assets": [ "placa" ] |
profile_id | (Opcional) Grupo sistema. |
"profile_id": 1 |
send_email_welcome | (Opcional) Enviar correo de bienvenida. |
"send_email_welcome": 0 |
Ver tabla de parámetros assets:
Parámetros | Descripción | Ejemplo |
---|---|---|
asset | (Requerido) String en formato json de vehículo |
"name": "nombre usuario" { |
device | (Requerido) String en formato json de Equipo. |
{ |
sim | (Requerido) String en formato json de chip. |
{ |
IdSensors_template | (Opcional) Plantilla. | "IdSensors_template": 1415 |
Ver tabla de parámetros asset:
Parámetros | Descripción | Ejemplo |
---|---|---|
name | (Requerido) Nombre. |
"name": "activo12055", |
plate | (Requerido) Placa. | "plate": "placa" |
asset_type_id | (Requerido) Id tipo. | "asset_type_id": "1" |
(Opcional) Id Marca. | "asset_brand_id": "5" | |
model | (Opcional) Modelo. | "model": "2022" |
year | (Opcional) Año. | "year": "2022", |
assets | (Opcional) Campos personalizados. | "custom_field": [ { "name":"nombre campo uno", "value":"valor uno asset" }, { "name":"nombre campo dos", "value":"valor uno asset" }] |
Ver tabla de parámetros device:
Parámetros | Descripción | Ejemplo |
---|---|---|
device_type_id | (Requerido) Id tipo dispositivo. | "device_type_id": "1" |
name | (Requerido) Nombre. | "name": "equipo" |
imei_uid | (Opcional) Imei. | "imei_uid": "202220222022202212055" |
brand_id | (Requerido) Id marca. | "brand_id": "1" |
model_id | (Requerido) Id modelo. | "model_id": "1" |
time_zone_id | (Opcional) Id zona horaria. |
"time_zone_id": "16" |
unlink_vehicle | (Opcional) Fecha. |
"unlink_vehicle": "2023-01-01" |
Ver tabla de parámetros sim:
Parámetros | Descripción | Ejemplo |
---|---|---|
name | (Requerido) Nombre. | "name": "sim12055" |
company | (Opcional) Id compania. | "company_id": "1" |
phone_number | (Requerido) Númeor de telefono. | "phone_number": "1234567890012055" |
nip_number | (Opcional) nip. | "nip_number": "123456" |
Solicitud de ejemplo:
curl --location --request POST 'http://api.service24gps.com/api/v1/createclientandelements' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: PHPSESSID=bduahaoj4mpc5h67p39fn0ahh6' \
--data-urlencode 'token=SJx5eXC7PtSP98YutHgP/wc990+6mK+PFfw2RVblNgQx0PyoR1v/sg==' \
--data-urlencode 'client={
"city": "puebla",
"country_id": "2",
"time_zone_id": "16",
"state_id": "21",
"postal_code": "72810",
"phone": "12345678",
"email": "caguilar@redgps.com",
"name": "apiprod1201",
"register_number": "clienteapi29c29",
"business_name": "cliente api",
"full_address": "Primer retorno de Osa Menor número 2, oficina 301, San Andrés Cholula, Puebla, México.",
"custom_field": [{"name":"Campo Personalizado 1","value":"Testing 1"},{"name":"Campo Personalizado 2","value":"Testing 2"}]
}' \
--data-urlencode 'users=[
{
"name": "nombre usuario",
"username": "usuario",
"password": "contraseña",
"email": "correo@host.com",
"assets": [
"placa"
],
"profile_id": 1,
"send_email_welcome": 1
},
{
"name": "nombre usuario",
"username": "usuario",
"password": "contraseña",
"email": "correo@host.com",
"assets": [
"placa"
],
"profile_id": 1,
"send_email_welcome": 0
}
]' \
--data-urlencode 'assets=[
{
"asset": {
"name": "activo",
"plate": "placa",
"asset_type_id": "1",
"asset_brand_id": "5",
"model": "2022",
"year": "2022",
"custom_field": [ {
"name":"nombre campo uno",
"value":"valor uno asset"
}, {
"name":"nombre campo dos",
"value":"valor uno asset"
}]
},
"device": {
"device_type_id": "1",
"name": "equipo",
"imei_uid": "2022202220222022",
"brand_id": "1",
"model_id": "1",
"time_zone_id": "16",
"unlink_vehicle": "2023-01-01"
},
"sim": {
"name": "nombre",
"company_id": "1",
"phone_number": "12345678900",
"nip_number": "123456"
},
"IdSensors_template": 1415
}
]' \
--data-urlencode 'apikey=f77c31ce81907cc5f0ecffeda60fb4f6'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"client": "Se creo el cliente apiprod1201",
"users": [
"Se creo el usuario nombre usuario",
"Se creo el usuario nombre usuario"
],
"sim": [
"Se creo la sim nombre"
],
"device": [
"Se creo el equipo 2022202220222022"
],
"assets": [
"Se creo el vehiculo activo"
]
}
}
Ver campos de respuesta:
Campo
|
Descripción |
Tipo |
client
|
Descripción cliente creado |
JSON |
users
|
Listado usuarios creados |
JSON |
sim
|
Listado tarjetas creadas |
JSON |
device
|
Listado equipos creados |
JSON |
assets
|
Listado activos creados |
JSON |
Obtiene el listado de zonas horarias - getTimeZone
POST https://api.service24gps.com/api/v1/getTimeZone
Obtiene el listado de zonas horarias (GMT).
Ver parámetros de solicitud:
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 | |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getTimeZone' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "GMT+00:00",
"2": "GMT+01:00",
"3": "GMT+02:00",
"4": "GMT+03:00",
"5": "GMT+04:00",
"6": "GMT+05:00",
"7": "GMT+06:00",
"8": "GMT+07:00",
"9": "GMT+08:00",
"10": "GMT+09:00",
"11": "GMT+10:00",
"12": "GMT-01:00",
"13": "GMT-02:00",
"14": "GMT-03:00",
"15": "GMT-04:00",
...
}
}
Obtiene el listado tipos de activos - getVehiclesType
POST https://api.service24gps.com/api/v1/getVehiclesType
Obtiene el listado tipos de vehículos.
Ver parámetros de solicitud:
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 | |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getVehiclesType' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Automovil",
"2": "PickUp",
"3": "Camion",
"4": "Camioneta",
"5": "Colectivo",
"6": "Ambulancia",
"7": "Bicicleta",
"8": "Peaton",
"9": "Moto",
"10": "Autobus",
"11": "Grua",
"12": "Normal",
"13": "Rampa",
"14": "Grande",
"15": "Ergodinamica",
...
}
}
Obtiene el listado marcas de activos - getVehiclesBrands
POST https://api.service24gps.com/api/v1/getVehiclesBrands
Obtiene el listado marcas de activos.
Ver parámetros de solicitud:
apikey | (Requerido) Llave de autorización para uso de los Servicios Web. | 25sdsd234234aa93sdsdsd37c70118e72 | |
token | (Requerido) Token devuelto por el método getToken. | wfszR/oPIQKjt5HT5NgjDnZ2SAZQ== |
Solicitud de ejemplo:
curl --location 'https://api.service24gps.com/api/v1/getVehiclesBrands' \
--form 'apikey="25sdsd234234aa93sdsdsd37c70118e72"' \
--form 'token="wfszR/oPIQKjt5HT5NgjDnZ2SAZQ=="'
Respuesta de ejemplo:
{
"status": 200,
"data": {
"1": "Ford",
"2": "Fiat",
"3": "Peugeot",
"4": "Mercedes Benz",
"5": "Volkswagen",
"6": "Renault",
"7": "Chevrolet",
"8": "Nissan",
"9": "Volvo",
"10": "Irizar",
"11": "Dodge",
"12": "Toyota",
"13": "Kenworth",
"14": "Jeep",
"15": "Hyundai",
...
}
}