Manual REST API

Bogotá Enero 2017 Código: P-ID-20 V2

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 ..................................................................................................................................................................2
a. Ejemplos .......................................................................................................................................................3
POST..........................................................................................................................................................3
GET............................................................................................................................................................4
3. JavaScript ....................................................................................................................................................... 31
a. cURL POST en JavaScript............................................................................................................................ 31
b. cURL GET en JavaScript.............................................................................................................................. 32
4. Límites de Uso ............................................................................................................................................... 33

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
A2 Enero 2017 Requisitos de autenticación (apikey, email y password) GT
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 parámetros JC
2 Enero 2018 Adición métodos BD JC

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:

 --noproxy '*' Para ignorar el proxy.

 -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.
 -H Para indicar al servidor el tipo de contenido que se desea de regreso, se debe establecer
la cabecera Content-Type anteponiendo -H
 -i Incluye el encabezado HTTP en la salida. El encabezado HTTP incluye cosas como el
nombre del servidor, la fecha del documento, la versión HTTP y más.

a. Ejemplos

 POST

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

https://api1.azlogica.com/login

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:

 id Es el usuario asignado, con el cual se va a autenticar.

 secret Es la contraseña asignada al usuario.

Una vez cuente con los datos anteriores puede autenticarse, el comando aplicable es el
siguiente:
 curl --noproxy '*' -X POST
-H 'Content-Type: application/json'
-d '{ "id" : "xxxx@azlogica.com", "secret" : "XXXXXXXXXX" }'
-i https://api1.azlogica.com/api/v1/login

Se selecciona el método POST:

curl --noproxy '*' -X POST

Se aplican las cabeceras:

-H 'Content-Type: application/json'

Se envían las credenciales (id y secret) para autenticarse en:

-d '{ "id" : "xxxx@azlogica.com", "secret" : "XXXXXXXXXX" }'
-i https://api1.azlogica.com/api/v1/login

Si el método POST tiene éxito, se obtienen los datos del usuario y el token.

