Documentation API Sendcloud et Guide de démarrage rapide

Sujet: Tout ce que vous devez savoir sur l'intégration de votre boutique en ligne sur mesure avec Sendcloud via nos API (RESTful). 

Liens utiles:

• Documentation API Sendcloud
• Portail des développeurs Sendcloud
• Intégration de l'API pour les points relais

Chez Sendcloud, nous fournissons des fonctionnalités et des outils qui aident les entreprises e-commerce à automatiser leur processus d'expédition. Nos fonctionnalités, en perpétuelle évolution, facilitent la vie des vendeurs, qu'il s'agisse d'une entreprise individuelle ou d'une start-up, ou bien encore d'une structure à grande échelle expédiant des milliers de colis par mois dans le monde entier. 

Intégration avec Sendcloud

Il y a deux façons de connecter votre boutique avec Sendcloud:

Intégrations Plug-and-Play

Si vous utilisez un système e-commerce tel que Shopify, WooCommerce, Lightspeed et Magento, vous n'avez pas besoin de compétences en développement pour connecter votre boutique. Nous fournissons des plugins prêts à l'emploi pour plus de 80 plateformes e-commerce populaires, téléchargeables depuis la marketplace, votre boutique ou système. 

API Sendcloud

Si vous avez une boutique en ligne personnalisée qui n'est pas hébergée et créée par une plateforme de e-commerce, c'est là que nos API entrent en jeu. Une API permet aux développeurs de se connecter à des composants clés de notre système interne, de les extraire et de les intégrer à votre boutique en ligne ou à votre système. Les API de Sendcloud sont conçues pour couvrir chaque étape de l'expédition.

Nos fonctionnalités peuvent être utilisées ensembles ou indépendamment les unes des autres, ce qui vous donne la possibilité de concevoir et de construire organisation de travail, du début à la fin. Nos API vous permettent d'accéder à un large choix de méthodes d'expédition nationales et internationales des transporteurs européens les plus populaires. 

Documentation et référence API

Si vous êtes un développeur expérimenté et que vous souhaitez vous familiariser rapidement avec nos API, vous pouvez vous rendre directement sur notre API Reference ou accéder à nos Postman Collections.

Si vous êtes novice en matière d'API et que vous souhaitez obtenir une explication approfondie de la manière dont le traitement des commandes pourrait se présenter, consultez notre documentation API. Nous fournissons des guides de démarrage rapide pour vous guider à travers les principes de base, de la Création de votre premier colis avec l'API à la Création de colis Multicollo en passant par la comparaison des Frais de port. 

Que pouvez-vous faire avec nos APIs ?

• Shipping API
  Cette API vous donne accès aux principales fonctionnalités de notre plateforme. Créez des étiquettes, comparez les tarifs, générez des documents douaniers pour vos envois internationaux et automatisez vos décisions d'expédition grâce aux règles d'expédition.
• Service Points API
  Intégrez un sélecteur de points relais au moment du checkout, accédez à une base de données de tous les points relais disponibles pour les transporteurs du monde entier, et laissez vos clients choisir l'endroit pour faire livrer leur colis.
• Shipping Products API
  Comparez les tarifs et les services proposés avec plus de 50 transporteurs à l'échelle nationale et internationale.
• Return Portal API
  Laissez vos clients gérer leurs propres retours en créant votre version personnalisée du portail de retour Sendcloud. Utilisez-le en complément de notre fonctionnalité de retours payants pour facturer vos clients pour les frais de retour.
• Tracking API
  Consultez l'historique complet du suivi d'un colis, depuis le moment où il est annoncé jusqu'à l'heure exacte où il arrive chez votre client.
• Pickups API
  Programmez un ramassage avec un transporteur via l'API et faites en sorte que vos colis soient collectés à l'emplacement de votre entrepôt ou de votre magasin dans une plage horaire donnée.
• Returns API V3
  Créez des retours automatisés pour les colis, en quelques minutes, même si le colis n'a pas été initialement expédié via votre compte Sendcloud. Accédez à une base de données de méthodes de retour et validez votre demande de retour avant de créer l'étiquette, afin d'éviter des frais indésirables si un retour n'est pas possible avec la méthode de retour sélectionnée. Cette fonctionnalité est actuellement en version bêta fermée. 

Qu'est ce qu'une API?

