Que signifie API ?

Un abréviation d'API pour Application Programming Interface désigne un ensemble de codes de fonctions permettant aux applications d'accéder à des données spécifiées et d'interagir avec des composants d'applications logicielles externes, des systèmes d'exploitation ou des microservices.

Pour simplifier, une API fournit une réponse utilisateur à un système et renvoie la réponse du système à un utilisateur. Vous cliquez sur « Ajouter au panier » ; une API indique au site que vous avez ajouté un produit à votre panier ; le site Web met le produit dans votre panier et votre panier est mis à jour.

Vous entendrez peut-être le terme « microservices » apparaître en relation avec l'API. Ce ne sont cependant pas les mêmes. Les microservices sont un style ou une architecture qui divise les fonctionnalités au sein d'une application Web. Alors que l'API est le cadre dans lequel les développeurs interagissent avec une application Web. Les microservices peuvent en fait utiliser l'API pour communiquer entre eux.

L'API permet à un développeur de passer un « appel » ou une « demande » spécifique afin d'envoyer ou de recevoir des informations. Cette communication se fait à l'aide d'un langage de programmation appelé « JSON ». Il peut également être utilisé pour effectuer une action définie telle que la mise à jour ou la suppression de données. Il existe quatre méthodes de requête de base qui peuvent être effectuées avec l'API :

GET – Rassemble des informations (en extrayant tous les codes de coupon)

PUT – Met à jour des éléments de données (Mise à jour des prix du produit)

POST – Crée (Création d’une nouvelle catégorie de produits)

DELETE – (Suppression d’un article de blog)

Qu'est-ce que JSON et pourquoi est-il utilisé ?

JSON (JavaScript Object Notation) est utilisé pour représenter des données sur un serveur. Il est assez facile à lire par les humains et facile à comprendre pour les machines/applications. Regardons un exemple de JSON à partir d'un produit sur BigCommerce :

Ceci est facile à comprendre car il est généré par paires clé/valeur, avec la clé à gauche et une valeur à droite. Les clés sont un objet fixe défini par l'application et resteront les mêmes que pour la « catégorie ». Alors que les valeurs seront uniques, comme « Chemises ».

Qu'est-ce qu'une requête API ?

Il existe plusieurs composants d’une requête API pour qu’elle fonctionne. Examinons-les individuellement et comment ils peuvent être utilisés pour créer une demande.

Qu'est-ce qu'Endpoint ?

Un point de terminaison comporte deux éléments clés qui sont utilisés lors d'une requête API. L'un d'entre eux est l'URL. BigCommerce utilise https://api.bigcommerce.com/stores/ comme URL pour toutes les requêtes API. Cela peut ressembler à une URL normale, mais si vous la branchez à un navigateur Web, vous recevrez un message d'erreur 404.

La deuxième partie est le chemin. Le chemin variera en fonction de ce que vous essayez d’accomplir. Vous pouvez trouver une liste des chemins disponibles pour BigCommerce en visitant notre documentation pour les développeurs : https://developer.bigcommerce.com/api-reference. Pour cet exemple, nous allons utiliser le chemin du produit qui est /v3/catalog/products.

Lorsque nous rassemblons ces deux parties, nous obtenons un point de terminaison complet https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Maintenant, vous vous demandez peut-être « Qu'est-ce que le {store_hash} ? » « D'où cela vient-il ? » C'est ce qu'on appelle une variable. Les variables sont des composants uniques d'un point de terminaison et varient en fonction des informations de votre boutique. Vous pouvez repérer une variable grâce aux parenthèses ouvertes et fermées « { } ».

Qu’est-ce que l’en-tête ?

Les en-têtes fournissent des informations au client et au serveur. Des exemples courants d'en-tête seraient les informations d'authentification telles qu'un « jeton d'authentification » ou un « ID client ». Ces informations d'identification vous sont fournies automatiquement lorsque vous créez un compte API. Un autre en-tête courant est appelé « Type de contenu », qui informe le serveur du type de contenu qui sera envoyé. Par exemple, un type de contenu couramment utilisé est « application/json », qui indique au serveur que nous envoyons des données JSON.

Qu'est-ce que la Méthode ?

Les méthodes sont les actions entreprises lors de l’envoi d’une demande. Repensez au début lorsque nous avons discuté de GET, PUT, POST et DELETE. Ce sont toutes des méthodes API.

Qu'est-ce que les données?

Les données de la demande, également communément appelées « corps », sont des informations qui seront envoyées ou renvoyées par un serveur. Dans la discussion précédente sur JSON, vous pouvez voir un exemple de données API. Le corps d’une demande nécessitera parfois des informations spécifiques avant de pouvoir être transmis. Par exemple, si vous modifiez un seul produit, l'ID du produit sera requis avant qu'une modification puisse être effectuée.

En savoir plus ici.