L'API ShippyPro est le moyen le plus simple d'intégrer à votre système plus de 140 transporteurs dans le monde entier pour expédier vos colis.
Voyons comment les API fonctionnent étape par étape 🔍
1. Que faire en premier lieu
Pour commencer à utiliser l'API ShippyPro, vous devez d'abord :
Créer un compte ShippyPro en cliquant ici. Si vous souhaitez savoir comment créer un compte étape par étape, cliquez ici.
Après avoir configuré votre profil ShippyPro, lisez attentivement notre documentation API. Vous y trouverez toutes les informations dont vous avez besoin pour utiliser notre API.
Vous pouvez décider d'activer un dossier de commandes API pour gérer facilement vos commandes API directement depuis la plateforme, découvrez ici comment faire.
📌 N'oubliez pas de jeter un coup d'œil à notre API Marketplace afin d'importer tous les détails de votre commande dans ShippyPro.
2. API ShippyPro
Nos API sont écrites pour être RESTful.
Vous trouverez votre clé API en cliquant sur Intégrations > API.
Une fois que vous avez copié votre clé API, suivez les étapes expliquées ici :
Documentation API > Authentification.
N'oubliez pas de définir l'appel API comme suit :
Clé API comme nom d'utilisateur
Laissez le mot de passe vide
3. Appels API de ShippyPro
Voici les requêtes API les plus utilisées :
- GET RATES
L'API RATE de ShippyPro vous permet d'obtenir les tarifs de tous vos transporteurs classés par prix avec une simple requête API. La réponse comprendra également une estimation des jours de livraison.
📌 Les tarifs dépendront de ceux inclus dans le contrat avec le transporteur,
voici comment les ajouter.
- SHIP
Ship vous permet de générer des étiquettes en fonction de vos paramètres d'étiquetage pour tous les transporteurs pris en charge.
📌 Note : N'oubliez pas que les appels d'expédition et de modification génèrent de VRAIES étiquettes d'expédition qui seront comptées dans les 30 fournies
chaque mois. Nous vous suggérons d'utiliser un transporteur
générique pour tester ces appels.
📌 Note : Veuillez noter que les valeurs CarrierName, CarrierService et CarrierID doivent être ajoutées depuis ici.
N'oubliez pas que si vous mettez Async = true, vous devrez utiliser un Webhook pour générer une étiquette.
- TRACKING
Grâce à cette API, vous pouvez suivre vos envois et être notifié à un webhook chaque fois que votre envoi reçoit un nouveau statut.
Découvrez tous nos appels API dans notre section Aide dédiée !
Depuis Intégrations > API, cliquez sur Afficher les journaux de l'API pour voir les demandes et les réponses en direct de manière plus détaillée.
En cliquant sur Erreurs API, il est possible de consulter tout l'historique des erreurs rencontrées.
Par le biais des journaux Webhook, en insérant votre terminal, vous serez informé des changements d'état de livraison et vous pourrez accéder à des informations utiles sur les mises à jour de suivi
📌 Les fichers API (Request + Response) et Webhook sont au format Json.
4. Comment puis-je tester l'API de ShippyPro ?
Vous pouvez tester notre API en utilisant Generic comme transporteur. Nous avons créé ce transporteur afin de tester toutes les fonctionnalités de ShippyPro.
📌 Note : Generic n'est pas un vrai transporteur, il ne génèrera aucun numéro de suivi réel. Pour savoir comment utiliser le transporteur générique, cliquez ici.