Documentation API Sendcloud et Guide de démarrage rapide

Objectif : Tout ce que vous devez savoir sur l’intégration de votre boutique en ligne personnalisée avec Sendcloud via nos API (RESTful). 

Liens associés :

• Référence API Sendcloud
• Portail Développeurs Sendcloud
• Points relais pour les intégrations API
• FAQ des API Sendcloud 
• Guide d’intégration pour les marketplaces

Chez Sendcloud, nous proposons des fonctionnalités et des outils qui aident les entreprises e-commerce à automatiser leur processus d’expédition. Nos fonctionnalités entièrement évolutives facilitent la vie des e-commerçants, que vous soyez indépendant, start-up ou grande entreprise expédiant des milliers de colis par mois dans le monde entier. 

Intégrer Sendcloud

Il existe deux façons de connecter votre boutique en ligne à Sendcloud :

Intégrations plug-and-play

Si vous utilisez une solution e-commerce telle que Shopify, WooCommerce, Lightspeed ou Magento, vous n’avez pas besoin de compétences techniques pour connecter votre boutique. Nous proposons des applications et plugins plug-and-play pour plus de 80 des plateformes e-commerce les plus populaires, disponibles au téléchargement depuis la marketplace ou l’App Store de votre solution.

API Sendcloud

Si vous disposez d’une boutique en ligne développée sur mesure et non hébergée via une plateforme e-commerce, nos API entrent en jeu. Une API permet aux développeurs de se connecter à notre système interne, d’en extraire des composants clés et de les intégrer à votre boutique en ligne ou à votre système. Les API Sendcloud sont conçues pour couvrir chaque étape du parcours d’expédition.

Nos fonctionnalités peuvent être utilisées ensemble ou séparément, ce qui vous offre la flexibilité de concevoir et de créer votre propre workflow de A à Z. Nos API vous donnent accès à un large éventail d’options d’expédition nationales et internationales auprès des transporteurs commerciaux et postaux européens les plus populaires. 

Documentation et Référence API 

Si vous êtes un développeur expérimenté et souhaitez intégrer rapidement nos API, vous pouvez consulter directement notre Référence API ou accéder à nos Collections Postman.

Si vous débutez avec les API et souhaitez comprendre en détail à quoi peut ressembler votre flux de traitement des commandes, consultez notre documentation API. Nous proposons des guides de démarrage rapide et des tutoriels pour vous accompagner dans les bases, de la création de votre première commande et son expédition via l’API, à la création de votre première expédition et à la comparaison des tarifs d’expédition.

Que pouvez-vous faire avec nos API ?

• Orders API
  L’Orders API vous aide à préparer vos commandes pour la livraison de manière simple et flexible.

• Ship an Order API
  La Ship an Order API est une solution tout-en-un pour créer des étiquettes d’expédition pour vos commandes. L’expédition implique plusieurs informations clés, comme le poids, le transporteur préféré, le pays de destination et l’assurance. Elle facilite l’automatisation de l’ensemble du processus.

• Shipments API
  Créez et gérez des expéditions de manière programmatique. Elle vous permet d’automatiser l’ensemble du cycle de vie des expéditions sans intervention manuelle dans le panel, tout en utilisant vos règles et paramètres d’expédition.
  Toutes les expéditions restent visibles dans votre compte Sendcloud afin que vous puissiez les consulter, les résoudre ou les modifier à tout moment.

• Service Points API
  Intégrez un sélecteur de points relais à votre checkout, accédez à une base de données mondiale des points relais des transporteurs et permettez à vos clients de choisir un lieu de livraison pratique pour leur colis.

• Returns Portal API
  Permettez à vos clients de gérer leurs retours en créant une version personnalisée du Portail de retours. Vous pouvez la combiner avec la fonctionnalité de retours payants afin de facturer des frais de retour lorsque nécessaire.

• Tracking API
  Récupérez l’historique complet de suivi d’un colis, depuis son annonce au transporteur jusqu’à sa livraison au domicile de votre client.

• Pick-ups API
  Planifiez un enlèvement ponctuel avec un transporteur via la Pick-ups API et faites collecter vos colis depuis votre entrepôt ou votre magasin dans la plage horaire sélectionnée.

• Dynamic Checkout API
  Augmentez votre taux de conversion en proposant des options de livraison le lendemain, le jour même ou à date choisie directement dans votre checkout. Configurez les méthodes d’expédition par zone de livraison dans le panel, puis utilisez l’API pour récupérer les méthodes disponibles et les afficher à vos clients lors du paiement.

• Returns API
  Créez des retours indépendants avec la Returns API, même si le colis n’a pas été initialement expédié via votre compte. Accédez à une base de données des méthodes de retour disponibles et validez votre demande avant de générer l’étiquette, afin d’éviter des frais inutiles si la méthode sélectionnée n’est pas applicable. 