{"user":"xxxx@azlogica.com",
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw"}

Las sesiones tienen una duración de 30 minutos. Pasado este tiempo la sesión expira y es
necesario crear un nuevo token. En caso de ingresar datos de autenticación incorrectos el
método retornara error.

 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.
 Los métodos, parámetros y la respuesta que se obtiene se muestran a continuación. Los
métodos marcados en ROJO son métodos OBSOLETOS y se retiraran en una actualización
posterior. Los nuevos métodos se encuentran seguidos de estos e incluyen un nuevo
parámetro DB el cual indica que base de datos se debe usar para la consulta. Los parámetros
en rojo son opcionales:

EVOLUCION

NOMBRE MÉTODO TIPO PARÁMETROS RESPUESTA

PARADAS paradas GET  Id, multi1 Datos de

 movil, empresa, datos paradas por
agrupación

PARADAS INTERVALO paradasInt GET  Fecha inicio Datos de

FECHA  Fecha fin paradas por
fecha inicio.

VISTA PARADAS paradasView GET  id Vista de datos

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

INSERCIÓN PARADAS paradas POST  Datos parada Inserción

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

1
Ver sección múltiples parametros
 o datos
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  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 Lista de

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

COMANDOS DB comandosDB GET  id Lista de

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

INSERCION comandos POST  id Inserción de

COMANDOS  movil, lista, grupo, comandos por
empresa agrupación
 Datos comandos
 o tipo
o fecha
o comentario
o usuario

INSERCION comandosDB POST  id Inserción de

COMANDOS DB  db (az, ma , la) comandos por
 movil, lista, grupo, agrupación
empresa
 Datos comandos
o tipo
o fecha
o comentario
o usuario

USUARIOS usuarios GET  id Lista de usuarios

 movil, lista, grupo, por agrupación
empresa

USUARIOS DB usuariosDB GET  id Lista de usuarios

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

LOGIN loginEvo POST  id usuario Login

 secret (password) plataforma
evolucion

INFORMACION usuariosInfo GET  id Información de

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

VALIDAR EMAIL validarEmail GET  id Validación email

 email usuario

INSERCION USUARIOS usuarios POST  Datos usuario Inserción

o id usuario
o estado
o nombres
o apellidos
o identificacion
 o telefono
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 identificacion
o telefono
o celular
o email
o tipo
o empresa
o grupo
o lista
o movil
EDICION USUARIOS usuariosAv PUT  Datos usuario Actualización
AVANTEL o id usuario avantel
o nombres
o apellidos
o identificacion
o telefono
o celular
o email
o cargo
EDICION PASSWORD usuariosSec PUT  Datos usuario Actualización
USUARIO o id password
o secret usuario

RECUPERACION usuariosSecBf PUT  Datos usuario Cambio de

PASSWORD USUARIO o id recuperacion de
o secret password
usuario

RECUPERACION usuariosSecBfD PUT  Datos usuario Cambio de

PASSWORD USUARIO o Id recuperacion de
DB B o Db (az, ma, 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 RECIBIDOS mensajesrecibid GET  id Mensajes

os  movil, lista, grupo, recibidos por
empresa agrupación

VISTA MENSAJES mensajesrecibid GET  id Vista mensajes

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

MENSAJES RECIBIDOS mensajesrecibid GET  id Mensajes

MOVILES osMoviles  movil, lista, grupo, recibidos por
empresa moviles

MENSAJES RECIBIDOS mensajesrecibid GET  id Mensajes

MOVILES DB osMovilesDB  db (az, ma, la) recibidos por
 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 puntos
EN INTERVALO  id empresa GPS entre
 fecha inicio 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, ma, 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 GET  id móvil Reportes

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

REPORTES MOVILES reportesMovPar GET  id móvil Reportes

PARAMETROS ams  id empresa móviles
parametros

REPORTES HISTORICO reportesHistoric GET  id movil Reportes

o *(Soporta paginación) historico.

REPORTES HISTORICO reportesHistoric GET  id movil Reportes

DB oDB *(Soporta paginación) historico.
 db (az, ma, la)

REPORTES HISTORICO reportesHistoric GET  Id movil Reportes

CAN oCan *(Soporta paginación) historico 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 móviles

 movil, lista, grupo, sin atender por
empresa agrupación.

ALARMAS MOVILES alarmasMoviles GET  id Alarmas móviles

DB DB  db (az, ma, la) sin atender por
 movil, lista, grupo, agrupación.
empresa

VALIDAR ALARMA validarAlarma PUT  Datos validación Validar alarma.

o id alarma
o usuario
o 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 LISTA tipoalarmas2 GET N/A Listado tipos

alarmas.

PRE ALARMA TIEMPO prealarmatiemp GET N/A Listado

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 GET  id Lista empresa

 empresa, empresas por agrupación.

VISTA LISTA EMPRESA listaempresaVie GET  id Vista lista

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, ma, la) por agrupación.
 movil, lista, grupo,
empresa
 id instalacion

ESTADOS MOVILES estadosmoviles GET  id Estados móviles

ACTIVOS DB DBActivos  db (az, ma, la) activos por
 movil, lista, grupo, 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, ma, la) con terminal por
 movil, lista, grupo, agrupación.
empresa

ESTADOS MOVILES estadosmoviles GET  id Estados móviles

GRUPOS GrpR  lista, grupo, empresa de grupos por
agrupación.

ESTADOS MOVILES estadosmoviles GET  id Estados móviles

GRUPOS DB GrpRDB  db (az, ma, la) de grupos por
 lista, grupo, empresa agrupación.

ESTADOS MOVILES estadosMoviles GET 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, ma, la) por agrupación.
 all, móvil, empresa

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

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

CVMOVIL cvmovil GET  id Hoja de vida de

 un movil

CVMOVIL DB cvmovilDB GET  id Hoja de vida de

un movil

CVMOVIL AGRUPADO cvmovilAgrp GET  id Hojas de vida

 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  Datos Cv Modificación
CVMOVIL o id* hoja de vida.
o alarmaTiempo
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
ELIMINACION cvmovil DELETE  id cvmovil Eliminar hoja de
CVMOVIL vida.

PUNTOS DE CONTROL puntoscontrol GET  id empresa Puntos de

control
empresa.

PUNTOS DE CONTROL puntoscontrolD GET  id empresa Puntos de

DB B  db (az, ma, la) control
empresa.

