L’API Sygic FleetWork vous permet de connecter votre système ou celui de tiers à Sygic FleetWork. Toutes les fonctions peuvent être utilisées directement à partir de votre système et toutes les informations peuvent être renvoyées de Sygic FleetWork à votre système. De cette façon, vous pouvez utiliser votre système au lieu du portail web FleetWork.

Clé API

Pour être en mesure d’intégrer votre système avec FleetWork, vous devez d’abord générer votre propre clé API. Une fois que vous l’avez généré, vous pouvez utiliser l’aide interactive.

Pour toute opération avec la clé API, vous devez être connecté à Sygic FleetWork (https://www.fleetwork.com). Si vous ne possédez pas de compte, vous pouvez en créer un gratuitement.

Pour obtenir votre clé API, allez à:
Réglages -> Gérer les clés API -> Créer une nouvelle clé API

Votre nouvelle clé API est créée. Vous pouvez générer autant de clés API que vous le souhaitez. Plusieurs clés API peuvent être utilisées par exemple pour différencier les utilisateurs qui ont créé les appels.

Cliquez sur Essayer à côté de la clé API pour ouvrir la documentation interactive de l’API où vous trouverez toutes les méthodes API.
Pour supprimer votre clé API, appuyez sur le bouton Supprimer la clé API à côté de la clé que vous souhaitez supprimer.

Aide interactive de l’API

Le but de ce document est de vous guider à travers l’aide interactive en ligne, qui décrit toutes les fonctionnalités de l’API.

Il existe deux façons d’accéder à l’aide interactive de l’API:

  • Cliquez Essayer à côté d’une clé API
  • Cliquez sur ce lien pour ouvrir la documentation interactive de l’API. Dans ce cas, vous devez coller votre clé API dans la zone de texte de la clé API et cliquer sur Explore pour être en mesure d’essayer les méthodes.

Exemple d’appel d’une clé API

À titre d’exemple, nous allons utiliser la méthode facile pour obtenir tous les conducteurs dans votre organisation.
Collez votre clé API dans le champ Your API key pour être en mesure d’essayer les méthodes avec des données de votre compte.

Cliquez Try out, le résultat apparaît:

Vous pouvez voir Request URL. Ceci est l’URL que vous avez devez demander à partir de votre application pour obtenir le résultat. Comme vous pouvez le voir, il contient également votre clé API.

Response Body contient les données que vous avez demandé au format JSON, dans ce cas, tous les conducteurs de votre organisation.
Le code de réponse 200 signifie que tout s’est bien passé. Tous les codes de réponse sont décrits dans un tableau ci-dessous.

Appels et réponses API

Appels API

Vous pouvez utiliser 2 façons pour appeler l’API. N’oubliez pas d’utiliser votre clé API.

  1. HTTP HEADER: “X-api_key”:”[your API key]”
  2. https://api.jobdispatch.sygic.com/api/v1/API_method?api_key=your API key

Réponses de l’API

La réponse se compose du corps de la réponse, du code de la réponse et des en-têtes de la réponse.

  • Response Body est ce que vous demandé et est généralement au format JSON.
  • Response Code vous indique si votre appel d’API a réussi et ce qui a échoué.
  • Response Header définit le format des données.

Codes de réponse

Nous utilisons plusieurs codes d’état HTTP pour afficher le résultat de votre appel

Response code Signification du code de réponse
200 OK – Tout est OK.
204 OK – Tout est OK. Le serveur n’envoie pas les données. Cette réponse est utilisée après la suppression d’une entité.
400 BadRequest – entrée incorrecte ou clé API erronée.
401 Unauthorized – clé API erronée ou vous n’êtes pas autorisés à utiliser l’API.
404 NotFound – L’entité n’a pas été trouvée.

Réaction

Était-ce utile?

Oui Non
Vous avez indiqué que ce sujet ne vous a pas été utile ...
Pouvez-vous SVP laisser un commentaire nous disant pourquoi? Merci!
Merci pour vos commentaires.

Laissez votre avis sur ce sujet.

Valider