Qu’est-ce que la Platform API GPS-Trace ?
La Platform API est une interface logicielle destinée aux utilisateurs enregistrés de GPS-Trace Console. Elle permet à des systèmes externes, tels que des outils CRM, de facturation ou de reporting, de demander des données GPS-Trace et d’exécuter certaines opérations de Console.
L’API inclut des méthodes pour travailler avec les utilisateurs, les plans client, les unités, les données de facturation, les statistiques et les rapports.
Comment authentifier les requêtes API ?
Les requêtes API sont authentifiées à l’aide d’un jeton API. Un jeton est une clé d’accès générée dans GPS-Trace Console. Il doit être inclus dans chaque requête afin que la plateforme puisse vérifier quelles actions sont autorisées pour l’utilisateur.
Le jeton est envoyé dans l’en-tête de requête X-AccessToken.
Quels groupes de méthodes API sont disponibles ?
L’API inclut les groupes de méthodes suivants :
- Méthodes des données du compte
- Méthodes des données de l’entreprise
- Méthodes des plans client
- Méthodes des unités
- Méthodes des utilisateurs
- Méthodes des données de facturation
- Méthodes des statistiques et des rapports
Comment puis-je travailler avec les utilisateurs via l’API ?
La Platform API fournit des méthodes pour travailler avec les utilisateurs. En fonction des autorisations disponibles, les utilisateurs de Console peuvent créer des fiches utilisateur, mettre à jour les données utilisateur et attribuer des plans client, des modules et des autorisations.
Comment fonctionnent les méthodes des données du compte ?
La section compte inclut des méthodes pour créer, lire, mettre à jour et supprimer des données du compte. Ces actions sont souvent appelées opérations CRUD.
- Créer un compte
- Supprimer un compte
- Mettre à jour les données du compte
- Récupérer les données du compte
Lorsqu’un compte client est créé, la requête peut inclure l’application qui doit être attribuée au compte. Cela se fait via le champ reg_apps. Les applications disponibles dépendent du niveau d’accès de l’utilisateur et des conditions de l’accord.
Les fiches utilisateur sont créées en même temps que le compte client et restent inactives jusqu’à la fin du processus d’activation.
Pour activer le compte :
- L’utilisateur de Console envoie un lien d’activation au client.
- Le client suit le lien et saisit une adresse e-mail et un mot de passe.
- Le client confirme l’inscription via le lien de confirmation envoyé par e-mail.
- Après confirmation, le compte utilisateur devient actif conformément à l’application, au plan et aux autorisations attribués.
Cette API est-elle utilisée pour suivre directement des véhicules ?
L’API est destinée aux opérations de GPS-Trace Console et à l’échange de données avec des systèmes externes. Elle ne remplace pas l’application mobile Forguard ni d’autres interfaces de suivi GPS-Trace.
Les utilisateurs de Console peuvent utiliser l’API pour travailler avec les unités, les plans client, les statistiques, l’historique, les systèmes CRM et les systèmes de facturation, selon leur niveau d’accès.
À quoi peut servir l’API ?
La Platform API peut être utilisée pour connecter GPS-Trace à des systèmes CRM, de facturation, de reporting ou à des systèmes internes.
Par exemple, les utilisateurs de Console peuvent récupérer des données d’unité, travailler avec des plans client, exporter des statistiques et réduire les actions manuelles répétitives dans des flux de travail externes.
Puis-je accéder aux données historiques de suivi via l’API ?
Oui, la Platform API peut fournir un accès aux données historiques de suivi, selon les méthodes et les autorisations disponibles.
Par exemple, la méthode GET /partner/units/{id}/messages récupère les messages d’une unité. Le nombre maximal de messages pouvant être récupérés est de 10 000. Vous pouvez également spécifier le nombre de messages récents que vous souhaitez recevoir.
Exemple de requête pour obtenir les 10 derniers messages :
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//messages?count=10' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Les champs de la réponse dépendent des paramètres envoyés par le dispositif de suivi.
Comment puis-je récupérer des données de télémétrie ?
Pour obtenir les dernières données de télémétrie d’une unité, utilisez la méthode GET /partner/units/{id}/telemetry. La réponse contient le dernier message de télémétrie disponible pour l’unité spécifiée. Les champs exacts dépendent des données envoyées par le dispositif de suivi.
Exemple de requête :
curl -X 'GET' \
'https://api.gps-trace.com/partner/units//telemetry' \
-H 'accept: application/' \
-H 'X-AccessToken: '
Comment démarrer avec l’API ?
Pour demander l’accès à l’API, connectez-vous simplement à votre compte Console. Si vous n’en avez pas, vous pouvez aussi vous inscrire ici.