INSERCION PUNTO DE puntoscontrol POST  Datos PC Inserción punto

COTROL o nombre control.
o latitud
o longitud
o distancia
o polygon
o empresa
MODIFICACION puntoscontrol PUT  Datos PC Modificación
PUNTO DE CONTROL o id punto de control
o nombre
o latitud
o longitud
o polygon
MODIFICACION POI puntoscontrolP PUT  Datos Poi Modificación poi
o id poi
PUNTOS DE CONTROL oi o grupo punto de control

ELIMINACION puntoscontrol DELETE  id punto control Eliminación

PUNTOS DE CONTROL punto de control

POLIGONOS poligonos GET  id Geocercas y

 grupo, empresa rutas por
agrupación.

POLIGONOS DB polígonos DB GET  id Geocercas y

 db (az, ma, la) rutas por
 grupo, empresa agrupación.

POLIGONOS GRUPOS poligonosGrupo GET  id grupo Geocercas y

s 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 POST  Datos Polígono Inserción

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

GEOGRUPOS geogrupo GET  id Inforamción

geogrupo.

INSERCION geogrupo POST  Datos geogrupo Inserción

GEOGRUPOS o 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 o nombre poigrupos.
o empresa

ELIMINACION poigrupo DELETE  id Eliminación

POIGRUPOS poigrupo.

MOVILES moviles GET  id Información

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

MOVILES DB movilesDB GET  id Información

 db (az, ma, 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
 id empresa auxiliar agrupación.

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 LISTA movilesViewList GET  id Vista móviles
a  grupo, empresa con lista por
agrupación.

VISTA MOVILES LISTA MovilesViewList GET  id Vista móviles

EMPRESA aEmpresa  grupo, empresa con lista
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 GET  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 o id móviles.
o placa
o grupo
o alias
o tipo
o tipovehiculo
o consumo
o capacidad
o instalacionFecha
o revision
o telefono
o satelital
o mantenimiento
o instalacion
o imei
o imsi
o iccid
o vin
o 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 zona perfil zona verde
MOVILES verde) en movil

MODIFICACION movilesParamet PUT  id (movil) Modificación

PARAMETROS rosDB  db (az, ma, la) perfil zona verde
MOVILES DB  parametros (id perfil zona en movil
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, ma, la) parametros
perfil zona verde

INSERCION parametros POST  Datos perfil ZV Inserción

PARAMETROS o empresa parametros
o nombre perfil zona
o timeVel verde.
o velSub
o velBaj
INSERCION parametrosDB POST  Datos perfil ZV Inserción
PARAMETROS DB o db (az, ma, la) parametros
o empresa perfil zona
o nombre
verde.
o timeVel
o velSub
 velBaj
MODIFICACION parametros PUT  Datos perfil ZV Modificación
PARAMETROS o id perfil ZV parametros
o velBaj perfil zona
o velSub verde.
o 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, ma, la) perfil zona
o velBaj
verde.
o velSub
o timeVel
o timeAc
o ac
o desAc
o imp
 impTime
ELIMINACION parametros DELETE  id Eliminación
PARAMETROS perfil zona
 verde.

ELIMINACION parametrosDB DELETE  id Eliminación

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

OPERADORES operadores GET  id operador Información

o lista, nombre, operadores por
empresa agrupación.
 id 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 POST  Datos lista Inserción lista

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

MODIFICACION LISTA listaAlarmas PUT  Datos lista Modificación

ALARMAS o id lista lista alarmas
o empresa
o grupo
o movil
o geogrupo
o email
o operador
o sms
o tiempo
o comentario
o listaemail
o 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)
INSERCION mantenimientos POST  Datos mantenimiento Inserción
MANTENIMIENTOS o empresa mantenimiento.
o taller
o kilometraje
o comentario
o fecha
o servicio
o tipo
o movil
MODIFICACION mantenimientos PUT  Datos mantenimiento Modificación
MANTENIMIENTOS o id mantenimiento* mantenimiento
o empresa
o taller
o tipo
o móvil
o fecha
o servicio
o 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, ma, la) grupos por
 empresa, az, av agrupación.

2
Verifique con la persona asignada a su cuenta (Gerencia de Clientes)
GRUPOS TERMINALES gruposTerminal GET  id empresa Información
es grupos con
equipos
terminales por
empresa.

