Manual REST API

Bogotá Abril 2020 Código: P-ID-20 V3

AZLOGICA REST API

Descripción de REST API, cURL y JavaScript para Métodos POST y GET

Contenido

1. REST API ................................................................................................................................................................... 2

a. Métodos .............................................................................................................................................................. 2
2. cURL ........................................................................................................................................................................... 3
a. Ejemplos .............................................................................................................................................................. 3
→ POST ................................................................................................................................................................ 3
→ GET .................................................................................................................................................................. 5
3. JavaScript .............................................................................................................................................................. 33
a. cURL POST en JavaScript ............................................................................................................................. 33
b. cURL GET en JavaScript ............................................................................................................................... 34
4. Límites de Uso ..................................................................................................................................................... 35

Tabla de Control

Versión Fecha Descripción Autor

A1 Agosto 2016 Elaboración del Documento GT
A1 Agosto 2016 Revisión del Documento CC
B1 Octubre 2016 Inclusión Limites de Uso GT
1 Octubre 2016 Aprobación del Documento JM
 Requisitos de autenticación (apikey, email
A2 Enero 2017 GT
y password)
2 Enero 2017 Aprobación del Documento JM
A3 Febrero 2017 Adición métodos API JC
3 Abril 2017 Adición métodos Manuelita JC
C1 Mayo 2017 Adición métodos paradas y formas JC
1 Julio 2017 Adición métodos múltiples parámetros JC
C2 Octubre 2017 Adición métodos móviles, corrección JC
parámetros
2 Enero 2018 Adición métodos BD JC
A3 Abril 2020 Se eliminan métodos Manuelita JG
3 Abril 2020 Aprobación del Documento JM

1. REST API

REST es un web service que no tiene estado, por lo tanto es stateless, quiere decir
que entre dos llamadas cualesquiera, el servicio pierde todos sus datos, por lo tanto
no se puede llamar a un servicio REST y pasarle unos datos, por ejemplo, un usuario
y una contraseña, y esperar que los recuerde en la siguiente petición. El estado lo
mantiene el cliente y es el cliente quien debe pasar el estado en cada llamada.

El cliente puede pasarle un usuario y una contraseña, un token o cualquier otro tipo
de credenciales, pero debe pasarlas en cada llamada, lo mismo aplica para el resto
de información.

a. Métodos

REST hace uso de los métodos que ofrece el protocolo HTTP, estos métodos son:

• POST Se usa para crear un recurso en el servidor.

• GET Se usa para obtener un recurso.
 • PUT Se usa para cambiar el estado de un recurso o actualizarlo.
• DELETE Se usa para eliminar un recurso.

2. cURL

cURL es una herramienta para trabajar con URLs, y permite consultar una URL desde
la línea de comandos, también permite enviar datos de formulario a un servidor FTP.
Lo más simple que puede hacer cURL es una petición HTTP a un determinado
servidor e imprimir su respuesta en la consola.

cURL es compatible con todos los métodos de peticiones de HTTP, incluyendo POST,
GET, PUT, DELETE. cURL puede usar Flags como:

• -X Para cambiar el método de la petición.

• -d Para pasar los datos como parte del cuerpo de la petición del método POST.
• -header Para indicar al servidor el tipo de contenido que se desea de regreso,
se debe establecer la cabecera Content -Type anteponiendo -header

a. Ejemplos

→ POST

Ahora se explica cómo funciona POST para autenticarse en la página:

[Link]
Después de autenticarse exitosamente, el servidor retorna un token que
permite mantener una sesión.

Antes que nada, es indispensable que cuente con la siguiente información

para autenticarse:

• api_key Es un identificador único que permite detectar la identidad del negocio

al momento de hacer una solicitud al API.
• email Es el usuario asignado, con el cual se va a autenticar.
• password Es la contraseña asignada al usuario.

Una vez cuente con los datos anteriores puede autenticarse, el comando
aplicable es el siguiente:

