Contenu à ignorer
Français - Canada
Nous contacter
  • Aucune suggestion, car le champ de recherche est vide.

ShipTime offre-t-il une API pour l’intégration? 

Oui. ShipTime offre une API pour développeurs qui permet d’intégrer les fonctionnalités d’expédition de ShipTime directement à votre application ou à votre plateforme.

ShipTime propose un environnement Sandbox pour le développement et les essais ainsi qu’une API de production pour les activités d’expédition réelles.

Environnements API de ShipTime

API Sandbox

L’environnement Sandbox est conçu pour le développement et les essais avant le passage en production.

  • API REST utilisant l’authentification de base
  • Les points de terminaison commencent par /rest
  • Documentation Sandbox : API Sandbox de ShipTime

Pour demander des identifiants Sandbox, communiquez avec techsupport@shiptime.com.

Important : les tarifs et les services retournés dans Sandbox servent uniquement au développement. Ils ne représentent pas nécessairement les tarifs ou les services retournés en production.

API de production

L’API de production utilise l’authentification OAuth.

Selon l’article Freshdesk actuel, l’API de production permet notamment de :

  • Obtenir des tarifs d’expédition
  • Créer des expéditions et des étiquettes
  • Planifier des collectes
  • Suivre des colis

Documentation de production : API de production de ShipTime

Avant de commencer

ShipTime recommande de travailler avec un développeur qui connaît bien les API REST et les méthodes d’authentification.

Lors des essais dans Sandbox :

  • Ajoutez « Test booking Not for Pick up » dans le champ des instructions spéciales.
  • Sélectionnez Dépôt plutôt que Collecte lorsque vous testez uniquement les tarifs.
  • Si vous ajoutez une collecte, choisissez une date aussi éloignée que possible.
  • Annulez toutes les expéditions d’essai le jour même.

Comment activer une intégration API en production

  1. Connectez-vous à votre compte ShipTime.
  2. Accédez à Intégrations > Nouvelle Intégration.
  3. Sélectionnez API.  Cliquez sur le bouton +
  4. Sélectionnez Activez  l'intégration.
  5. Dans l’écran Gestion des intégrations API ShipTime, cliquez sur Creer un ID Client.
  6. Entrez un nom pour votre intégration, puis cliquez de nouveau sur Créer un ID Client.

  7. Copiez et conservez de façon sécuritaire votre ID Client et votre Secret API.



Important : le Secret API n’est affiché qu’une seule fois. Copiez-le et conservez-le en lieu sûr avant de fermer la fenêtre.

Fonctionnement de l’authentification en production

L’API de production utilise le flux d’identifiants client OAuth 2.0.

Demandez un jeton d’accès à :

POST https://restapi.shiptime.com/oauth2/token

Incluez :

  • grant_type=client_credentials
  • client_id
  • client_secret

Une fois le jeton obtenu, transmettez-le avec les requêtes API comme jeton Bearer dans l’en-tête Authorization.

L’article Freshdesk indique que les jetons d’accès sont valides pendant une heure et qu’aucun jeton d’actualisation n’est fourni avec le flux d’identifiants client. Lorsqu’un jeton expire, il faut en demander un nouveau.

Erreurs d’authentification courantes

L’article source indique les erreurs possibles suivantes :

  • 401 – invalid_client : le Client ID ou l’API Secret est manquant ou incorrect.
  • 400 – unsupported_grant_type : le grant_type n’est pas client_credentials.
  • 400 – invalid_request : un paramètre obligatoire est manquant ou vide.

Si vous recevez une erreur invalid_client, vérifiez vos identifiants et demandez un nouveau jeton avant de réessayer.

Bonnes pratiques pour les essais en production

Évitez autant que possible de créer des expéditions d’essai dans l’environnement de production. Des frais réels de transport pourraient s’appliquer.

Si un essai en production est nécessaire :

  • Sélectionnez Dépôt plutôt que Collecte lorsque vous testez uniquement les tarifs.
  • Vérifiez les tarifs et les suppléments du transporteur avant de créer une expédition.
  • Gardez à l’esprit que certaines actions du transporteur peuvent entraîner des frais dès qu’une collecte ou une livraison est mise en cours.

Besoin d’aide technique?

Pour toute question concernant les identifiants, l’authentification ou votre intégration API, communiquez avec l’équipe de soutien technique de ShipTime à techsupport@shiptime.com

Vous n’utilisez pas encore ShipTime? Créez votre compte ShipTime gratuitement pour accéder à des tarifs réduits auprès de transporteurs de premier plan, le tout sur une seule plateforme.