GRUPOS TERMINALES gruposTerminal GET  id empresa Información

DB esDB  db (az, ma, la) grupos con
equipos
terminales por
empresa.

GRUPOS gruposAdmin GET  id Información

ADMINISTRACION  móvil, lista, grupo, grupos para
empresa administración
 id empresa auxiliar por agrupación.

GRUPOS ALARMAS gruposAlarmas GET  id empresa Información

grupos alarmas

IINSERCION GRUPOS grupos POST  Datos grupo Inserción grupo.

o nombre
o empresa
o comentario
MODIFICAICON grupos PUT  Datos grupo Modificación
GRUPOS o id grupo* 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, ma, la) empresa
 lista
EMPRESA ACTIVA empresa2 GET N/A Información
empresas
estado 1.
INSERCION EMPRESA empresa POST  Datos empresa Inserción
o nombre empresa.
o comentario
MODIFICACION empresa PUT  Datos empresa Modificación
EMPRESA o id empresa* 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

MANUELITA

EMPRESA empresaManuel GET  id empresa Información

ita empresa

GRUPOS gruposManuelit GET  id Información

a  empresa grupos por
agrupación.

GRUPOS TERMINALES gruposTerminal GET  id empresa Información

esManuelita grupos
terminales

MOVILES movilesManueli GET  id Información

ta  lista, grupo, empresa móviles por
agrupación.

MODIFICACION movilesParamet PUT  id movil Modificación

PARAMETROS rosManuelita  id perfil zona verde perfil zona verde
MOVILES en movil

REPORTES HISTORICO reportesHistoric GET  id móvil *(Soporta Reportes

 oManuelita paginación) historico.

REPORTES ESTADOS reportesEmMv GET  id móvil Reportes

MOVILES EN Manuelita  id empresa móviles GPS en
INTERVALO  intervalo (horas) intervalo de
tiempo (horas)

FILTRO REPORTES reportesFiltroM GET  id móvil Reportes

MOVILES anuelita  id empresa móviles entre
 fecha inicio fechas
 fecha fin
 id tipo vehículo
CONDUCTORES conductores GET  id empresa Información
conductores

TAGS MOVILES tagsMovilesMan GET  id Información tags

uelita  movil, empresa moviles

MENSAJES MOVILES mensajesrecibid GET  id Mensajes

osMovilesManu  movil, lista, grupo, móviles.
elita empresa

ESTADOS MOVILES estadosMoviles GET  id Estados móviles.

Manuelita  movil, lista, grupo,
empresa

ESTADOS MOVILES estadosMoviles GET  id Estados móviles

ACTIVOS ManuelitaActivo  movil, lista, grupo, GPS activo.
s empresa

ESTADOS MOVILES estadosmoviles GET  id Estados móviles

GRUPOS GrpRManuelita  lista, grupo, empresa de grupos por
agrupación.

MOVILES estadosmoviles GET  id Estados móviles

TERMINALES TerminalesMan  movil, lista, grupo, terminales
uelita empresa

TIPOS VEHICULOS tiposvehiculosM GET N/A Información

anuelita tipos vehículos.
LOGIN loginManuelita POST  id usuario Login
 secret (password) plataforma
manuelita

USUARIOS usuariosManuel GET  id Lista de usuarios

ita  movil, lista, grupo, por agrupación.
empresa

RECUPERACION usuariosSecBfM PUT  Datos usuario Cambio de

PASSWORD USUARIO anuelita o Id recuperacion de
o secret password
usuario

COMANDOS comandosManu GET  id Lista de

elita  movil, lista, grupo, comandos por
empresa agrupación

INSERCION comandosManu POST  id Inserción de

COMANDOS elita  movil, lista, grupo, comandos por
empresa agrupación
 Datos comandos
o tipo
o fecha
o comentario
 usuario

CVMOVIL cvmovilManueli GET  id Hoja de vida de

ta un movil

ALARMAS MOVILES alarmasMoviles GET  id Alarmas móviles

Manuelita  movil, lista, grupo, sin atender por
empresa agrupación.

PARAMETROS parametrosMan GET  empresa Información

uelita parametros
perfil zona verde

