Guía de inicio rápido de la API REST

Esta guía es un breve resumen de cómo conectarse y utilizar la API REST con el portal de gestión de flotas IntelliHub.

Visión general

Los Servicios Web de Forward Thinking Systems ofrecen un método seguro para que los clientes interactúen con sus datos utilizando Swagger y nuestra API REST. El acceso a los servicios web de FTS no supone ningún coste adicional para el cliente.

Actualmente, Forward Thinking ofrece dos API REST: una API Intellihub y otra para FleetCam. Algunas de las funciones de la API Intellihub son la posibilidad de modificar la información sobre activos o conductores, consultar el historial de ubicaciones, enviar paradas o enviar mensajes. La API de FleetCam permite a los clientes extraer secuencias de eventos, reproducir secuencias históricas o en directo, descargar vídeos y mucho más.

Intellihub: https://rest.ftsgps.com/intellihubapi/console/#/

FleetCam: https://rest.fleetcam.io/videoapi/console/#/

Credenciales y autenticación

El cliente debe solicitar el acceso a la API a Forward Thinking Systems Support (support@ftsgps.com). Al recibir la solicitud, FTS necesitará la siguiente información sobre el usuario de la API que se va a crear:

• IP o rango de IPs desde las que su aplicación se conectará a nuestros servicios (ver más abajo)
• A qué API(s) quiere el cliente que tenga acceso el usuario
• A qué instalaciones o grupos quiere el cliente que tenga acceso el usuario

Los clientes deben utilizar las credenciales proporcionadas para generar un token de autenticación de portador utilizando la API REST. El token estará activo durante una hora tras su generación; después, deberá generarse de nuevo para seguir realizando llamadas a la API.

Direcciones IP estáticas

Se requiere una IP estática o un rango de IPs para acceder a nuestra API REST, a efectos de la lista de permitidos. Si utiliza AWS, Azure, OCI o cualquier otro proveedor en la nube, asegúrese de que dispone de una IP estática para el recurso que accede a nuestra API. AWS, Azure y OCI llaman a este tipo de recurso NAT Gateway. Otros proveedores pueden tener otro nombre para él (por ejemplo, Google lo llama Cloud NAT)

Para más información sobre AWS, Azure, OCI:

Amazon AWS
https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html

Microsoft Azure
https://learn.microsoft.com/en-us/azure/nat-gateway/nat-overview

Infraestructura en la nube de Oracle
https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/NATgateway.htm

Limitación de velocidad

Tenga en cuenta que nuestra API está protegida por un cortafuegos de aplicaciones web (WAF) que utiliza varios niveles de limitación de velocidad en todos los puntos finales. Si se encuentra con un error 429 o similar al realizar llamadas a la API y no está seguro del motivo, póngase en contacto con el servicio de asistencia y le ayudaremos.

Ejemplo de llamada

En este ejemplo, haremos una llamada a la API de FleetCam. Tenga en cuenta que para transmitir vídeo histórico desde un vehículo, éste debe estar encendido y conectado a la red.

• POST: /autenticación/token - Genere un token de acceso utilizando sus credenciales
• Autorizar utilizando el token - En Swagger, esto se consigue a través del botón Autorizar situado en la parte superior derecha de la página. Otros clientes API pueden tener una pantalla específica para la autenticación.
• GET: /vehículos - Obtener la lista de vehículos de la cuenta. Necesitarás el vehicleID del activo para realizar la llamada POST /historicalstream.
• GET: /vehículos/estado - Utilizando la ID del vehículo, asegúrese de que el vehículo del que desea extraer un flujo está encendido.
• POST: /historicalstream - Utilizando el ID del vehículo, cree una solicitud de flujo histórico. Esta llamada devolverá el ID del flujo histórico.
• GET: /historicalstream/status{historicalStreamLogId} - Obtenga la URL del identificador de flujo histórico que ha creado
• PUT: /historicalstream/extend/{historicalStreamLogId} - Amplíe su flujo histórico actual
• DELETE: /historicalstream/terminate/{historicalStreamLogId} - Detener el flujo histórico en curso