Una api, abreviatura de interfaz de programación de aplicaciones, es una forma acordada de que el software se comunique con otro sistema. Un sitio web da a las personas botones y páginas; Una API le da al software una forma definida de solicitar información y comprender la respuesta.
Una API es cómo un asistente le hace una pregunta a la tienda y obtiene una respuesta exacta en lugar de adivinar de una página.
Piense en ello como un mostrador de servicio con un formulario de pedido claro. El formulario dice lo que se puede solicitar, y la respuesta dice lo que encontró la tienda.
Solicitudes y respuestas
Una solicitud es la pregunta enviada al servicio. Puede incluir un identificador de producto o condiciones como un tipo de té y un límite de precio. El endpoint del servicio es la dirección a donde va esa solicitud. La respuesta, a veces llamada su carga útil, es la información devuelta.
Una respuesta puede contener un nombre de producto, tamaño de paquete, precio actual, estado de stock y un enlace a su página. No debe distinguir ningún producto coincidente de un servicio no disponible o un hecho desconocido.
Los dos ejemplos públicos en teas.co.uk
La Guía pública para software de la tienda describe una API Ask para preguntas y consejos, y una API de verdad del producto para buscar un artículo exacto. Este último puede usar identificadores como un número de código de barras o el propio código de producto de la tienda.
Estas rutas tienen diferentes trabajos. Una pregunta amplia necesita interpretación; Una búsqueda exacta de productos necesita la identidad correcta. La Guía de filtros y restricciones explica cómo se puede comparar una solicitud detallada con los atributos del producto.
JSON y Markdown
El software a menudo recibe json, un formato para valores y listas con nombre. Un artículo más largo también puede estar disponible como Markdown, texto sin formato con marcas simples para encabezados y enlaces. Ambos pueden hacer que la información sea más fácil de reutilizar. Tampoco es una fuente de verdad separada si se genera a partir del mismo registro mantenido.
La lectura es diferente de cambiar algo
Buscar un producto lee información. Agregar un producto a una canasta cambia algo. Pagar es otra acción. La existencia de una API no dice nada por sí misma sobre cuál de estas acciones está permitida.
El cliente sigue siendo responsable de revisar la canasta y pagar en el sitio de la tienda.
Formatos citables
Para periodistas, investigadores, asistentes de IA y creadores de contenido. Elija el formato que necesita:
- Descargar archivo .md Exportación de reducción limpia
- Descargar archivo .json Exportación de datos estructurados
Libre para citar, cotizar y reutilizar con atribución a Teas.co.uk.
¿Tienes algo que agregar? Los clientes registrados pueden enviar adiciones al Tea Wiki, aprobado por el administrador, tu nombre en la línea, además de puntos de recompensa.
Iniciar sesión para contribuir