curl -X POST
--header 'Content-Type: application/json'
--header 'Accept: application/json'
--header 'X-DreamFactory-Api-Key: aquí_va_el_api_key '
-d '{ "email" : "xxxx@[Link]", "password" : "XXXXXXXXXX"
}''[Link]

Se selecciona el método POST:

curl -X POST

Se aplican las cabeceras:

--header 'Content-Type: application/json'
--header 'Accept: application/json'
 --header 'X-DreamFactory-Api-Key: aquí_va_el_api_key'

Se envían las credenciales (email y password) para autenticarse en:

-d '{ "email" : "xxxx@[Link]", "password" : "XXXXXXXXXX" }'
'[Link]

Si el método POST tiene éxito, se obtiene el token, para el ejemplo que se

muestra posteriormente, se trabaja como ejemplo el siguiente token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw

→ GET

Una vez se logra la autenticación por medio de POST y manteniendo la sesión

por medio del token, se puede realizar peticiones para obtener un recurso.

Algunos métodos a los cuales puede acceder para obtener recursos son:

• alarmas_view
• estadosmoviles_empresa_view
• reportes_view

Por ejemplo, para acceder al método de reporte, debe acceder a la url:

aplicacion/_table/reporte
Cambie la palabra “aplicacion” por el nombre de aplicación a la cual se va a
conectar. Tener en cuenta que en adelante volverá a ver la palabra
“aplicacion”, no olvide cambiarla.

La manera de realizar la petición GET es:

curl -X GET
--header 'Accept: application/json'
--header 'X-DreamFactory-Api-Key: aquí_va_el_api_key'
--header 'X-DreamFactory-Session-Token:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw'
'[Link]

Se selecciona el método GET.

curl -X GET

Se aplican las cabeceras y la Url.

--header 'Accept: application/json'
--header 'X-DreamFactory-Api-Key: aquí_va_el_api_key'
--header 'X-DreamFactory-Session-Token:
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1a
jw'
'[Link]
 EVOLUCION

NOMBRE MÉTODO TIPO PARÁMETROS RESPUESTA

PARADAS paradas GET • Id, multi1 Datos de

• movil, empresa, datos paradas por
agrupación

PARADAS paradasInt • Fecha inicio Datos de

INTERVALO • Fecha fin paradas por
FECHA fecha inicio.

VISTA PARADAS paradasView GET • id Vista de datos

• movil, lista, grupo, de paradas por
empresa agrupación

INSERCIÓN paradas POST • Datos parada Inserción

PARADAS o az paradas
o estados
o movil
o fechaInit
o fechaFin
o llegada
o ciudad
o dirección
o datos

1
Ver sección múltiples parametros
 o latitud
o longitud
o usuario
o resultado
o estado
o check
o empresa

EDICIÓN PARADAS paradas PUT • Datos parada Edición paradas

o az
o estados
o movil
o fechaInit
o fechaFin
o llegada
o ciudad
o dirección
o datos
o latitud
o longitud
o usuario
o resultado
o estado
o check
o empresa

FORMA forma GET id Consulta forma

movil, empresa
INSERCIÓN FORMA forma POST • Datos forma Inserción forma
o movil
o fechaIni
o fechaFin
o llegada
o ciudad
o dirección
o datos
o latitud
o longitud
o usuario
o resultado
o estado
o check
o tipo
o empresa

EDICIÓN FORMAS formas PUT o Datos formas Edición formas

o movil
o fechaIni
o fechaFin
o llegada
o ciudad
o dirección
o datos
o latitud
o longitud
o usuario
o resultado
o estado
o check
o tipo
o empresa
COMANDOS comandos GET id db (az, la) movil, lista, Lista de
grupo, empresa comandos por
agrupación

COMANDOS DB comandosDB GET id Lista de

db (az, la) movil, lista, comandos por
grupo, empresa agrupación

INSERCION comandos POST id movil, lista, grupo, Inserción de

COMANDOS empresa Datos comandos por
comandos agrupación

