Está en la página 1de 13

CÓDIGO:D-TI-15

Especificación Técnica Integración VERSIÓN: 06


Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Especificación
Técnica
Integración Nativa
Recurso Confiable con
Prestadores AVL / GPS.
Iron Tracking

Página 1 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

CÓDIGO DEL PÁGINAS FECHA DE


DESCRIPCIÓN VERSIÓN
DOCUMENTO AFECTADAS REVISIÓN
Primera versión de
Especificación
D-TI-15 - Técnica Integración 01 31/08/2019
Nativa RC con
Prestadores AVL
Se modificó el
evento “Battery” y
D-TI-15 Página 8 02 28/07/2020
se eliminó el evento
“Adress”
Se modifico el tipo
de dato
D-TI-15 Página 7 03 19/10/2020
“event.date” a
date.time
Se modificó el
control de retorno
D-TI-15 Página 11 04 16/12/2020
de IDJob a tipo
“Long” (int 64)
Se agregan URL del
D-TI-15 Página 4 y 5 05 10/03/2021
server QA
Se cambian
definicion de
D-TI-15 Página 5, 7 y 8 06 08/04/2021
parametros del WS
a minusculas

Página 2 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Glosario

Término Significado

Prestador Empresa de rastreo-seguimiento satelital AVL con dispositivos GPS o afines

Empresa Empresa u organización que solicita información sobre determinados móviles


Solicitante

Evento Información por reportar en la interfaz Prestador-Empresa Solicitante


independientemente de si es alarma (pánico) o simplemente un reporte de
posición por tiempo o distancia

Observaciones

Se expresa constancia que la arquitectura e interface que aquí se documenta pertenece a


las soluciones de Recurso Confiable S.A. de C.V., quien se reserva el derecho de modificar o
ajustar la misma en forma total o parcial a su solo criterio, en la medida que lo considere
necesario. Quienes utilizan esta interface reconocen que ante cualquier cambio deberán
ajustar sus productos o herramientas según lo requiera, sin ningún tipo de reclamo o
perjuicio para Recurso Confiable S.A. de C.V.

Página 3 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Contenido del Documento

Objetivo

El objetivo de este documento es explicar brevemente la interface de integración que


ofrece la plataforma de Soluciones Recurso Confiable para comunicarse con los
sistemas externos, dispositivos y plataformas que ofrecen las empresas prestadoras de
servicios de monitoreo y seguimiento satelital de vehículos. Esta interface se utiliza
principalmente para las Solución IronTracking.

Tecnología de Integración

Para la integración de la plataforma de Soluciones Recurso Confiable con otras


empresas prestadoras de servicios complementarios, como el caso de prestadores AVL /
GPS, se ha diseñado una arquitectura abierta, accesible, segura y compatible con las
tecnologías más utilizadas en la industria informática actualmente. Para ello, la interface
que ofrecemos se encuentra desarrollada bajo los estándares de Web Services y SOAP
según se describe en el presente documento.

Pruebas de la Interface

Para realizar pruebas y test de la interface aquí descrita, Recurso Confiable ofrece una
dirección (URL) con los servicios correspondientes disponibles (Web Services) para ser
consumidos por las aplicaciones y herramientas de los prestadores que requieran
realizar una integración con Recurso Confiable.

Dirección URL QA disponible:


http://integraciones.qa.rcontrol.com.mx/Tracking/wcf/RCService.svc
Dirección URL producción disponible:
http://gps.rcontrol.com.mx/Tracking/wcf/RCService.svc

Página 4 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Requisitos para Usar la Interface

Para poder utilizar la interface de integración Recurso Confiable entre los diferentes
prestadores de servicios y la empresa solicitante se deben cumplir los siguientes
requisitos básicos.

Usuario y Contraseña.
Acordar entre cada prestador y la empresa solicitante un identificador de usuario único y
una contraseña inicial. Dicha credencial será proporcionada por Recurso Confiable previa
solicitud por correo electrónico, en dicha solicitud se deberá de incluir Nombre y RFC del
prestador. La cuenta de correo para solicitar las credenciales es la siguiente:

soporte@recursoconfiable.com

Nota:El user que se proporcione será el mismo para QA y producción lo que cambiará
será la contraseña.

GetUserToken.
Método que se utiliza como autentificación, donde se proporcionan
únicamente las credenciales de acceso (usuario y contraseña), las cuales
serán proporcionadas por Recurso Confiable.

Descripción de los campos


Dato Descripción TAG-XML
Usuario Usuario que proporciona RC userId
para consumir el servicio
web
Contraseña Contraseña que proporciona password
RC para consumir el servicio
web
Request GetUserToken.

Página 5 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Response

En la respuesta de este método se encuentra la variable “token” con vigencia de 24hrs, la


cual es necesaria para poder consumir cualquier método adicional del servicio web
expuesto.

Página 6 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Uso de la Interface de Integración Recurso Confiable.

GPSAssetTracking
Una vez cumpliendo los requisitos básicos de obtener Usuario, Password y Token. La
interface se encuentra lista para procesar los eventos recibidos desde el prestador. A
continuación, se describen el principal método a utilizar: “GPSAssetTracking”.

