Description des capacités de l'API REST de ShipStation, comment générer des jetons d'accès et comment obtenir de l'aide pour les problèmes liés à l'API REST.
Notre API REST est disponible avec tous les forfaits et permet un accès en lecture et écriture : accès en lecture à presque toutes les données de votre compte ainsi qu'un accès en écriture pour créer des objets spécifiques, comme les commandes, les clients et les produits. L'API est un excellent moyen d'obtenir des données directement depuis et vers ShipStation, surtout lorsque vous créez des commandes, ajoutez des clients ou interrogez vos données de commande et d'expédition.
ShipStation s'efforce de rationaliser l'expédition pour les vendeurs en ligne, quel que soit l'endroit où ils vendent leurs produits en ligne. Nous ajoutons continuellement de nouvelles plateformes marchandes, des paniers d'achat et des outils d'intégration, car nous savons que l'espace e-commerce est en plein essor. Par conséquent, nous avons travaillé dur pour fournir aux développeurs les ressources dont ils ont besoin pour créer des intégrations personnalisées avec ShipStation. Consultez le portail développeur ShipStation pour obtenir une documentation complète sur l'API REST de ShipStation.
Notre API permet aux développeurs de créer des applications qui font interface avec la plateforme ShipStation. Vous pouvez utiliser l'API pour gérer de nombreuses tâches, notamment :
-
Gérer les commandes
-
Gérer les expéditions
-
Création d'étiquettes d'expédition
-
Récupération des tarifs d'expédition
-
et plus encore !
Jointe à cet article, vous trouverez pour référence une feuille de calcul avec les codes API de plusieurs de nos services d'expédition disponibles. Elle inclut uniquement les codes correspondant aux services d'expédition accessibles au public.
Pour utiliser l'API de ShipStation, vous devez générer une clé API et un secret qui seront inclus dans tous les appels d'API. La clé et le secret servent à authentifier les appels d'API afin que ShipStation mette à jour les informations de votre compte.
Les nouveaux comptes obtiennent l'accès après 48 heures
Pour des raisons de sécurité, il y 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 besoins urgents 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 vous ne voyez apparaître aucune clé ni aucun secret.
-
Copiez votre clé et votre secret.
Vous pouvez ensuite les associer au compte avec lequel vous souhaitez accéder à l'API de ShipStation.
Une fois que les clés API ont été générées, vous pouvez les copier sur cette page et les fournir, si nécessaire, à tout développeur 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, à quelque moment que ce soit, vous générez de nouvelles clés, assurez-vous de fournir les nouvelles clés à toute application qui les utilise, sans quoi la connexion avec ShipStation ne fonctionnera plus.
Il n'existe actuellement aucun moyen de limiter l'ampleur de l'accès à l'API. Si un développeur d'API a accès à votre clé et à votre secret, il pourra effectuer toutes les actions d'API ShipStation disponibles.
Avant de vous lancer dans l'utilisation de l'API de ShipStation, nous vous recommandons vivement de consulter le portail des développeurs de ShipStation. Vous y trouverez une présentation complète de toutes les actions qui peuvent être effectuées avec les appels d'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é d'API et votre secret pour les appels d'API.
L'équipe d'assistance de ShipStation n'est pas en mesure de vous aider à concevoir ou à construire une intégration d'API, mais peut parfaitement vous aider à tester les appels d'API et à vous assurer que tout fonctionne comme prévu ou vous aider à identifier les informations dans le corps de l'appel qui pourraient provoquer 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 e-mail à notre équipe d'assistance API directement à l'adresse apisupport@shipstation.com et notre équipe examinera le problème avec vous.
Pas de prise en charge pour les ensembles de caractères Kanji, cyrillique et autres caractères non romains
L'API Open de ShipStation ne prend pas en charge les jeux de caractères non romains comme le japonais, le chinois et le cyrillique. De même, il arrive souvent que ces caractères ne soient pas pris en charge par l'API du transporteur qui gère les étiquettes, ce qui se traduit par des symboles ??? ou des espaces vides sur l'étiquette à la place des caractères.
Pour mieux vous aider, assurez-vous d'inclure les informations suivantes dans votre message :
-
L'action de l'API que vous avez essayé d'exécuter (par exemple : Faire la liste des expéditions, Créer des commandes, etc.)
-
Le terminal d'API complet que vous avez contacté (par exemple : 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 pour la réponse de l'API.
-
La réponse JSON complète à l'appel de l'API.
Prise en charge des problèmes d'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 et de lui demander de l'aide pour l'extraction des journaux disponibles. Nous vous recommandons également de mettre votre développeur d'API en copie (CC) de tous vos messages à apisupport@shipstation.com.