Vente d'automne : 20 % de réduction sur presque tout jusqu'au 24 décembreVoir la vente →
Voir les 402 produits Livraison gratuite au Royaume-Uni à plus de 35 £
Entrée wiki · 2 min de lecture

Qu'est-ce qu'une API ?

Une API, abréviation d'une interface de programmation d'applications, est un moyen convenu pour les logiciels de communiquer avec un autre système. Un site Web donne aux utilisateurs des boutons et des pages ; Une API donne aux logiciels un moyen défini de demander des informations et de comprendre la réponse.

Publié Curateur-écrit, non participatif
04 / Sections · Tea Wiki

Une API, abréviation d'une interface de programmation d'applications, est un moyen convenu pour les logiciels de communiquer avec un autre système. Un site Web donne aux utilisateurs des boutons et des pages ; Une API donne aux logiciels un moyen défini de demander des informations et de comprendre la réponse.

Une API est la façon dont un assistant pose une question au magasin et obtient une réponse exacte au lieu de deviner une page.

Considérez-le comme un compteur de services avec un formulaire de commande clair. Le formulaire indique ce qui peut être demandé et la réponse indique ce que la boutique a trouvé.

Demandes et réponses

Une demande est la question envoyée au service. Il peut inclure un identifiant de produit ou des conditions telles qu'un type de thé et une limite de prix. Le endpoint du service est l'adresse où va cette demande. La réponse, parfois appelée sa charge utile, est l'information renvoyée.

Une réponse peut contenir un nom de produit, une taille de paquet, un prix actuel, un statut de stock et un lien vers sa page. Il ne doit distinguer aucun produit correspondant d'un service indisponible ou d'un fait inconnu.

Les deux exemples publics à teas.co.uk

Le Guide public de la boutique pour le logiciel décrit une API ASK pour les questions et les conseils, ainsi qu'une API de vérité produit pour rechercher un article exact. Ces derniers peuvent utiliser des identifiants tels qu'un numéro de code-barres ou le propre code produit de la boutique.

Ces itinéraires ont des emplois différents. Une question large doit être interprétée ; Une recherche de produit exacte a besoin de la bonne identité. Le Guide des filtres et des contraintes explique comment une demande détaillée peut être vérifiée par rapport aux attributs du produit.

JSON et Markdown

Le logiciel reçoit souvent JSON, un format pour les valeurs et listes nommées. Un article plus long peut également être disponible en tant que markdown, texte brut avec des marques simples pour les en-têtes et les liens. Les deux peuvent faciliter la réutilisation des informations. Ni l'un ni l'autre n'est une source de vérité distincte s'il est généré à partir du même enregistrement maintenu.

La lecture est différente de changer quelque chose

La recherche d'un produit lit des informations. L'ajout d'un produit à un panier change quelque chose. Payer est une autre action. L'existence d'une API ne dit rien par elle-même de laquelle de ces actions est autorisée.

Le client reste responsable de la vérification du panier et du paiement sur le site de la boutique.

Ajoutez quelque chose à ajouter ? Les clients connectés peuvent soumettre des ajouts à Tea Wiki, approuvé par l'administrateur, votre nom sur la ligne de signature, ainsi que les points de récompense.

Connectez-vous pour contribuer
Notes de thé et mises à jour des actions

Notes utiles sur le thé, uniquement lorsqu'il y a quelque chose à dire.

Arrivées de stocks, notes d'achat et conseils pratiques du catalogue. Pas de remplissage, pas de bruit quotidien, désabonner en un seul clic.

par famille

par moment

Marque du moisHyson Packs de dégustation de saisonComment fonctionnent les forfaits saisonniers Club du thé du moisBoîte mensuelle choisie par le conservateur Trouvez votre théQuizz de 60 secondes
Voir les 402 produits