o tipo

o fecha

o comentario

o usuario

INSERCION comandosDB POST • id Inserción de

COMANDOS DB • db (az, la) comandos por
agrupación
• movil, lista,grupo,
• empresa
• Datos comandos
o Fecha
o comentario
o usuario

USUARIOS usuarios GET id Lista de

movil, lista, grupo, usuarios por
empresa agrupación
USUARIOS DB usuariosDB o id Lista de
o db (az, la) usuarios por
o movil, lista, agrupación
grupo, empresa

LOGIN loginEvo POST o id usuario Login

o secret (password) plataforma
evolucion

INFORMACION usuariosInfo GET o id Información de

USUARIOS o movil,lista, usuarios por
grupo,empresa agrupación.

VALIDAR EMAIL validarEmail GET o id email Validación

email usuario

INSERCION usuarios POST • Datos usuario Inserción

USUARIOS o id usuario
o estado
o nombres
o apellidos
o identificación
o teléfono
o celular
o email
o tipo
o empresa
o grupo
o lista
o movil
EDICION USUARIOS usuarios PUT • Datos usuario Actualización
o id usuario
o estado
o nombres
o apellidos
o identificación
o teléfono
o celular
o email
o tipo
o empresa
o grupo
o lista
o movil
EDICION USUARIOS usuariosAv • Datos usuario Actualización
AVANTEL o id usuario avantel
o nombres
o apellidos
o identificación
o teléfono
o celular
o email
o cargo
EDICION PASSWORD usuariosSec PUT • Datos Actualización
USUARIO usuario password
o id usuario
o secret

RECUPERACION usuariosSecBf PUT Datos usuario Cambio de

PASSWORD o id recuperacion de
USUARIO o secret password
usuario

RECUPERACION usuariosSecBfD PUT • Datos usuario Cambio de

PASSWORD o Id recuperación de
USUARIO
DB B o Db (az, la) password
o secret usuario

ELIMINACION usuarios DELETE • id Eliminar usuario

USUARIO

ESTADOS USUARIOS estadosusuarios GET N/A Estados usuarios

TIPOS USUARIOS tiposusuarios GET • tipo Tipos usuarios

LOG TABLAS logtablas • id Log acciones en

• usuario, accion la BD (Insercion,
modifación,
eliminación)

MENSAJES mensajesrecibid GET • id Mensajes

RECIBIDOS os • movil, lista, grupo, recibidos por
empresa agrupación

VISTA MENSAJES mensajesrecibid • id Vista mensajes

RECIBIDOS osView • movil, lista, grupo, recibidos por
empresa agrupación

MENSAJES mensajesrecibid GET • id Mensajes

RECIBIDOS osMoviles • movil, lista, grupo, recibidos por
MOVILES empresa moviles

MENSAJES mensajesrecibid GET • id Mensajes

RECIBIDOS osMovilesDB • db (az, la) recibidos por
MOVILES DB • movil, lista, grupo, moviles
empresa

REPORTES reportes GET • id Reportes

• movil, lista, grupo, moviles
empresa
REPORTES PUNTOS reportesPtos GET • id móvil Reportes puntos
• id empresa GPS

REPORTES PUNTOS reportesPtosInt GET • id móvil Reportes

EN INTERVALO • id empresa puntos GPS
• fecha inicio entre fechas
• fecha fin
• id tipo vehículo

FILTRO REPORTES reportesFiltro GET • id móvil Reportes

MOVILES • id empresa móviles entre
• fecha inicio fechas
• fecha fin
FILTRO REPORTES reportesFiltroD GET • id móvil Reportes
MOVILES DB B • id empresa móviles entre
• db (az, la) fechas
• fecha inicio
• fecha fin
REPORTES ESTADOS reportesEmMv GET • id móvil Reportes
MOVILES EN • id empresa móviles GPS en
INTERVALO • intervalo (horas) intervalo de
tiempo (horas)

REPORTES ESTADOS reportesEmMvD • id móvil Reportes