El método “GPSAssetTracking” tiene como función guardar todos los pulsos (Evento)
que un dispositivo GPS reporte al sistema Iron Tracking, el cual debe de replicar pulsos
cada 5 minutos:

● Unidades Dedicadas: Compartir información 24/7.


● Unidades Spot: Compartir información únicamente durante el viaje.

El token previamente obtenido será solicitado para el consumo del método


“GPSAssetTracking”. EL método “GPSAssetTracking” es el principal y más utilizado en la
interface de integración, por lo cual resulta indispensable su correcta implementación
por parte del prestador para que la interface resulte confiable. Los parámetros que utiliza
el método son los que se describen a continuación.

Tipo de
Dato TAG-XML Descripción Condición Ejemplo
dato
Equivalente del código del
Código event.code Obligatorio Texto 1
evento del AVL*
Fecha del evento del pulso DateTime
emitido por GPS en con formato
2020-02-20
Fecha/Hora event.date formato UTC/GMT 0 con la Obligatorio (año, mes,
T13:15:22
siguiente estructura día, hr., min.
YYYY-MM-DDTHH:MM:SS y seg)
Latitud posición del evento
del pulso del GPS en Doble
Latitud event.latitude Obligatorio 28.2882
formato decimal como precisión.
mínimo 4 decimales
Longitud posición del
event.longitu evento del pulso del GPS Doble
Longitud Obligatorio -105.5069
de en formato decimal como precisión.
mínimo 4 decimales

Página 7 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Placa del vehículo a


integrar que cuenta con Dato
Placa event.asset dispositivo GPS sin Obligatorio Alfanuméric 123ABC
espacios, guiones o o
caracteres especiales
event.serialN
Número Número de serie del GPS Opcional Texto 0
umber
event.directio
Dirección Dirección actual del GPS Opcional Texto 0
n
Velocidad del vehículo del
Número
Velocidad event.speed evento del pulso del GPS Obligatorio 170
entero
(Km/hr)
Altitud del GPS del
Número
Altitud event.altitude vehículo del evento del Opcional 0
Entero
pulso GPS
event.custom Identificador de la empresa
Identificador Opcional Texto 0
er.id solicitante.
event.custom Nombre de la empresa
Nombre Opcional Texto 0
er.name transportista
Numero de viaje o
event.shipme identificador del viaje
Shipment Obligatorio Texto 0
nt utilizado por la empresa
solicitante
Numero de kilómetros
Odómetro event.odomet Número
registrados en el odómetro Opcional 0
er entero
del vehículo
Valor Booleano para
determinar si el vehículo
Ignición event.ignition Opcional True/ False True
se encuentra encendido
(True) o falso (False).
Valor del tipo entero (del 0
al 100) para reportar el Número
Batería event.battery Opcional 0
nivel de batería del entero
dispositivo
Valor de tipo Cardinal,
reporta la dirección hacia
Curso event.course Opcional Texto 0
donde se dirige el vehículo
ej. norte, sur...etc

Página 8 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

* Event.Shipment.

En este campo se debe de compartir el dato de numero de viaje asignado por el cliente
embarcador a la línea transportista. Este dato debe de ser capturado manualmente por
parte de la línea transportista, en un campo disponible en la plataforma del prestador
AVL/ GPS para que sea ligado a su unidad correspondiente una vez iniciado el viaje.

* Identificación de los Eventos Event.Code

El prestador debe informar a Recurso Confiable mediante un listado los códigos de


eventos que enviará a través de la interface explicando su significado. Si el prestador
enviará un evento con un código desconocido para la interface no podrá ser procesado
adecuadamente, y sino filtrado. Los códigos de los eventos pueden ser caracteres
alfanuméricos.
Ejemplo de un listado de Eventos:

Comando Descripción
PA Puerta conductor-abierta
123 Pánico
ABC Apaga cisterna
7 Robo
…. ….

En caso de no contar con la información de alguno de los eventos o parámetros


mencionados, se deberá enviar el campo en blanco o con un 0.

Página 9 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Request del método GPSAssetTracking

Página 10 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

Control del Retorno.

El retorno que se obtendrá de una inserción correcta de evento al WebService


será un tipo de dato Long (int 64).

ID Job Long (int64)

Response

Si no se realiza una inserción correcta se tendrá un mensaje de excepción los


cuales pueden ser los siguientes:

KEY MESSAGE
Usuario `usuario` no
SQL:USERUNK
encontrado.
CGI:UNKNOWN Error desconocido.
<a:idJob>0</a:idJob> IdJob en cero
Autenticación
Contraseña y/o usuario
incorrecta (Usuario,
incorrectos.
Contraseña o Token)

Página 11 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

La primera estructura se refiere a un error en la autentificación. (usuario o


contraseña erróneos).
Request

El tag “<a:exception>” contendrá toda la información del error. Para identificar


con mayor facilidad este error enviamos un “KEY” y un “message”.

Response

Página 12 | 13
CÓDIGO:D-TI-15
Especificación Técnica Integración VERSIÓN: 06
Nativa RC con Prestadores AVL FECHA DE EMISIÓN:28/07/2020

La siguiente estructura muestra un error en el envío de información por un


campo con formato incorrecto o un campo inválido.
Request.

Response

Página 13 | 13

También podría gustarte