Aller au contenu principal
Retour en haut

Points relais pour les intégrations API

Team Sendcloud
  • Mise à jour

Objectif : Il s'agit d'un guide pour activer les points relais pour les intégrations API. Cet article se concentre sur la configuration de la carte des points relais dans une boutique créée sur mesure, avec laquelle Sendcloud est connecté via une intégration API et non un plugin. 

API Sendcloud

Les APIs Sendcloud fournissent les fonctionnalités et les outils nécessaires pour vous aider à automatiser votre processus d'expédition.

Vous pouvez intégrer les fonctionnalités les plus importantes de Sendcloud avec votre système e-commerce personnalisé. Nous fournissons une documentation complète sur l'intégration avec les APIs Sendcloud dans notre portail pour les développeurs.

Consultez le Portail Développeurs Sendcloud

L'API des Points Relais

L'API Point Relais vous fournit les informations dont vous avez besoin pour déposer ou expédier des colis en point relais. L'API fournit quatre endpoints qui vous permettent de récupérer les emplacements des points relais, de vérifier leur disponibilité et de les stocker dans Sendcloud. 

Consultez notre API Référence Point Relais

Intégration de la carte des points relais

Sendcloud fournit une carte des points relais qui peut facilement être intégré à votre système. Une carte s'affiche au moment du checkout, à partir de laquelle vos clients peuvent choisir un point relais pour la livraison de leur colis. Vous pouvez en savoir plus en cliquant ici. 

Veuillez noter que le point relais sera affiché dans la langue définie dans votre compte, et non dans la langue du navigateur web.

Avant de commencer, assurez-vous d'avoir:

  1. Obtenu vos clés API
  2. Activé les points relais pour les transporteurs sélectionnés dans vos réglages pour votre intégration

Pour intégrer les points relais à votre boutique: 

  1. Faites des tests en direct. Lorsque vous sélectionnez un point relais, vous recevez un objet de point relais et un numéro de poste, s'il a été saisi, comme résultat. Vous aurez besoin de ces données plus tard lorsque vous créerez un nouveau colis via notre API colis. (Voir Créer un colis avec notre shipping API reference).
  2. Assurez-vous de remplir les paramètres to_service_point etto_post_number lors de l'envoi de ces données.
  3. Vous pouvez copier le code depuis le bas de cette page, sous la section Usage.

Pour vous intégrer à votre code de votre back-end:

  1. Vous devez appeler sendcloud.servicePoints.open et fournir un objet de configuration, un rappel de réussite et un rappel d'échec (exemple).
  2. Une fois qu'un point relais est sélectionné, notre bibliothèque appelle votre fonction de rappel avec un objet point relais, contenant les propriétés de l'adresse du point relais et aussi l'uniqueid du point relais. 
  3. Lorsque vous Créez un colis via l'API, vous devez structurer votre demande de manière à ce qu'elle comprenne les informations relatives à l'adresse du point relais. Dans les paramètres to_service_point, renseignez l'id du point relais. 
  4. Vous pouvez trouver un guide sur la création de colis à expédier en point relais avec l'API Sendcloud ici.

Liens utiles:

  • Documentation API Sendcloud
    https://api.sendcloud.dev/docs/sendcloud-public-api/ 
  • Exemple d'intégration des Points relais
    https://sendcloud-public.gitlab.io/spp-integration-example/
  • Base de données d'exemples d'intégration des Points relais
    https://gitlab.com/sendcloud-public/spp-integration-example

Historique des versions

Version: 1.0.0
Date: 11/01/2017 
URL: https://embed.sendcloud.sc/spp/1.0.0/api.min.js