MOVILES EN B • id empresa móviles GPS en
INTERVALO DB • intervalo (horas) intervalo de
• db (az, la) tiempo (horas)

REPORTES MOVILES reportesMovPar GET • id móvil Reportes

PARAMETROS ams • id empresa móviles
parametros

REPORTES reportesHistoric GET id movil Reportes

HISTORICO o *(Soporta paginación) historico.
REPORTES reportesHistoric GET • id movil Reportes
HISTORICO oDB *(Soporta paginación) historico.
DB • db (az, la)

REPORTES reportesHistoric GET • Id movil Reportes

HISTORICO oCan *(Soporta paginación) historico can.
CAN
REPORTES reportesHorom GET • Id móvil Reportes

HOROMETRO etro • fecha inicio horometro

• fecha fin entre fechas.

ALARMAS alarmas GET • id Alarmas por

• movil, lista, grupo, agrupación.
empresa

VISTA ALARMAS alarmasView GET • id Vista de alarmas

• movil, lista, grupo, por agrupación.
empresa

ALARMAS MOVILES alarmasMoviles GET • id Alarmas

• movil, lista, grupo, móviles sin
empresa atender por
agrupación.
ALARMAS MOVILES alarmasMoviles GET • id Alarmas
DB DB • db (az, la) móviles sin
• movil, lista, grupo, atender por
empresa agrupación.

VALIDAR ALARMA validarAlarma • Datos Validar alarma.

validación
• Id alarma
• usuario
• comentario
ALARMAS LISTA alarmasListaEm GET • id Alarmas lista
EMPRESA p • movil, lista, grupo, empresa por
empresa agrupación.

TIPO ALARMAS tipoalarmas GET • Id Descripcion tipo

alarma.

TIPO ALARMAS tipoalarmas2 GET N/A Listado tipos

LISTA alarmas.

PRE ALARMA prealarmatiemp GET N/A Listado

TIEMPO o prealarmas
tiempo.

PRE ALARMA prealarmakilom GET N/A Listado

prealarmas

KILOMETRAJE etraje kilometraje.

MARCAS marcas GET N/A Listado marcas.

ESTATUS MOVIL estatusmovil GET N/A Listado estatus

móviles.

TIPOS tiposinstalacion GET N/A Listado tipos

INSTALACIONES es instalaciones.

LISTA lista GET • id Lista.

INSERCION LISTA listatags POST • Datos tag Insercion de tag

TAGS o móvil a una lista.
o tag

ELIMINACION LISTA listatags DELETE • id tag Retirar tag de

TAGS • id móvil lista.

LISTA EMPRESA listaempresa • id Lista empresa

• empresa, empresas por agrupación.
VISTA LISTA listaempresaVie GET • id Vista lista
EMPRESA w • movil, grupo, empresa empresa por
agrupación.

ESTADOS MOVILES estadosmoviles GET • id Estados móviles

• movil, lista, grupo, por agrupación.
empresa
• id instalacion

ESTADOS MOVILES estadosmoviles GET • id Estados móviles

DB DB • db (az, la) por agrupación.
• movil, lista, grupo,
empresa
• id instalacion

ESTADOS MOVILES estadosmoviles GET • id Estados

ACTIVOS DB DBActivos • db (az, la) móviles
• movil, lista, grupo, activos por
agrupación.

empresa

ESTADOS MOVILES estadosmoviles GET • id Estados móviles

TERMINALES Terminales • movil, lista, grupo, con terminal por
empresa agrupación.

ESTADOS MOVILES estadosmoviles GET • id Estados móviles

TERMINALES DB TerminalesDB • db (az, la) con terminal por
• movil, lista, grupo, agrupación.
empresa

ESTADOS MOVILES estadosmoviles GET • id Estados

