Description des fonctionnalités de l'API REST de ShipStation, comment générer des jetons d'accès et comment obtenir une assistance pour les problèmes liés à l'API REST.
Notre API REST est disponible pour tous les forfaits et permet un accès en lecture et en écriture : un accès en lecture à presque toutes les données de votre compte, et un accès en écriture pour créer des objets spécifiques, tels que Commandes, Clients et Produits. L'API est un excellent moyen d'obtenir des données directement vers et depuis ShipStation, notamment pour la création des commandes, l'ajout des clients ou la requête de données de commande et d'expédition.
ShipStation s'efforce de simplifier l'expédition pour les vendeurs en ligne, peu importe où ils vendent leurs produits en ligne. Nous ajoutons continuellement de nouvelles places de marché, des paniers d'achat et des outils d'intégration, car nous savons que le commerce électronique est en pleine croissance. C'est pourquoi nous nous sommes efforcés de fournir des ressources aux développeurs afin qu'ils puissent créer des intégrations personnalisées avec ShipStation. Consultez le portail des développeurs ShipStation pour obtenir des renseignements sur l'API REST de ShipStation.
Notre API permet aux développeurs de créer des applications qui s'interfacent avec la plateforme ShipStation. Vous pouvez utiliser l'API pour gérer de nombreuses tâches, notamment :
-
Gestion des commandes
-
Gestion des envois
-
Créer des étiquettes d'expédition
-
Récupérer des tarifs d'expédition
-
et plus encore!!!
Vous trouverez en annexe de cet article une feuille de calcul contenant les codes API de plusieurs de nos services d'expédition. Il inclut uniquement les codes de service pour les services d'expédition accessibles au public.
La récupération des tarifs d’expédition n'est peut-être pas disponible pour certains transporteurs et services.
Certains transporteurs et services pour certains transporteurs ne sont peut-être pas disponibles pour récupérer les tarifs d'expédition par le biais des appels GetraRate. Par exemple, les appels GETRate ne renverront pas les tarifs utilisables pour UPS Surepost®. Pour assurer le succès, vérifiez d’abord auprès de votre transporteur pour savoir lequel de ses services d’expédition disponibles prennent en charge la navigation des tarifs.
Pour utiliser l'API de ShipStation, vous devez générer une clé API et un secret qui seront inclus avec tous les appels passés à l'API. La clé et le secret sont utilisés pour authentifier les appels API afin que ShipStation mette à jour les informations de votre compte spécifique.
Les nouveaux comptes ont accès après 48 heures
Pour des raisons de sécurité, il a une période d'attente de 48 heures après votre inscription à un compte ShipStation avant de pouvoir générer des clés API.
Pour un accès plus rapide ou des demandes urgentes pendant la période d'attente initiale de 48 heures, n'hésitez pas à contacter votre gestionnaire de compte d'essai pour obtenir de l'aide.
-
Cliquez sur Générer de nouvelles clés API si aucune clé et aucune clé secrète ne sont répertoriés.
-
Copiez votre clé et la clé secrète.
Vous pouvez ensuite leur fournir le compte auquel vous souhaitez accéder à l'API ShipStation.
Une fois les clés API générées, vous pourrez les copier depuis cette page et les fournir selon les besoins à tous les développeurs d'API.
Votre compte ShipStation ne peut émettre qu'un seul ensemble de clés API à la fois. Le même ensemble de clés API peut être utilisé pour plusieurs applications API. Si vous générez de nouvelles clés à tout moment, assurez-vous de fournir les nouvelles clés à toute application qui les utilise, sinon la connexion avec ShipStation ne fonctionnera plus.
Il n'est pas possible de limiter la portée de l'accès API pour le moment. Si un développeur d'API a accès à votre clé et à votre secret, il pourra effectuer toutes les actions de l'API ShipStation disponibles.
Avant de commencer à utiliser l'API de ShipStation, nous vous recommandons vivement de consulter le portail des développeurs ShipStation pour obtenir un aperçu complet de toutes les actions pouvant être effectuées par le biais des appels API. Cette documentation vous fournit également des exemples d'appels et de réponses pour la communication API, ainsi que des informations détaillées sur la façon d'authentifier votre clé et votre secret API pour les appels API.
L'équipe d'assistance de ShipStation ne peut pas vous aider à concevoir ou à construire une intégration API, mais nous pouvons certainement vous aider à tester les appels API et à vous assurer que tout fonctionne comme prévu, ou vous aider à identifier les informations dans le corps de l'appel qui provoqueraient des erreurs. Si vous rencontrez des problèmes avec un ou plusieurs de vos appels API et que vous avez besoin d'aide, envoyez un courriel à notre équipe d'assistance API directement à l'adresse apisupport@shipstation.com et notre équipe examinera le problème avec vous.
Limites de l'API ouverte de ShipStation
-
L'API ouverte de ShipStation ne prend pas en charge la fonction Réexpédier une commande.
-
L'API ouverte de ShipStation ne reconnait pas les jeux de caractères non romains comme le japonais, le chinois et le cyrillique. Ces jeux ne sont souvent pas reconnus par l'API d'étiquette du transporteur, ce qui entraîne des symboles ??? ou des espaces vides sur l'étiquette où les caractères devraient être.
Afin de mieux vous aider, assurez-vous d’inclure les informations suivantes :
-
L’action API que vous essayiez d’effectuer (par exemple, Lister les expéditions, Créer des commandes, etc.)
-
Le point de terminaison API complet que vous contactiez (ex : https://ssapi.shipstation.com/shipments?orderNumber=zen-285858-1)
-
S'il s'agit d'un appel API POST, le corps JSON complet de la demande.
-
Le numéro du code d'état de la réponse de l'API.
-
La réponse JSON complète à l'appel API.
Soutien pour les questions relatives à l'API
Sans les informations ci-dessus, il peut être difficile pour ShipStation de résoudre les problèmes d'API. Si vous ne savez pas comment obtenir ces informations, nous vous recommandons de contacter directement votre développeur d'API pour obtenir de l'aide afin d'extraire les journaux disponibles. Nous vous recommandons également de contacter votre développeur API pour toute communication à l'adresse apisupport@shipstation.com.