Connecteur Shippo

Intégration avec l'API de Shippo

Introduction

Shippo est une API et une application web d'expédition multi-transporteurs qui inclut des transporteurs tels que USPS, DHL, FedEx et bien d'autres. Les clients peuvent obtenir des tarifs d'expédition, imprimer des étiquettes, automatiser les documents internationaux, suivre les expéditions et faciliter les retours.

Objectif

Cette intégration montre comment on peut utiliser les fonctions du connecteur HTTP de Tulip pour s'intégrer à l'API de Shippo afin d'automatiser la création d'expéditions, d'obtenir une variété de tarifs d'une gamme de transporteurs, de choisir le meilleur tarif et enfin de créer et d'imprimer une étiquette d'expédition avec l'option de suivre les expéditions. Tout ceci peut être fait à partir de votre application Tulip. En fonction des différents cas d'utilisation, l'intégration avec Tulip peut être mise à profit pour contrôler les opérations de la chaîne d'approvisionnement et avoir une visibilité en temps réel de l'expédition des colis.

Documentation API

Documentation API Shippo

Pré-requis

Créer un compte sur le site web de Shippo et générer des jetons API qui seront utilisés comme en-têtes d'autorisation dans tous les appels faits à l'API de Shippo. Shippo vous permet de générer un jeton de test et un jeton réel. Le jeton de test peut être utilisé pour effectuer des appels HTTP de test avec l'API et concevoir votre application Tulip, une fois que l'application est prête, les jetons peuvent être échangés et les applications peuvent être déployées en production pour générer des étiquettes d'expédition, des transactions en temps réel.

Détails de la connexion Tulip

Le connecteur HTTP de Tulip doit être configuré avec les détails suivants afin d'établir une connexion avec Shippo.

1. Exécution sur : Cloud Connector Host
2. Hôte : api.goshippo.com
3. Port:443
4. TLS:Oui
5. Les jetons Shippo en tant qu'en-tête d'autorisation peuvent être transmis via la fonction du connecteur.

Fonction du connecteur

Créer un envoi

But de la fonction

1. Cette fonction de connecteur crée un nouvel envoi en effectuant un appel POST à l'API de Shippo avec les détails de l'expéditeur, du destinataire et du colis dans le corps de la requête.
2. Lorsque la création est réussie, Shippo renvoie un objet JSON qui comprend le statut de l'envoi créé ainsi qu'un choix de tarifs de différents fournisseurs que les utilisateurs peuvent utiliser pour aller de l'avant et initier une transaction. Les utilisateurs peuvent sélectionner le bon taux, avoir les ID de taux stockés dans les variables Tulip qui seront dynamiquement passées pour créer la transaction afin de générer l'étiquette d'expédition dans la fonction correspondante du connecteur.

Point d'arrivée

1. Appel HTTP POST au point de terminaison :https://api.goshippo.com:443/shipments/

En-tête d'autorisation

Afin de s'authentifier avec l'API de Shippo, le jeton HTTP de Shippo doit être transmis dans l'en-tête de la requête. Voici le format

Autorisation : ShippoToken ($ShippoToken$)

Données requises

Les paramètres d'entrée suivants sont transmis dans le corps de la demande, le type de contenu étant JSON.

1. Nom de l'expéditeur, rue, ville, état, code postal, pays.
2. Nom du destinataire, rue, ville, état, code postal, pays.
3. Dimensions du colis - Longueur, largeur et poids

Extracteur de sortie requis

De nombreuses informations sont renvoyées pour l'objet Expédition créé, mais les champs importants à extraire sont les suivants

1. Statut : Indique si l'envoi a été créé avec succès
2. ID de l'envoi : Peut être référencé pour obtenir les détails de l'envoi créé.
3. Options tarifaires : Tableau d'objets indiquant les différentes options de taux proposées par les différents fournisseurs. L'identifiant du tarif est la clé importante parmi d'autres à extraire, qui sera transmise pour créer la transaction réelle pour cet envoi.

Créer une transaction

Objectif

1. Cette fonction de connecteur crée la transaction après avoir choisi le fournisseur et le tarif final parmi les différentes options qui ont été renvoyées lors de la création d'un nouvel envoi dans la fonction de connecteur précédente.
2. Une transaction réussie est établie en effectuant un appel HTTP POST au point de terminaison de Shippo en transmettant l'ID associé au tarif décidé. En cas d'appel réussi, Shippo renvoie un objet JSON qui comprend, entre autres, le statut de la transaction, l'identifiant de suivi, l'étiquette d'expédition et l'URL de suivi. L'étiquette d'expédition renvoyée peut être directement imprimée à partir de l'application Tulip elle-même.

Point d'arrivée

1. Appel HTTP POST au point de terminaison :https://api.goshippo.com:443/transactions/

En-tête d'autorisation

Afin de s'authentifier avec l'API de Shippo, le jeton HTTP de Shippo doit être transmis dans l'en-tête de la requête. Voici le format

Autorisation : ShippoToken ($ShippoToken$)

Données requises

Voici les paramètres d'entrée qui sont transmis dans le corps de la demande, le type de contenu étant JSON.

1. Rate ID : transmission de l'identifiant du tarif choisi pour procéder à une transaction réussie.

Extracteur de sortie requis

De nombreuses informations sont renvoyées pour l'objet Expédition créé, mais les champs importants à extraire sont les suivants

1. Statut : Indique si la transaction a été créée avec succès
2. ID de la transaction : Peut être référencé pour obtenir les détails de la transaction exécutée.
3. Numéro de suivi : Pour suivre l'envoi
4. URL de suivi : URL de la page de suivi du fournisseur choisi
5. URL de l'étiquette : Etiquette d'expédition qui peut être intégrée dans l'application Tulip pour être imprimée.