GRUPOS GrpR • lista, grupo, empresa móviles de
grupos por
agrupación.
ESTADOS MOVILES estadosmoviles GET • id Estados
GRUPOS DB GrpRDB • db (az, la) móviles de
• lista, grupo, empresa grupos por
agrupación.
ESTADOS MOVILES estadosMoviles N/A Estados móviles
NUC Nuc Nuc.

TAGS MOVILES tagsMoviles GET • id Tags de móviles

• all, móvil, empresa por agrupación.

TAGS MOVILES DB tagsMovilesDB GET • id Tags de móviles

• db (az, la) por agrupación.
• all, móvil, empresa

INSERCION TAG tag POST o Datos tag Creación de un

etiqueta tag.
valor
empresa
MODIFICACION TAG tag UPDATE • Datos tag Modificación de
o id etiqueta* un tag.
o empresa*
o etiqueta
o valor

CVMOVIL cvmovil GET o id Hoja de vida de

un movil

CVMOVIL DB cvmovilDB GET • id Hoja de vida de

un movil

CVMOVIL cvmovilAgrp GET • id Hojas de vida

AGRUPADO • movil, lista, grupo, por agrupación.
empresa
INSERCION CVMOVIL cvmovil POST • Datos Cv Inserción hoja
o alarmaTiempo de vida.
o alarmaKilometraje
o operador
o identificacion
o telefono
o vin
o numMotor
o soat
o poliza
o bateria
o electrica
o suspension
o rtm
o adicional
o llantas
o aceite
o motor
o alineacion
o marca
o modelo
o ano (año)
o color
o comentario
o email
MODIFICACION cvmovil PUT o Datos Cv Modificación
CVMOVIL o id* hoja de vida.
o alarmaTiempo
o alarmaKilometraje
o operador
o identificacion
o teléfono
o vin
o numMotor
o soat
o poliza
o bateria
 o eléctrica
o suspensión
o rtm
o adicional
o llantas
o aceite
o motor
o alineación
o marca
o modelo
o ano (año)
o color
o comentario
o email

ELIMINACION cvmovil DELETE • id cvmovil Eliminar hoja de

CVMOVIL vida.

PUNTOS DE puntoscontrol o id empresa Puntos de

CONTROL control
empresa.

PUNTOS DE puntoscontrolD GET • id empresa Puntos de

CONTROL B • db (az, la) control
DB empresa.

INSERCION PUNTO puntoscontrol POST • Datos PC Inserción punto

DE o nombre control.
COTROL o latitud
o longitud
o distancia
o polygon
o empresa
MODIFICACION puntoscontrol PUT • DatosPC Modificación
PUNTO DE • Id punto de
CONTROL • Nombre control
• Latitud
• Longitud
 • polygon

MODIFICACION POI puntoscontrolP PUT • Datos Poi Modificación poi

o id poi

PUNTOS DE oi o grupo punto de control

CONTROL
ELIMINACION puntoscontrol DELETE • id punto control Eliminación
PUNTOS DE punto de control
CONTROL
POLIGONOS poligonos GET • id Geocercas
• grupo, empresa y rutas por
agrupación.

POLIGONOS DB polígonos DB GET • id Geocercas

• db (az, la) y rutas por
• grupo, empresa agrupación.

POLIGONOS GRUPOS poligonosGrupo GET • id grupo Geocercas

s y rutas por
geogrupo

MODIFICACION DE poligonosGrupo PUT • Datos Geogrupo Edición

GEOGRUPO s o id poligono geogrupo de
POLIGONO o grupo geocerca/ruta.

INSERCION DE poligonos • Datos Polígono Inserción

POLIGONOS o Nombre geocerca/ruta
o polygon
o tipo
o empresa
o polygon2
MODIFICACION DE poligonos PUT o • Datos Modificación
POLIGONOS pol geocerca/ruta.
nombre
opolygon
polygon2
ELIMINACION DE poligonos DELETE • id poligono Eliminación de
POLIGONOS geocerca/ruta.

GEOGRUPOS geogrupo GET • id Inforamción

geogrupo.

INSERCION geogrupo POST o Datos geogrupo Inserción

