Add On Interfaz API Autorizó: Fernando Olmos Barrones
Creado por: Julio Cesar Lopez R Modificado por: Telcel SVA
Fecha: 4 de mayo del 2018 Fecha: 12 de septiembre del 2019
Add On Interfaz API
Versión 1
1
Add On Interfaz API Autorizó: Fernando Olmos Barrones
Creado por: Julio Cesar Lopez R Modificado por: Telcel SVA
Fecha: 4 de mayo del 2018 Fecha: 12 de septiembre del 2019
Contenido 1.
Objetivo ........................................................................................................................................................................... 3
2.
¿Qué es?.......................................................................................................................................................................... 3
3.
Información disponible en la interfaz ............................................................................................................................. 3
4.
¿Cómo funciona? ............................................................................................................................................................ 4
5.
Beneficios ........................................................................................................................................................................ 4
6.
Precio .............................................................................................................................................................................. 4
7.
Módems compatibles...................................................................................................................................................... 6
2
Add On Interfaz API Autorizó: Fernando Olmos Barrones
Creado por: Julio Cesar Lopez R Modificado por: Telcel SVA
Fecha: 4 de mayo del 2018 Fecha: 12 de septiembre del 2019
1. Objetivo Explicar los datos que pueden ser obtenidos desde la plataforma GVT y que pueden ser transferidos a sistemas externos (propios o de terceros) por medio de webservices manteniendo la integridad de la información.
2. ¿Qué es? La definición de API (Application Programming Interface o Interfaz de Programación de Aplicaciones) es un conjunto de comandos, subrutinas, funciones y procedimientos (o métodos, en la programación orientada a objetos) que ofrecen al desarrollador cierta biblioteca para ser utilizada por otro software y de esta forma evitar escribir códigos desde cero tomando como fuente la información obtenida desde las funcionalidades del sistema principal. De tal forma que la interfaz API de GVT permite a los clientes tener acceso a la información y controlar su flotilla de la plataforma GVT mediante un programa basado en webservices, y así obtener/extraer información de su flotilla para visualizarla en un sistema propio o de terceros brindando la ventaja de siempre monitorear y controlar sus necesidades desde una sola interfaz, operando de forma centralizada los datos, ubicaciones y mediciones de su flotilla.
3. Información disponible en la interfaz Con esta funcionalidad, se pueden obtener/extraer los datos generados por los módems desde la base de datos de GVT con el fin de ser insertados en otros programas de software o interfaces que el cliente desee. Los datos del vehículo monitoreado que se pueden extraer son:
Información básica del usuario Información detallada del usuario Lista de vehículos Consulta detalle de un vehículo. Consulta lista de grupo de vehículos Consulta de eventos por vehículo en un periodo de tiempo. Geocercas Consulta de viajes por vehículo en un periodo de tiempo. Consulta de viajes por grupo de vehículo en un periodo de tiempo
El detalle de la estructura e información respecto a los parámetros del API, está disponible en el manual para desarrolladores GVT.
3
Add On Interfaz API Autorizó: Fernando Olmos Barrones
Creado por: Julio Cesar Lopez R Modificado por: Telcel SVA
Fecha: 4 de mayo del 2018 Fecha: 12 de septiembre del 2019
4. ¿Cómo funciona? El cliente a través de un webservice podrá recibir e interpretar la información contenida en la plataforma de GVT, por medio del cual se exportan los datos hacia sistemas externos (otra plataforma y/o aplicación) propios o de terceros. Por lo anterior, el cliente requiere de un equipo de desarrolladores con experiencia en el uso de este tipo de interfaz, así como conocimiento de distintos lenguajes de programación, (JSON, REST, XML, entre otros). Consideraciones especiales:
Se puede usar cualquier lenguaje de programación para hacer la comunicación vía API. Al activar este Add On, se habilita para toda la Flotilla del cliente. Para la integración del API debe considerarse que la comunicación de datos es asíncrona entre sistemas con un tiempo de respuesta entre 10 a 15 segundos.
5. Beneficios El contar con esta interfaz, permite al cliente la integración a sistemas propios o de terceros, lo que le brinda un flujo de información más rápido y eficiente en la administración de su flotilla. El API unifica la operación en un solo sistema sin tener que acceder a distintas interfaces, lo que facilita y agiliza la interacción de los sistemas en la empresa, mismo que se traduce en reducción de tiempos, disminución de errores y automatización de procesos. CírculoCorp proporciona en todo momento orientación técnica sobre el uso de estos procedimientos en caso de que existan dudas por parte del equipo de desarrollo del cliente. Beneficios Adicionales para transportistas: Se cuenta con integración a R–Control y Assistcargo que permiten tener relaciones de negocio más especializadas con empresas de distribución, como Walmart, Soriana o Unilever.
6. Precio Se cobra de forma adicional al precio actual del servicio GVT contratado, en caso de aplicar el precio de instalación de los accesorios para esta solución puede variar. Para conocer el costo vigente de este servicio, es necesario consultarlo con su Ejecutivo de cuenta Telcel.
4
Creado por: Julio Cesar Lopez R Modificado por: Telcel SVA
Add On Interfaz API Autorizó: Fernando Olmos Barrones
Fecha: 4 de mayo del 2018 Fecha: 12 de septiembre del 2019
7. Módems compatibles Todos los módems homologados disponibles en el servicio GVT. Marca
Módem Modelo
Segmento de mercado
Tecnología
CELLOCATOR SUNTECH *
CR300B – M ST600R
3G 3G
CELLOCATOR
CR300B
3G
SUNTECH * CELLOCATOR CELLOCATOR MHUB
ST650 Cellotrack Power Cellotrack Portátil IP67 MHub 837-5
3G 3G 3G 3G
CELLOCATOR
Cello CANIQ
3G
NAVTRAK
T800W
3G
Motos
ZTE
Z6200MEX
4G
OBD II
Motos Autos Autos Blindados Tracto camiones OBD Cajas (Contenedores) Cajas (Contenedores) OBD II Autos Blindados Tracto camiones
(*)Respecto a los equipos marca Suntech, debe considerarse que la Dirección de Compras solicita la autorización expresa de los Directores Comerciales para la adquisición de los mismos.
- FIN DE DOCUMENTO -
5