Comment fonctionnent les API de ShippyPro et comment les intégrer

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.

Sommaire:

1. Avant de commencer
2. L'API ShippyPro
3. Comment puis-je tester l'API ShippyPro ?
4. Comment fonctionne la validation des champs de l'API ?
5. Erreurs et dépannage

1. Avant de commencer

Pour commencer à utiliser l'API ShippyPro, vous devez d'abord :

1. Créer un compte ShippyPro en cliquant ici. Si vous souhaitez savoir comment créer un compte étape par étape, cliquez ici.

2. Connecter votre compte de transporteur depuis Transporteurs et terminez la configuration du transporteur. Pour plus de détails, veuillez lire l'article correspondant ici.

3. 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.

4. 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.

Conditions du forfait et apps tierces de points de retrait

Vous avez besoin d'une clé API pour une app tierce de points de retrait ? Vérifiez d'abord que votre abonnement ShippyPro comprend l'accès à la section API, les appels API et la génération de clés API.

Vous pouvez passer vous-même à un forfait supérieur depuis Plans dans votre compte. Pour les tarifs et la gestion de votre forfait, consultez ShippyPro Tarifs, Paiements et Plans.

Par exemple, Globe Pick Up est une app tierce avec ses propres tarifs qui permet à vos clients de sélectionner un point de retrait au checkout. Elle nécessite l'accès aux API de ShippyPro pour transmettre à ShippyPro les informations sur le point sélectionné.

Pour les expéditions vers un point de retrait, consultez Comment ajouter un point de retrait à mes envois ?

Comment générer votre clé API

Vous pouvez ajouter plus d'une clé API directement depuis votre profil ShippyPro. Suivez ces étapes simples :

• Cliquez sur API
• Cliquez sur Ajouter une API et la clé API se formera automatiquement.

Type d'API

Vous pouvez choisir les fonctionnalités pour vos clés API depuis ce menu déroulant


Accès complet: la clé API peut être utilisée pour toutes les fonctionnalités de l'API (expéditions, récupération des tarifs, accès aux cartes Ship&Collect, etc.)

Cartes: la clé API peut seulement être utilisée pour afficher la carte PUDO pour les fonctionnalités Ship&Collect

PII Exclu: toutes les Informations Personnelles seront masquées par cette clé (noms, adresses, numéros de téléphone, etc.)

2. API ShippyPro

Grâce à notre solution API, vous pouvez faire communiquer tous vos systèmes (tels que OMS, WMS, POS, ERP et bien d'autres) avec vos transporteurs à l'aide d'une simple intégration API.

Notre API est écrite dans 14 langages de programmation et dans deux technologies différentes, REST et SOAP.
Chaque appel à l'API a sa propre méthode : selon les dernières mises à jour, nous n'acceptons actuellement que la méthode POST.

Vous trouverez votre clé API en cliquant sur API.

Une fois que vous avez copié votre clé API, suivez les étapes expliquées ici : Documentation API > Authentification. 

Pour tester des requêtes dans la documentation API, saisissez la clé API de votre compte dans le paramètre d'authentification correspondant. Consultez la section Comment puis-je tester l'API de ShippyPro ? ci-dessous.

Combien d'appels API puis-je effectuer simultanément ?

Avec ShippyPro, vous pouvez effectuer un maximum de 20 appels d'API toutes les 10 secondes.

Cela signifie que vous pouvez effectuer 10 appels d'API en une seconde, mais qu'il ne vous restera plus que 10 appels d'API pour les neuf secondes suivantes.

Lorsque les demandes dépassent cette limite, l'API renvoie l'erreur suivante : Erreur : 429 Too Many Requests.

Nous vous suggérons également d'utiliser différentes adresses IP et d'appliquer une logique d'équilibreur de charge afin de dépasser cette limite.

Si vous souhaitez augmenter cette limite, veuillez contacter sales@shippypro.com pour obtenir un devis.


 

Dans la section 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.

3. Comment puis-je tester l'API de ShippyPro ?

Vous souhaitez tester une requête API ? L'ancienne console API a été retirée. Vous pouvez tester les appels directement dans la documentation API ou utiliser un logiciel externe qui prend en charge les appels API.

Comment tester une requête dans la documentation API ?

Les tests nécessitent la clé API de votre compte, disponible dans la section API de votre compte ShippyPro.

1. Ouvrez la documentation API.
2. Sélectionnez l'endpoint que vous souhaitez tester.
3. Cliquez sur Test request.
4. Saisissez votre clé API dans le paramètre d'authentification correspondant.
5. Saisissez les données requises pour la requête.
6. Lancez le test et examinez la réponse.

Que vérifier si le test renvoie une réponse 401 ?

Vérifiez d'abord que vous avez saisi votre clé API dans le paramètre d'authentification correspondant. Il s'agit d'une première vérification : une clé manquante n'est pas nécessairement la cause de cette réponse.

Pour un dépannage plus général, consultez Comment corriger les erreurs de l'API.

[SCREENSHOT: documentation API avec un endpoint sélectionné et le bouton Test request]

Vous pouvez tester notre API en utilisant Generic comme transporteur. Nous avons créé ce transporteur afin de tester toutes les fonctionnalités de ShippyPro.

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.

Qu'est-ce qui est pris en compte dans un appel API correct ?

En bref, seuls les envois générés par l'appel Ship seront comptabilisés, et donc uniquement ceux qui ont été correctement générés. Ceux qui ont fait l'objet d'une erreur ne seront pas pris en compte.
L'appel GetRates affiche simplement les prix et les options de l'envoi, c'est pourquoi il ne concerne pas le décompte des envois.
De plus, les commandes comportant une erreur ne seront pas comptabilisées comme un envoi en bonne et due forme.

4. Comment fonctionne la validation des champs API

Vous pouvez décider d'appliquer l'option de validation des champs de l'API que vous préférez à tout moment à partir du compte API.

Vous pouvez choisir entre trois options différentes, voyons-les !

• Activer le blocage du contrôle de validation sur tous les champs des requêtes API: Si vous souhaitez empêcher l'envoi de l'appel API en cas de données manquantes ou d'API non valide, vous pouvez sélectionner cette option pour bloquer la génération de l'appel. De cette manière, une erreur se produira dans la demande.
• NE PAS BLOQUER mais inclure les suggestions de validation des champs dans les réponses de l'API: L'appel API sera tout de même envoyé, accompagné de conseils utiles pour identifier les erreurs rencontrées.
• NE PAS BLOCER et NE PAS INCLURE de suggestions de validation dans les réponses de l'API: ne bloque pas l'appel et n'affiche pas de suggestions pour l'erreur.

  Pour empêcher l'expédition malgré des erreurs de validation, activez l'option Activer le blocage du contrôle de validation sur tous les champs des requêtes API. Cela permet d'éviter la génération d'étiquettes vides dans les réponses.

5. Erreurs et dépannage

Cliquez sur ce lien pour consulter les erreurs et les résolutions les plus courantes concernant l'API :

Comment corriger les erreurs de l'API