GEOGRUPOS nombre geogrupo.
o empresa

ELIMINACION geogrupo DELETE • id Eliminación

GEOGRUPOS geogrupo.

POIGRUPOS poigrupo GET • id empresa Poigrupos por

empresa.

INSERCION poigrupo POST • Datos Poi Inserción

POIGRUPOS • Nombre poigrupos.
• empresa

ELIMINACION poigrupo DELETE • d Eliminación

POIGRUPOS poigrupo.

MOVILES moviles GET • id Información

• placa, perfil, lista, grupo, móviles por
empresa agrupación.

MOVILES DB movilesDB • id Información

• db (az, la) móviles por
• placa, perfil, lista, grupo, agrupación.
empresa
MOVILES movilesAdmin GET • id Información
ADMINISTRACION • móvil, lista, grupo, administración
empresa móviles por
agrupación.
• id empresa auxiliar

VISTA MOVILES movilesView GET • id Vista móviles

• grupo, empresa por agrupación.

VISTA PARAMETROS movilesViewPar GET • id Vista

MOVILES ametros • grupo, empresa parametros
móviles por
agrupación.

VISTA movilesViewDis GET • id Vista

DISPONIBILIDAD ponibilidad • grupo, empresa disponibilidad
MOVILES móviles por
agrupación.

VISTA MOVILES movilesViewList GET • id Vista móviles

LISTA a • grupo, empresa con lista por
agrupación.

VISTA MOVILES MovilesViewList GET • id Vista móviles

LISTA aEmpresa • grupo, empresa con lista
EMPRESA empresa por
agrupación.

MOVILES CON movilesEtiqueta GET • id Información

ETIQUETAS s • móvil, lista, grupo, móviles con
empresa etiquetas por
agrupación.

CONFIGURACION movilesConf GET • id Información

MOVILES • grupo, empresa móviles
• Etiqueta configuración
por agrupación.
CONFIGURACION movilesConf2 • id Información
MOVILES 2 • móvil, lista, grupo, móviles
empresa configuración
por agrupación,
alternativo.

CONFIGURACION movilesConfAz GET • id Información

MOVILES AZLOGICA • móvil, lista, grupo, móviles
empresa configuración
por agrupación
azlogica.

CONFIGURACION movilesConfAv GET • id Información

MOVILES AVANTEL • móvil, lista, grupo, móviles
empresa configuración
por agrupación
avantel.

MOVILES movilesAgrs GET • id Información

AGRUPADOS • móvil, lista, grupo, móviles por
empresa agrupación.

CONSUMO MOVILES movilesCom GET • id movil Información

consumo
móviles

MOVILES TIPOS movilesType GET • id Información

• móvil, lista, grupo, tipos móviles
empresa por agrupación.

MOVILES movilesTerminal GET • id Información

TERMINALES es • móvil, grupo, empresa móviles
terminales por
agrupación.
MODIFICACION moviles PUT • Datos movil Modificación
MOVILES • id móviles.
• placa
• grupo
• alias
• tipo
• tipovehiculo
• consumo
• capacidad
• instalacionFecha
• revisión
• telefono
• satelital
• mantenimiento
• instalación
• imei
• imsi
• iccid
• vin
• id3
ADICION MOVILES móviles POST • id (movil) Adicion moviles
• tipo vehiculo
• tipo
• terminal
• setup
• instalación
• parámetros
• payd
• instalaciónFecha
 • revisión
• carga
• teléfono
• satelital
• versión
• bloqueo
• mantenimiento
• placa
• grupo
• tiempo
• subida
• bajada
• idle
• idleStart
• idleStop
• consumo
• consumoProm
• capacidad
• altura
• alias
• imei
• imsi
• iccid
• vin
• id2
• id3
• id4
• id5
MODIFICACION movilesParamet PUT • id movil Modificación
PARAMETROS ros • parámetros (id perfil perfil zona verde
MOVILES zona verde) en movil