API est l'abréviation de Application Programming Interface (interface de programmation d'applications). Une API permet aux applications de communiquer entre elles sur le web. Pour récupérer des données à partir d'une API, vous faites une "demande" dans un langage de formatage tel que JSON ou XML, ou un langage de programmation tel que Python, à un serveur, et le serveur renvoie les données demandées dans une "réponse". Les API ne sont pas simplement une base de données : outre la demande de données, vous pouvez mettre à jour, créer et supprimer des données en effectuant des demandes d'API vers "endpoints" spécifiques.

Par exemple, l'API d'expédition Sendcloud vous donne accès au endpoint "Créer un colis". Vous pouvez faire un appel à ce endpoint pour créer un colis dans le système Sendcloud en fournissant au endpoint les informations dont il a besoin (informations sur l'adresse, sur la méthode d'expédition, etc.). Pour faire une demande, vous devez savoir de quelles informations notre serveur a besoin pour créer le colis. 

Nous fournissons des exemples de demandes et de réponses, ainsi qu'une liste de champs obligatoires et facultatifs que vous pouvez fournir, 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 dans une boutique en ligne ou le système. La connexion à Sendcloud via l'API vous permet de personnaliser nos fonctionnalités pour répondre aux besoins de votre entreprise, vous pouvez également intégrer nos fonctionnalités aux applications tierces liées à la facturation et à la gestion des entrepôts. 

Lorsque vous vous intégrez à Sendcloud par le biais d'une API, vous disposez d'une flexibilité totale pour décider de la manière dont vous souhaitez construire votre le traitement de vos commandes et la logistique. Vous pouvez choisir de traiter vos commandes directement via l'API, ou importer des commandes dans Sendcloud pour ensuite les traiter. Parce que notre API vous donne accès à nos fonctionnalités clés individuellement, vous pouvez décider des fonctionnalités dont vous voulez profiter et les incorporer directement dans votre système et votre flux de travail. 

Commencer

Prêt à commencer l'intégration avec les APIs Sendcloud ? Avant de commencer, assurez-vous d'avoir créé un compte Sendcloud et suivi les étapes de notre guide de démarrage avec Sendcloud.

Il vous faudra effectuer les étapes suivantes avant que notre API n'accepte vos demandes:

1. Configurer votre adresse d'expédition, et optionnellement de retour.
2. Activez des transporteurs dans votre compte
3. Activer une méthode de paiement (requis avant toute création d'étiquette d'envoi). Apprenez-en plus sur comment Sendcloud vous facture pour les étiquettes que vous créez, en cliquant ici. 

Facultatif: N'oubliez pas de créer une marque, d'activer les emails de suivi et d'activer votre Portail de retour.

Authentification

Sendcloud utilise une authentification basique pour authentifier les demandes pour nos APIs. Vous devrez inclure une clé d'API `Public` et `Privé` dans l'en-tête de tous les appels que vous faites à un endpoint Sendcloud. 

Exemple: 

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

Reportez-vous à la section Authentification de notre portail pour développeurs pour plus d'exemples concernant l'authentification avec nos APIs. 

Comment obtenir vos clés API

1. Connectez-vous à votre compte Sendcloud et allez dans Réglages> Boutiques connectées.
2. Trouvez l'API Sendcloud dans la liste des intégrations et cliquez sur Connecter
3. Renseignez un nom à votre intégration API (ex: "Ma boutique") et cliquez sur Enregistrer
4. Les clés publiques et secrètes de votre API seront automatiquement générées. Copiez-les dans un endroit sûr et renseignez-les dans vos en-têtes de demande. La clé publique est votre "nom d'utilisateur" lorsque vous vous authentifiez auprès de l'API, et la clé secrète (privée) fait office de "mot de passe". 

Activation des Points relais

Dans la page de paramètres de votre intégration, dans Authentification (ci-dessus), vous pouvez choisir d'activer ou de désactiver les points relais. Pour effectuer des demandes d'API vers l'API des points relais, pour expédier des colis vers un point relais ou pour afficher la carte des points relais au checkout, il vous faut activer les points relais. 

Une fois que vous avez coché la case pour activer les points relais, vous pouvez sélectionner les transporteurs que vous souhaitez ajouter pour proposer la livraison en point relais, et cliquer sur Enregistrer.

Créer des étiquettes de tests

Vous pouvez tester nos APIs sans être facturé, en utilisant la méthode d'expédition Sendcloud "Unstamped letter" (lettre non affranchie). Pour plus d'aide 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 APIs, vous pouvez consulter notre guide FAQ sur les intégrations API. 

Adresses IP à whitelister