Guide de l’API EasyCargo (partie 1)
En parcourant notre site Web, vous avez peut-être rencontré le terme API. Cette abréviation est intimement liée au secteur des technologies de l’information, de sorte que vous ne comprenez peut-être pas tout à fait ce qu’est ce service et quels avantages vous pouvez en tirer. Nous allons examiner ce qu’est une API et comment elle fonctionne. Nous avons pensé qu’il était utile de vous familiariser avec ce sujet, car il vous aidera, par exemple, à étendre les fonctionnalités du logiciel de votre entreprise. Nous avons donc décidé de créer une série en trois parties pour couvrir ce sujet de manière adéquate. Aujourd’hui, nous allons nous concentrer sur la partie théorique. En conclusion de cet article, vous apprendrez ce que contiendront les prochains articles de la série.
Source: https://bykowski.pl/wp-content/uploads/2021/06/api-przyklad-dzialania-1.jpg
Le schéma ci-dessus montre le rôle de l’API de manière très simple. Toutefois, il convient de répondre au préalable à la question suivante : qu’est-ce qu’une API ? Cet acronyme signifie l’interface de programmation d’applications. Il existe différents types d’API – nous avons une REST API. Sa signification ne devrait pas avoir beaucoup d’importance pour vous, nous ne nous concentrerons donc pas strictement sur le type d’API ici. Une interface de programmation d’applications est un ensemble spécifique de solutions qui vous permettent d’utiliser les données d’un autre service sur votre propre site web ou logiciel. Qu’est-ce que cela signifie ? Si votre entreprise dispose d’un service interne pour gérer, par exemple, le transport, vous pouvez télécharger les données de votre compte dans EasyCargo, qui seront alors directement livrées au logiciel de l’entreprise.
Toutefois, pour communiquer avec EasyCargo ou d’autres logiciels via l’API, vous avez besoin d’une clé API. Celle-ci nous permet d’identifier votre site lorsqu’il interagit avec EasyCargo. Si vous souhaitez l’obtenir, veuillez nous contacter par courriel à assistance@easycargo3d.com ou en utilisant notre formulaire de contact. Une fois la clé générée, vous pouvez la trouver dans votre profil d’utilisateur, dans le coin supérieur droit, en cliquant sur le bouton Afficher la clé API.
Remarque : traitez votre clé API comme le mot de passe de votre compte – gardez-la pour vous.
Les informations les plus importantes sur les API étant derrière nous, nous pouvons enfin passer à l’explication du rôle de l’interface de programmation d’applications sur la base du diagramme.
Nous pensons qu’à ce stade de l’article, vous avez déjà compris l’idée du fonctionnement de l’API. Vous pouvez trouver l’interface de programmation d’application EasyCargo à ce lien. Nous voulons tout de même attirer votre attention sur le fait que tous les exemples de requêtes dans la documentation de l’API sont écrits en HTTP. Nous vous recommandons d’utiliser le protocole HTTPS plus sécurisé.
En résumé, la première partie de cette série s’est principalement attachée à expliquer ce qu’est l’API et l’idée qui la sous-tend. Le prochain article sera plus pratique. Nous essaierons de vous familiariser avec l’utilisation de l’API pour EasyCargo, entre autres en utilisant notre client API. Vous constaterez par vous-même que les requêtes appropriées adressées à l’interface de programmation d’EasyCargo aboutissent aux données demandées. Dans la dernière partie de la série, nous aborderons ce que la communication via l’API avec EasyCargo rend possible.