Qu’est-ce qu’une API ?

API signifie « Application Programming Interface ». Une API permet à des applications de communiquer entre elles via le web. Pour récupérer des données depuis une API, vous effectuez une « requête » dans un langage de formatage comme JSON ou XML, ou dans un langage de programmation comme Python, vers un serveur, qui renvoie les données demandées dans une « réponse ». Les API ne sont pas de simples bases de données : en plus de demander des données, vous pouvez également les mettre à jour, les créer et les supprimer en envoyant des requêtes vers des endpoints spécifiques.

Par exemple, l’API Sendcloud vous donne accès à l’endpoint « Create a Shipment ». Vous pouvez envoyer une requête à cet endpoint pour créer une expédition dans le système Sendcloud en fournissant les informations requises (adresse, option d’expédition, etc.). Pour effectuer une requête, vous devez connaître les informations dont notre serveur a besoin pour créer l’expédition. Nous fournissons des exemples de requêtes et de réponses, ainsi qu’une liste des champs obligatoires et facultatifs dans notre référence API.

Pourquoi utiliser une API plutôt qu’une intégration plug-and-play ?

Les développeurs utilisent les API pour intégrer des fonctionnalités spécifiques à une boutique ou un système développé sur mesure. Se connecter à Sendcloud via l’API vous permet d’adapter nos fonctionnalités à vos besoins, tout en les intégrant avec des applications tierces liées à la facturation ou à la gestion d’entrepôt. 

En vous intégrant à Sendcloud via une API, vous bénéficiez d’une flexibilité totale pour concevoir votre flux de traitement des commandes et votre workflow logistique. Vous pouvez traiter vos commandes directement via l’API ou les importer dans le panel Sendcloud pour les gérer depuis celui-ci. Comme notre API vous donne accès individuellement à nos fonctionnalités clés, vous choisissez celles que vous souhaitez utiliser et les intégrez directement à votre système. 

Bien démarrer 

Prêt(e) à intégrer les API Sendcloud ? Avant de commencer, assurez-vous d’avoir créé un compte Sendcloud et suivi les étapes de notre guide Bien démarrer avec Sendcloud.

Vous devrez effectuer les étapes suivantes avant que notre API n’accepte vos requêtes :

1. Configurer vos adresses d’expéditeur et de retour (facultatif)
2. Activer des transporteurs dans votre compte
3. Configurer un moyen de paiement (obligatoire avant de pouvoir créer des étiquettes d’expédition). En savoir plus sur la facturation des étiquettes créées ici. 

Facultatif : N’oubliez pas de créer une marque, d’activer les notifications de suivi et de créer votre portail de retours. 

Authentification

Sendcloud utilise l’ authentification Basic pour authentifier les requêtes vers nos API. Vous devez inclure une clé API `Public` et `Private` dans l’en-tête de chaque appel effectué vers un endpoint Sendcloud. 

Exemple : 

curl “https://panel.sendcloud.sc/api/v2/parcels” --user “YOUR_API_KEY:YOUR_API_SECRET”

Consultez la section Authentification de notre Portail Développeurs pour plus d’exemples sur l’authentification avec nos API. 

Comment obtenir vos clés API

1. Connectez-vous à votre compte Sendcloud et allez dans Paramètres > Intégrations
2. Trouvez Sendcloud API dans la liste des intégrations et cliquez sur Connecter
3. Donnez un nom à l’intégration API (par ex. « Ma boutique en ligne ») et cliquez sur Enregistrer
4. Vos clés API Public et Secret seront générées automatiquement. Copiez-les et conservez-les en lieu sûr, puis incluez-les dans les en-têtes de vos requêtes. La clé Public correspond à votre « nom d’utilisateur » et la clé Secret (Private) à votre « mot de passe ». 

Activer les points relais

Dans la page des paramètres d’intégration, comme indiqué ci-dessus dans la section Authentification, vous pouvez activer ou désactiver les points relais. Pour effectuer des requêtes vers la Service Point API, expédier des colis vers un point relais ou afficher le sélecteur de points relais dans votre checkout, veillez à activer les points relais.

Une fois l’option activée, sélectionnez les transporteurs à inclure comme méthodes de livraison en point relais, puis cliquez sur Enregistrer. 

Créer des étiquettes de test

Vous pouvez tester nos API sans craindre de frais inattendus en utilisant l’option d’expédition Sendcloud « Unstamped Letter » ("shipping_option_code": "sendcloud:letter"). Pour plus d’informations sur la création d’étiquettes de test via l’API, consultez notre documentation.

Foire aux questions

Si vous avez des questions sur l’utilisation de nos API, consultez notre guide API Sendcloud - FAQ.

Adresses IP à autoriser