Guide de démarrage rapide de l'API REST

Ce guide est un bref aperçu de la façon de se connecter à l'API REST et de l'utiliser avec le portail de gestion de flotte IntelliHub.

Vue d'ensemble

Les services Web de Forward Thinking Systems offrent aux clients une méthode sécurisée pour interagir avec leurs données à l'aide de Swagger et de notre API REST. L'accès aux services Web de FTS est gratuit pour le client.

Actuellement, Forward Thinking propose deux API REST : une API Intellihub et une autre pour FleetCam. L'API Intellihub permet notamment de modifier les informations sur les actifs ou les conducteurs, de consulter l'historique des emplacements, de répartir les arrêts ou d'envoyer des messages. L'API FleetCam permet aux clients d'extraire des séquences d'événements, de lire des flux historiques ou en direct, de télécharger des vidéos, etc.

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

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

Références et authentification

Le client doit demander l'accès à l'API à Forward Thinking Systems Support ([email protected]). À la réception de la demande, FTS aura besoin des informations suivantes concernant l'utilisateur de l'API qui doit être créé :

• IP ou série d'IP à partir desquelles votre application se connectera à nos services (voir ci-dessous)
• Quelle(s) API le client souhaite-t-il que l'utilisateur ait accès ?
• les installations ou les groupes auxquels le client souhaite que l'utilisateur ait accès

Les clients doivent utiliser les informations d'identification fournies pour générer un jeton d'authentification par porteur à l'aide de l'API REST. Le jeton sera actif pendant une heure après avoir été généré, puis il devra être généré à nouveau pour continuer à faire des appels à l'API.

Adresses IP statiques

Une adresse IP statique ou une série d'adresses IP est nécessaire pour accéder à notre API REST, à des fins d'inscription sur la liste des autorisations. Si vous utilisez AWS, Azure, OCI ou tout autre fournisseur de services en nuage, assurez-vous d'avoir une IP statique pour la ressource qui accède à notre API. AWS, Azure et OCI appellent ce type de ressource une passerelle NAT. D'autres fournisseurs peuvent lui donner un autre nom (par exemple, Google l'appelle Cloud NAT).

Pour plus d'informations sur 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

Limitation du taux

Sachez que notre API est protégée par un pare-feu d'application Web (WAF) qui utilise différents niveaux de limitation de débit sur tous les points d'extrémité. Si vous rencontrez une erreur 429 ou similaire lors de vos appels API et que vous n'en connaissez pas la raison, veuillez contacter le service d'assistance et nous pourrons vous aider.

Exemple d'appel

Dans cet exemple, nous ferons un appel de flux historique à l'API FleetCam. N'oubliez pas que pour diffuser des vidéos historiques à partir d'un véhicule, celui-ci doit être allumé et connecté au réseau.

• POST : /authentification/token - Générer un jeton d'accès à l'aide de vos informations d'identification
• Autoriser en utilisant le jeton - Dans Swagger, l'authentification se fait via le bouton Authorize en haut à droite de la page. D'autres clients API peuvent avoir un écran spécifique pour l'authentification.
• GET : /véhicules - Obtenir la liste des véhicules sur le compte. Vous aurez besoin de l'identifiant du véhicule de l'actif pour effectuer l'appel POST /historicalstream.
• GET : /véhicules/état - À l'aide de l'identifiant du véhicule, assurez-vous que le véhicule à partir duquel vous souhaitez obtenir un flux est actuellement allumé.
• POST : /historicalstream - À l'aide de l'identifiant du véhicule, créer une demande de flux historique. Cet appel renverra l'identifiant du flux historique.
• GET : /historicalstream/status{historicalStreamLogId} - Obtenir l'URL de l'identifiant du flux historique que vous avez créé
• PUT : /historicalstream/extend/{historicalStreamLogId} - Prolonger votre flux historique actuel
• DELETE : /historicalstream/terminate/{historicalStreamLogId} - Arrêter le flux historique en cours