Guide de l’API EasyCargo (partie 2)

Comme nous l’avons mentionné dans la première partie de l’article, nous allons aujourd’hui » aborder » l’API EasyCargo de manière plus pratique. Pour ce faire, nous utiliserons notre client API. Nous allons également tester le fonctionnement de l’API à l’aide de l’outil en ligne ReqBin. Il permet de communiquer avec un serveur WWW, grâce auquel nous pouvons télécharger des données intéressantes à partir de notre calculateur de chargement de conteneurs EasyCargo. Les tests sont une chose, mais dans la vie réelle, vous pouvez utiliser un plugin Java pour votre logiciel ou des appels Javascript de SAP. Vous en saurez plus sur ce sujet, sur la plateforme Make et sur d’autres cas d’utilisation d’API dans le prochain article de cette série.

Voir à quoi ressemble la demande ci-dessus dans l’outil ReqBin

L’image ci-dessus montre notre client API pour EasyCargo. Pour pouvoir envoyer des requêtes API au serveur web, le client doit d’abord être autorisé. La demande de départ est donc un POST http://go.easycargo3d.com/api/v1/authentication avec le nom d’utilisateur et la clé API dans le contenu. Vous recevrez un jeton d’authentification du serveur dans la réponse. Chaque requête API ultérieure (sauf indication contraire) doit être authentifiée en ajoutant le jeton obtenu dans son en-tête. Il convient de noter ici que toutes les demandes d’API effectuées le sont au nom du propriétaire du jeton. Les requêtes et les réponses doivent être créées au format JSON ou XML.

Maintenant que nous sommes authentifiés, passons aux aspects les plus intéressants de l’API. Supposons que l’utilisateur X possède les charges d’expédition suivantes stockées dans son compte.

Nous allons pratiquer des requêtes API sur eux car les chargements d’expédition sont probablement la partie la plus importante d’EasyCargo. D’autres requêtes, telles que la gestion des utilisateurs, sont formulées de manière similaire. Nous pensons donc que chaque lecteur de cet article sera capable de gérer la création d’autres requêtes. Dans notre documentation API pour EasyCargo, chaque méthode de l’interface de programmation est décrite et expliquée.

Si vous avez des doutes, veuillez nous contacter à l’adresse assistance@easycargo3d.com ou utiliser notre formulaire de contact.

Requêtes API concernant les envois

Comme nous l’indique la documentation de l’API, avec des requêtes correctement formulées, nous sommes en mesure d’obtenir une liste de toutes les charges d’expédition du serveur, ainsi que des données sur une charge spécifique du compte EasyCargo. Nous pouvons même créer ou supprimer une charge du compte.

Obtenir la liste de tous les envois

Voir à quoi ressemble la demande ci-dessus dans l’outil ReqBin

Obtenir des données sur un envoi spécifique

Voir à quoi ressemble la demande ci-dessus dans l’outil ReqBin

Créer un envoi

Voir à quoi ressemble la demande ci-dessus dans l’outil ReqBin

Comme vous pouvez le constater, le chargement a été enregistré avec succès dans votre compte EasyCargo.

Vous pouvez simplement ouvrir le chargement créé par la méthode API dans votre application.

Suppression d’un envoi

Voir à quoi ressemble la demande ci-dessus dans l’outil ReqBin

Le chargement a été correctement retiré de votre compte EasyCargo avec la demande appropriée.

Quelques mots de plus sur l’API

• Le nombre de vos demandes API est limité dans le temps (60 demandes par heure). Les quotas sont vérifiés par tranche de temps mobile, de sorte qu’à n’importe quelle période de temps donnée, seul le nombre de demandes spécifié est autorisé.
• Les erreurs d’API sont renvoyées par des codes d’état HTTP courants. Dans la plupart des cas, le corps de la réponse contient un message spécifique sur ce qui n’a pas fonctionné.
• Le calcul de la planification des charges ne peut pas être exécuté via l’API.
• Votre client API doit prendre en charge l’accès et la modification de l’en-tête de la demande et de la réponse, ainsi que l’analyse du format de données JSON ou XML.
• L’utilisateur de l’API doit se connecter à l’application EasyCargo pour que le calcul du plan de chargement puisse être effectué.
• Certaines méthodes de l’API prennent en charge l’utilisation de paramètres facultatifs, tels que from. Vous apprendrez naturellement la signification de chacun d’entre eux dans la documentation. Vous pouvez utiliser ces paramètres, par exemple, lorsque vous demandez à obtenir une liste de toutes les charges utiles. Il suffit de les ajouter à l’adresse de la ressource après le caractère » ? « , séparés par le caractère » & » sous la forme name=value, par exemple http://go.easycargo3d.com/api/v1/shipments?from=2020-01-02&offset=0&limit=100.

En conclusion de cet article, l’API est un service très utile. Nous espérons que cette description pratique vous a permis d’en savoir plus sur le fonctionnement d’une interface de programmation. L’article d’aujourd’hui est le deuxième d’une série sur l’API d’EasyCargo. Si vous n’avez pas encore vu la première partie, vous pouvez la trouver ici. L’interface de programmation ouvre une multitude de possibilités. Dans le prochain article, vous découvrirez les avantages que vous pouvez tirer de l’utilisation de notre API et vous découvrirez ses cas d’utilisation réels.