¿Qué significa API?

Una API, abreviatura de Interfaz de programación de aplicaciones, significa un conjunto de códigos de funciones que permiten a las aplicaciones acceder a datos específicos e interactuar con componentes de aplicaciones de software, sistemas operativos o microservicios externos.

Para simplificar, una API entrega una respuesta de usuario a un sistema y envía la respuesta del sistema a un usuario. Haces clic en "añadir al carrito"; una API le dice al sitio que agregó un producto a su carrito; el sitio web coloca el producto en su carrito y su carrito se actualiza.

Es posible que escuche aparecer el término "microservicios" en relación con la API. Estos, sin embargo, no son lo mismo. Los microservicios son un estilo o arquitectura que divide la funcionalidad dentro de una aplicación web. Mientras que API es el marco mediante el cual los desarrolladores interactúan con una aplicación web. Los microservicios en realidad pueden utilizar API para comunicarse entre ellos

La API permite a un desarrollador realizar una "llamada" o "solicitud" específica para enviar o recibir información. Esta comunicación se realiza mediante un lenguaje de programación llamado "JSON". También se puede utilizar para realizar una acción definida como actualizar o eliminar datos. Hay cuatro métodos de solicitud básicos que se pueden realizar con API:

OBTENER: recopila información (extrayendo todos los códigos de cupón)

PUT: actualiza datos (actualización de precios del producto)

POST – Crea (Creación de una nueva categoría de producto)

ELIMINAR – (Eliminar una publicación de blog)

¿Qué es JSON y por qué se utiliza?

JSON (notación de objetos JavaScript) se utiliza para representar datos en un servidor. Es bastante fácil de leer para los humanos y fácil de entender para las máquinas/aplicaciones. Veamos un ejemplo de JSON de un producto en BigCommerce:

Esto es fácil de entender ya que se genera en pares clave/valor, con la clave a la izquierda y un valor a la derecha. Las claves son un objeto fijo definido por la aplicación y seguirán siendo las mismas que con la "categoría". Mientras que los valores serán únicos, como "Camisas".

¿Qué es una solicitud de API?

Hay varios componentes de una solicitud API para que funcione. Repasemos estos individualmente y cómo se pueden utilizar para crear una solicitud.

¿Qué es Endpoint?

Hay dos partes clave de un punto final que se utilizan al realizar una solicitud de API. Uno de los cuales es la URL. BigCommerce utiliza https://api.bigcommerce.com/stores/ como URL para todas las solicitudes de API. Puede parecer una URL normal, pero si la conecta a un navegador web, recibirá un mensaje de error 404.

La segunda parte es el camino. El camino variará según lo que esté intentando lograr. Puede encontrar una lista de rutas disponibles para BigCommerce visitando nuestra documentación para desarrolladores: https://developer.bigcommerce.com/api-reference. Para este ejemplo vamos a utilizar la ruta del producto que es /v3/catalog/products.

Cuando juntamos estas dos partes, obtenemos un punto final completo https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Ahora puede que te estés preguntando "¿Qué es {store_hash}?" "¿De dónde viene?" Esto es lo que se conoce como variable. Las variables son componentes únicos de un punto final y variarán según la información de su tienda. Puede identificar una variable mediante los corchetes abiertos y cerrados “{ }”.

¿Qué es el encabezado?

Los encabezados proporcionan información al cliente y al servidor. Ejemplos comunes de un encabezado serían las credenciales de autenticación, como un "Token de autenticación" o un "ID de cliente". Estas credenciales se le proporcionan automáticamente cuando crea una cuenta API. Otro encabezado común se conoce como "Tipo de contenido", que informa al servidor qué tipo de contenido se enviará. Por ejemplo, un tipo de contenido comúnmente utilizado es "aplicación/json", que le permite al servidor saber que estamos enviando datos JSON.

¿Qué es Método?

Los métodos son las acciones tomadas al enviar una solicitud. Piense en el principio cuando hablamos de OBTENER, PONER, PUBLICAR y ELIMINAR. Todos estos son métodos API.

¿Qué son los datos?

Los datos de la solicitud, también conocidos comúnmente como "cuerpo", son información que será enviada o devuelta por un servidor. En la discusión anterior sobre JSON, puede ver un ejemplo de datos API. En ocasiones, el cuerpo de una solicitud requerirá información específica antes de poder entregarse. Un ejemplo de esto es que si está editando un solo producto, se solicitará el ID del producto antes de poder realizar cualquier cambio.

Leer más esta página.