INSERCION parametrosMan POST  Datos perfil ZV Inserción

PARAMETROS uelita o empresa parametros
o nombre perfil zona
o timeVel
 o velSub verde.
 velBaj

MODIFICACION parametrosMan PUT  Datos perfil ZV Modificación

PARAMETROS uelita o id perfil ZV parametros
o velBaj perfil zona
o velSub
verde.
o timeVel
o timeAc
o ac
o desAc
o imp
 impTime

ELIMINACION parametrosMan DELETE  id Eliminación

PARAMETROS uelita perfil zona
verde.

PUNTOS DE CONTROL puntoscontrolM GET  id empresa Puntos de

anuelita control
empresa.

POLIGONOS poligonosManu GET  id Geocercas y

elita  grupo, empresa rutas por
agrupación.

Tabla 1: Métodos, parámetros y respuestas.

Por ejemplo, para acceder al método de Estado Móviles, con los parámetros de id = 1 (El cual es
el valor del parámetro de la empresa para este caso en particular) y empresa debe acceder a la
url:

https://api1.azlogica.com/api/v1/estadosmoviles/1/empresa

De forma general la url seria:

 https://api1.azlogica.com/api/v1/metodo/parametro_1/parametro_2

Cambie la palabra "metodo" por el nombre del método, la palabra "parametro_1" por el id
(valor asignado al parametro_2) y la palabra "parametro_2" por el segundo parámetro que
necesite. Tener en cuenta que en adelante volverá a ver las palabras "metodo",
"parametro_1" y "parametro_2" no olvide cambiarlas.

La manera de realizar las peticiones GET/DELETE es:

curl --noproxy '*' -X GET/DELETE

-H 'Content-Type: application/json'
-H 'Authorization:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw'
-i https://api1.azlogica.com/api/v1/metodo/parametro_1/parametro_2

Cuando utilice múltiples parámetros (peticiones GET), se debe realizar de la siguiente forma:

curl --noproxy '*' -X GET/DELETE

-H 'Content-Type: application/json'
-H 'Authorization:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw'
-i https://api1.azlogica.com/api/v1/metodo/multi?paramAd=valor&paramAd2=valor...

Los métodos que utilizan múltiples parámetros (paradas) recién como único parámetro
principal: multi.

La manera de realizar las peticiones POST y PUT es:

curl --noproxy '*' -X POST/PUT
-H 'Content-Type: application/json'
-H 'Authorization:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw'
 -d {“nombre_parametro_1:” “valor_parametro_1“, “nombre_ parametro_2” :
“valor_parametro_2” … }
-i https://api1.azlogica.com/api/v1/metodo

Para los métodos reportes históricos y reportes histórico can, es posible realizar paginación,
solicitando únicamente un rango de registros:

La manera de realizar la petición paginada es:

curl --noproxy '*' -X GET

-H 'Content-Type: application/json'
-H ‘Range: items= rango inferior-rango superior’
-H 'Authorization:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9eyJ...t0dSQWGnTROppvt1ajw'
-i https://api1.azlogica.com/api/v1/metodo/parametro_1/parametro_2

Los rangos deben ser valores numéricos enteros positivos.

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:
https://api1.azlogica.com/login
 En JavaScript es de la siguiente forma:

$.ajax({
url: 'https://api1/azlogica.com/api/v1/' + 'login',
contentType: 'application/json,
method: 'POST',
dataType: 'json',
data: JSON.stringify({
'id': id,
'secret': secret
}),
success: function (response) {
// Handle success
tkn = response.session_token;
},
error: function (response) {
// Handle error
console.log(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. Los métodos pueden
ser consultados en la tabla 1.

Por ejemplo, para acceder a cualquier método, debe acceder a la Url:

https://api1.azlogica.com/api/v1/method/value/parameter?token=<token>

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

 $.ajax({
url: 'https://api1/azlogica.com/api/v1/' + method + '/' + value + '/' + parameter,
async: false,
contentType: 'application/json,
method: request,
headers: {
'"Authorization": token,
},
success:function (response) {
// Handle success
console.log(response);
},
error:function (response) {
// Handle error
console.log(response);
if(response.status == 401){
$.ajax({
// Generar un nuevo token mediante método de autenticación
// 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