¿Qué es una API?
Una API (Application Programming Interface) es un concepto otorgado a un software que permite la comunicación unilateral entre 2 sistemas, de tal manera que un emisor envíe un mensaje a un receptor, y este responda con un mensaje de respuesta.
Para el correcto funcionamiento de nuestros clientes, y para evitar el trabajo manual, Wareclouds provee una API capaz de conectarse a los diversos Webhooks existentes en las plataformas de Ecommerce y también a Webhooks personalizados.
La API de Wareclouds permite al ecommerce conectarse para poder crear pedidos en la medida que estos caen en el sistema de ecommerce, esto quiere decir que cada vez que un ecommerce reciba un pedido, si este se encuentra conectado a la API de Wareclouds, este pedido pasa a ser procesado inmediatamente por nuestro sistema.
Para obtener más detalles sobre las rutas de la API y los servicios de Webhooks soportados, visitar la documentación en https://webhook.wareclouds.app/doc/
¿Qué es un webhook?
Un Webhook es un sistema que funciona en base a eventos, que permite transmitir mensajes a receptores. También es conocido como Reverse API, ya que a diferencia de una API común y corriente encargada de escuchar mensajes, el Webhook se encarga de emitir mensajes.
Las plataformas de Ecommerce de hoy en día basan sus interacciones web en eventos determinados, y son los Webhooks los encargados de transmitir esta información a las APIs que se encuentren conectadas.
Wareclouds custom webhook
Si la intención del ecommerce es utilizar su propio Webhook para realizar la conexión con el sistema de Wareclouds, éste puede utilizar la API de Wareclouds para Webhooks personalizados.
🚨 Endpoint: https://webhook.wareclouds.app/wareclouds
HTTP Method: POST
Headers:
{ "hook-api-token": "<ECOMMERCE-TOKEN>",
"id-ecommerce": "<ECOMMERCE-USERNAME>", }Body:
{ "order_code": "PEDIDO-001",
"shipping": "Envio Flex",
"first_name": "Juan Ignacio",
"last_name": "Perez Soto",
"email": "juan@test.com",
"address": "Calle Almendral 389",
"address_detail": "Departamento 12",
"address_extra_info": "Avisar al conserje.",
"city": "Santiago",
"phone": "99985868",
"products": { "sku": "SKUPROD1",
"quantity": 5,
"price": 56708 },
{
"sku": "SKUPROD2",
"quantity": 3,
"price": 12708 },
{
"sku": "SKUPROD3",
"quantity": 1,
"price": 7000 } ] }
Pasos para hacer la conexión
Solicitar <ECOMMERCE-TOKEN> para agregarla al header de la request.
Obtener <ECOMMERCE-USERNAME> desde plataforma para agregarla al header de la request.
Realizar consulta para verificar caída de pedidos desde webhook.
Cosas importantes a considerar
La API de Wareclouds siempre retornará status 200 de respuesta, pero con mensajes diferentes
Si la solicitud no respeta el formato de los campos del BODY, se retornará una respuesta descriptiva sobre los campos que fallaron para ser cargados.
Cuando se envía una solicitud para un pedido con order_code repetido, el mensaje será ORDER_EXISTS
Cuando el campo shipping contiene un método invalido, el mensaje será
SHIPPING_METHOD_ERROR
Cuando la solicitud contiene productos que no están vinculados al e-commerce o simplemente no existen, el mensaje será PRODUCT_PACK_ERROR
Si te gustó este artículo, califícanos 😞 😐 😃 para seguir mejorando.