REST API quick start guide

This guide is a short overview of how to connect to and use the REST API with the IntelliHub fleet management portal.

Overview

Forward Thinking Systems’ Web Services offer a secure method for customers to interact with their data using Swagger and our REST API. Access to FTS’ Web Services comes at no additional cost to the customer.

Currently, Forward Thinking offers two REST APIs: an Intellihub API and another for FleetCam. Some features of the Intellihub API include the ability to modify asset or driver information, pull location history, dispatch stops, or send messages. The FleetCam API allows customers to pull event footage, play historical or live streams, download videos, and more.

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

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

Credentials & Authentication

A customer must request access to the API from Forward Thinking Systems Support ([email protected]). Upon receiving the request, FTS will need the following information regarding the API user that is to be created:

• IP or range of IPs your application will be connecting from to our services (see below)
• Which API(s) the customer wants the user to have access to
• Which facilities or groups the customer wants the user to have access to

Customers must use the credentials provided to generate a Bearer Authentication token using the REST API. The token will be alive for one hour after it is generated, then it must be generated again to continue making calls to the API.

Static IP Addresses

A static IP or Range of IPs is required to access our REST API, for allow-listing purposes.  If you are using AWS, Azure, OCI, or any other cloud provider, make sure you have a static IP for the resource accessing our API.   AWS, Azure, and OCI all call this type of resource a NAT Gateway.  Other providers may have another name for it (e.g. Google calls it Cloud NAT)

For more information on 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

Oracle Cloud Infrastructure
https://docs.oracle.com/en-us/iaas/Content/Network/Tasks/NATgateway.htm

Rate Limiting

Be advised our API is protected by a Web Application Firewall (WAF) which utilizes various levels of rate limiting on all endpoints. If you encounter a 429 or similar error when making API calls and are not sure why, please contact Support and we can assist.

Example Call

In this example, we will be making a historical stream call to the FleetCam API. Bear in mind that to stream historical video from a vehicle, the vehicle must be turned on and connected to the network.

• POST: /authentication/token – Generate an access token using your credentials
• Authorize using the token – In Swagger, this is accomplished via the Authorize button at the top-right of the page. Other API clients may have a specific screen for authentication.
• GET: /vehicles – Get the list of vehicles on the account. You’ll need the asset’s vehicleID to make the /historicalstream POST call.
• GET: /vehicles/status – Using the vehicleID, ensure the vehicle you want to pull a stream from is currently turned on.
• POST: /historicalstream – Using the vehicleID, create a request a historical stream. This call will return the historical stream’s ID.
• GET: /historicalstream/status{historicalStreamLogId} – Get the URL for the historical stream ID you created
• PUT: /historicalstream/extend/{historicalStreamLogId} – Extend your current ongoing historical stream
• DELETE: /historicalstream/terminate/{historicalStreamLogId} – Stop the ongoing historical stream