FAQ : Méthodes de l'API Partenaire

Qu'est-ce que l'API Partenaire ?

L'API Partenaire GPS-Trace est un outil puissant qui permet aux entreprises d'intégrer des capacités avancées de suivi GPS dans leurs systèmes existants. Elle offre une variété de méthodes pour créer et gérer des comptes utilisateurs et des plans clients, configurer des unités, générer des rapports personnalisés et même télécharger des statistiques.

Comment puis-je authentifier mes demandes à l'API Partenaire ?

L'API Partenaire utilise l'authentification par jeton API pour garantir un accès sécurisé. Vous devez générer un jeton API à partir de votre compte, que vous utiliserez ensuite pour authentifier toutes vos demandes.

Quelles sont les fonctionnalités clés de l'API Partenaire ?

Les fonctionnalités clés de l'API GPS-Trace incluent :

• Gestion des comptes
• Gestion des entreprises
• Gestion des plans clients
• Gestion des unités
• Gestion des utilisateurs
• Gestion de la facturation

Comment puis-je gérer les utilisateurs avec l'API Partenaire ?

L'API Partenaire fournit des points de terminaison pour l'enregistrement et la gestion des utilisateurs. Vous pouvez créer de nouveaux comptes utilisateurs, mettre à jour les informations des utilisateurs, et gérer les plans clients ainsi que les ensembles de modules et de permissions pour garantir une base d'utilisateurs sécurisée et organisée.

Comment fonctionne la gestion des comptes ?

La sous-section CRUD des comptes couvre les méthodes liées aux opérations CRUD (Créer, Lire, Mettre à jour, Supprimer) pour les comptes, ce qui inclut :

• Création de comptes : Méthodes pour créer de nouveaux comptes dans le système.
• Suppression de comptes : Méthodes pour supprimer des comptes du système.
• Mise à jour de comptes : Méthodes pour mettre à jour les informations des comptes existants.
• Récupération des informations de compte : Méthodes pour obtenir les détails de comptes spécifiques.

Lors de la création d'un compte client, une application est attribuée au compte, accordant l'accès au client. Cela est mis en œuvre par une demande, l'un des champs obligatoires étant "reg_apps". Les ID des applications incluent :

• Ruhavik - 5a5ca87f-7cbe-4540-ab5d-77bf4bf69884
• Petovik - 962e19f0-6b4a-4f81-a3fe-4b657689b6f9
• Forguard - b901da51-ce00-4af2-b978-8d0fca8ae1ea

Les entités utilisateurs sont créées simultanément avec la création d'un compte client et sont initialement inactives. 

Pour activer le compte :

• le partenaire envoie un lien d'activation spécial à son client.
• En cliquant sur le lien d'activation, le client entre son adresse e-mail unique (à associer au compte) et un mot de passe.
• Le client reçoit ensuite un e-mail de confirmation d'inscription à l'adresse fournie. En suivant le lien dans l'e-mail, le client complète le processus d'inscription en entrant les informations demandées dans le formulaire, qui peuvent inclure le mot de passe, la clé de connexion, etc.

En conséquence, vous créez un nouvel utilisateur avec l'aide de notre API en quelques clics seulement.

Est-ce une API Partenaire ou une API pour la surveillance GPS ?

C'est définitivement une API partenaire basée sur les fonctionnalités de notre Partner Panel. Vous ne pouvez pas surveiller votre flotte via celle-ci. L'objectif principal est de gérer et de personnaliser les comptes clients et les unités, d'établir des tarifs, de gérer les analyses et l'historique. En utilisant notre API, vous pouvez intégrer notre plateforme partenaire avec votre CRM et votre système de facturation.

Comment cela peut-il bénéficier à mon entreprise ?

L'API Partenaire simplifie divers aspects opérationnels, tels que la gestion des véhicules, le suivi des actifs et la génération de rapports de données. En automatisant ces processus, les entreprises peuvent réduire les efforts manuels et augmenter la rentabilité avec facilité.

Puis-je accéder aux données de suivi historiques en utilisant l'API Partenaire ?

Oui, l'API Partenaire GPS-Trace permet d'accéder aux données de suivi historiques.
Ces données sont précieuses pour analyser les performances, enquêter sur les incidents et optimiser les opérations futures. Par exemple, vous pouvez utiliser la méthode “GET /partner/units/{id}/messages“ (Obtenir les messages de l'unité) pour récupérer les messages d'un appareil (unité) sur Forguard. Le nombre maximum de messages pouvant être récupérés est de 10 000, et vous pouvez également spécifier le nombre de messages récents que vous souhaitez obtenir.

Exemple de demande pour obtenir les 10 derniers messages :

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/messages?count=10' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

Les champs de la réponse dépendront des paramètres envoyés par le tracker.

Comment les rapports personnalisés peuvent-ils aider mon entreprise ?

Les rapports personnalisés vous permettent de générer des rapports détaillés en fonction de vos besoins spécifiques.
Ces rapports peuvent inclure des données sur l'utilisation et l'efficacité des véhicules, fournissant des informations précieuses pour la prise de décision et l'amélioration des stratégies commerciales. Par exemple, pour obtenir les dernières données de télémétrie de l'unité, vous devez utiliser la méthode “GET /partner/units/{id}/telemetry” (Obtenir les données de télémétrie).

Exemple de demande :

curl -X 'GET' \
  'https://api.gps-trace.com/partner/units/<unit id>/telemetry' \
  -H 'accept: application/' \
  -H 'X-AccessToken: <your token>'

En conséquence, vous téléchargerez un rapport avec le dernier message de télémétrie de chaque appareil que vous avez spécifié.

Comment puis-je commencer avec l'API Partenaire ?

Pour commencer avec l'API Partenaire, vous pouvez remplir le formulaire sur notre site web ou nous écrire à business@gps-trace.com