MODIFICACION movilesParamet PUT • id (movil) Modificación

PARAMETROS rosDB • db (az, la) perfil zona verde
MOVILES DB • parametros (id perfil en movil
zona verde)
ELIMINACION moviles DELETE • id (movil) Eliminación
MOVILES movil
PARAMETROS parametros GET • id (perfil zona verde) Información
parametros

perfil zona verde

PARAMETROS DB parametrosDB GET • id (perfil zona verde) Información

• db (az, la) parametros
perfil zona
verde
INSERCION parametros POST • Datos perfil ZV Inserción
PARAMETROS empresa o parametros
nombre o perfil zona
timeVel o verde.
velSub o
velBaj
INSERCION parametrosDB POST • Datos perfil ZV o Inserción
PARAMETROS DB • db (az, la) parametros
• empresa perfil zona
• nombre verde.
• timeVel
• velSub
• velBaj
MODIFICACION parametros • Datos perfil ZV Modificación
PARAMETROS o id perfil ZV o parametros
velBaj o perfil zona
velSub o verde.
timeVel o
timeAc o ac o
desAc o imp o
impTime
MODIFICACION parametrosDB PUT • Datos perfil ZV Modificación
PARAMETROS DB o id perfil ZV parametros
o db (az, la) perfil zona
o velBaj verde.
o velSub
o timeVel
o timeAc
o ac
o desAc
o imp
o impTime
ELIMINACION parametros DELETE o id Eliminación
PARAMETROS perfil zona

verde.

ELIMINACION parametrosDB DELETE • id Eliminación

PARAMETROS DB • db (az, la) perfil zona
verde.

OPERADORES operadores GET • id operador o lista, Información

nombre, empresa operadores por
• id agrupación agrupación.
• id empresa auxiliar

INSERCION operadores POST • Datos operador Inserción

OPERADORES o id operador.
o nombre
o empresa
o tráiler
LISTA EMAIL listaemail GET • id lista Información lista
email.

INSERCION LISTA listaemail • Datos lista Inserción lista

EMAIL empresa email.
nombre
email
LISTA ALARMAS listaAlarmas GET • id Información lista
• móvil, lista, grupo, alarmas por
empresa agrupación

MODIFICACION listaAlarmas PUT • Datos lista Modificación

LISTA id lista lista alarmas
ALARMAS empresa
grupo
movil
geogrupo
email
operador
sms
tiempo
comentario
listaemail
listacelular
ELIMINACION LISTA listaAlarmas DELETE • id lista Eliminación lista

ALARMAS alarmas.

RUTAS rutas GET • id empresa Información

rutas por
empresa

MANTENIMIENTOS mantenimientos GET • id Información

• o móvil, lista, grupo, mantenimientos
empresa por agrupación.
• id empresa
auxiliar (si
aplica2)

2
Verifique con la persona asignada a su cuenta (Gerencia de Clientes)
INSERCION mantenimientos POST • Datos Inserción
MANTENIMIENTOS mantenimiento mantenimiento.
empresa
taller
kilometraje
comentario
fecha
servicio
tipo
movil
MODIFICACION mantenimientos • Datos mantenimiento Modificación
MANTENIMIENTOS o id mantenimiento
o mantenimiento*
empresa
o taller
o tipo móvil
o fecha servicio
kilometraje
o comentario

ELIMINACION mantenimientos DELETE • id Eliminación

MANTENIMIENTOS mantenimiento.

GRUPOS grupos GET • id Información

• empresa, az, av grupos por
agrupación.

GRUPOS DB gruposDB GET • id Información

• db (az, la) empresa, grupos por
• az, av agrupación.

GRUPOS gruposTerminal GET • id empresa Información

TERMINALES es grupos con
equipos
terminales por
empresa.
GRUPOS gruposTerminal GET • id empresa Información
TERMINALES esDB • db (az, la) grupos con
DB equipos
terminales por
empresa.

GRUPOS gruposAdmin GET • id Información

ADMINISTRACION • móvil, lista, grupo, empresa grupos para
• id empresa auxiliar administración
por
agrupación.
GRUPOS ALARMAS gruposAlarmas GET • id empresa Información
grupos alarmas

IINSERCION grupos o Datos Inserción grupo.

GRUPOS grupo
nombre
empresa
comentario
MODIFICAICON grupos PUT o Datos Modificación
GRUPOS grupo grupo.
o id grupo*
o nombre
o empresa
o comentario
ELIMINACION grupos DELETE • id grupo Eliminación
GRUPOS grupo.

EMPRESA empresa GET • id empresa Información

• lista empresa

EMPRESA DB empresaDB GET • id empresa Información

• db (az, la) empresa
• lista
EMPRESA ACTIVA empresa2 GET N/A Información
empresas
estado 1.
INSERCION empresa POST • Datos Inserción
EMPRESA empresa empresa.
• Nombre
• comentario
MODIFICACION empresa PUT • Datos empresa Modificación
EMPRESA o id empresa.
o empresa*
o nombre
o estado
o comentario

TIPOS VEHICULOS tiposvehiculos GET N/A Información

tipos vehiculos.

TIPOS EQUIPOS tiposequipos GET N/A Información

tipos equipos.

TIPOS tiposmantenimi GET N/A Información

MANTENIMIENTOS entos tipos
mantenimientos
3. JavaScript

Es un lenguaje interpretado orientado a objetos que se utiliza en páginas web y

aplicaciones de servidor, Javascript puede interactuar con el código HTML
permitiendo utilizar contenido dinámico, es opensource por lo que cualquier
persona puede utilizarlo sin comprar una licencia.

Ahora se muestran los equivalentes de Javascript para comando cURL de los

ejemplos vistos anteriormente.

a. cURL POST en JavaScript

El scripting en JavaScript para el método POST que se explicó en el comando

cURL, el cual permite autenticarse en:
[Link]

En JavaScript es de la siguiente forma:

var INSTANCE_URL = '[Link]

var email = 'xxxx@[Link]';
var password = 'XXXXXXXXXX';
var apikey = 'aquí_va_el_api_key';
var tkn;
$.ajax({
dataType: 'json',
async: true,
contentType: 'application/json; charset=utf-8',
url: INSTANCE_URL + '/api/v2/user/session',
method: 'POST'
data: [Link]({
'email': email,
'password': password
 }),
success: function (response) {
// Handle success
tkn = response.session_token;
},
error: function (response) {
// Handle error
[Link](response);
}
});

b. cURL GET en JavaScript

Ahora se muestra el scripting en JavaScript para el método GET que se explicó

en el comando cURL, el cual, después de lograr la autenticación, por medio del
método POST, mantiene la sesión con el token, se puede realizar entonces
peticiones para obtener un archivo. Como se mencionó, los métodos a los cuales
puede acceder para obtener archivos son:

• alarmas_view
• estadosmoviles_empresa_view
• reportes_view

Por ejemplo, para acceder al método de reporte, debe acceder a la Url:

[Link]

La manera de realizar la petición GET en JavaScript es la siguiente:

 $.ajax({
async: true,
dataType: 'json',
crossDomain: true,
url: INSTANCE_URL + '/api/v2/aplicacion/_table/alarmas_view',
data: 'api_key=' + apikey + '&session_token=' + tkn,
method:'GET',
success:function (response) {
// Handle success
},
error:function (response) {
// Handle error
[Link](response);
if([Link] == 401){
$.ajax({
// Generar un nuevo token mediante metodo explicado anteriormente
}
}
});

4. Límites de Uso

Los siguientes son los límites de uso:

• Se limita a 5000 solicitudes por 24 horas, calculadas como la suma de las solicitudes
client-side y solicitudes server-side.
• Se limita a 10 solicitudes por minuto (QPS) por cuenta.
• Limite por default. Contacte a su representante comercial si necesita un límite
superior.
Investigación y Desarrollo