Ruta de APIS para Bot Daiko (Wintook)

APIs
1
CODIGOS DE RETORNO
CODIGO DEFINICIÓN
200 OK: La solicitud se procesó correctamente.
201 Created: Un recurso fue creado con éxito.
202 Accepted: El producto no existe.
204 No Content: La solicitud fue exitosa pero no hay contenido para devolver.
LISTADO DE PRODUCTOS
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/products GET ○ id (string): ID del producto.,
○ name(string): Nombre del producto.,
○ price (float): Preció sin impuesto del producto.,
○ tax(float): Impuesto del producto.,
○ ship (float): Costo de envío del producto.
RESPUESTAS: LISTADO DE PRODUCTOS
CASO Respuesta
Si no existen productos en las tablas Status: 202 Accepted*
{ “success”: true, “message”: “La solicitud fue exitosa pero no hay contenido para devolver.”}

AGREGAR COMENTARIOS

DETALLE DEL PRODUCTO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/product/:id GET
Valores de entrada: ID del producto(Solo numericos)		 ● id (string): ID del producto.
● name (string): Nombre del producto.
● description (string): Descripción del producto.
● price (float,): Preció sin impuesto del producto.
● tax (float): Impuesto del producto.
● ship (float): Costo de envío del producto.
● strock (float): Cantidad de productos en existencia…
RESPUESTAS:DETALLE DEL PRODUCTO
CASO Respuesta
Si el producto existe Status: 200 OK
Si el producto NO existe Status: 202 Accepted
{“error”: true, “message”: “Producto no encontrado.”}
Si el id es incorrecto Status: 202 Accepted
{ “message”: “Falta el ID del producto. Por favor, proporcione un ID válido en la ruta.”}

AGREGAR COMENTARIOS

BÚSQUEDA DEL PRODUCTO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/products/search/:keyword GET
Valores de entrada:keyword: palabra clave para búsqueda.		 ○ id (string): ID del producto.
○ name (string): Nombre del producto.
○ price (float): Preció sin impuestos del producto.
○ tax(float): Total de impuestos del producto.
○ ship (float): Costo de envío del producto.
RESPUESTAS: BÚSQUEDA DEL PRODUCTO
CASO Respuesta
Si el producto existe Status: 200 OK
Si el producto NO existe Status: 202 Accepted
{ “message”: “El producto no existe”}
Si se busca mas de una palabra Status: 200 OK
Si el dato de entrada es numerico Status: 202 Accepted
{ “message”: “El producto no existe”}
Si buscas por nombre de categoria Status: 200 OK

AGREGAR COMENTARIOS

CATEGORIAS DEL PRODUCTO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/products/category/:name_category GET
Nombre de la categoría.		 ○ id (string): ID del producto.
○ name (string): Nombre del producto.
○ price (float): Preció sin impuesto del producto.
○ tax (float): Impuesto del producto.
○ ship (float): Costo de envío del producto.
RESPUESTAS: CATEGORIAS DEL PRODUCTO
CASO Respuesta
Si la categoria existe Status: 200 OK
Si la categoria NO existe Status: 202 Accepted
{ “message”: “La categoria no existe”}
Si se busca mas de una palabra Status: 200 OK
Si el dato de entrada es numerico Status: 202 Accepted
{ “message”: “La categoria no existe”}
Si el dato de entrada es producto Status: 200 OK
{ “error”: true, “message”: “No existe Categoria. Indica que categoria quieres”}

AGREGAR COMENTARIOS

CREAR CARRITO VIRTUAL
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/cart/ POST
{ “cliente_id”: 7, “articulo_id”: 3117, “cantidad_prod”: 2}		 { “status”: “OK”, “data”: { “id”: 512 }}
RESPUESTAS: CREAR CARRITO VIRTUAL
CASO Respuesta
Si el carrito creado con exito Status: 200 OK
Si el carrito ya existe NO APLICA
Si el articulo no existe Status: 202 Accepted
{ “message”: “Producto o Cliente no existe”}
Si el cliente no existe Status: 202 Accepted
{ “message”: “Producto o Cliente no existe”}
Si el campo de entrada de id cliente es null Status: 202 Accepted
{ “success”: true, “message”: “Falta el ID del cliente. Por favor, proporcione un ID válido en la ruta.”}
Si el campo de entrada de unidades es null Status: 202 Accepted
{ “success”: true, “message”: “Falta la cantidad de unidades. Por favor, proporcione el número de unidades en la ruta.”}
Si el campo de entrada de articulo es null Status: 202 Accepted*
{ “success”: true, “message”: “Falta el ID del artículo. Por favor, proporcione un ID válido en la ruta.”}
Si agregas mas de un producto POR REVISAR PENDIENTE

AGREGAR COMENTARIOS

OBTENER CARRITO VIRTUAL
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/cart/:id GET
 Caracteristicas principales del carrito
RESPUESTAS: OBTENER CARRITO VIRTUAL
CASO Respuesta
Si el carrito existe Status: 200 OK
Si el carrito NO existe Status: 202 Accepted
{ “message”: “Carrito no encontrado.”}
Si el carrito esta vacio Status: 200 OK
Si el dato de entrada es cadena Status: 202 Accepted
{ “success”: true, “message”: “Falta el ID del producto. Por favor, proporcione un ID válido en la ruta.”}

AGREGAR COMENTARIOS

ACTUALIZAR CARRITO VIRTUAL
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/cart/:id_carrito PUT
{ “articulo_id”: “211”, “unidades”: “10”}		 { “status”: “OK”, “data”: { “message”: “Carrito actualizado.” }}
RESPUESTAS: ACTUALIZAR CARRITO VIRTUAL
CASO Respuesta
Si el carrito actualiza con exito Status: 200 OK
Si el carrito no existe Status: 202 Accepted
{ “message”: “Carrito o Articulo no encontrado.”}
Si el articulo NO existe Status: 202 Accepted
{ “success”: true, “message”: “el articulo id es incorrecto. Por favor, proporcione uno válido.”}
Si articulo id estan en null Status: 202 Accepted
{ “status”: “OK”, “data”: { “success”: true, “message”: “el articulo id es incorrecto. Por favor, proporcione uno válido.” }}
Si las unidades estan en null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “Las unidades son incorrecto. Por favor, proporcione uno válido.” }}
Si el articulo NO existe en el carrito y es agregar un nuevo Status: 201 Created
{ “status”: “OK”, “data”: { “message”: “Carrito actualizado.” }} NO ACTUALIZAR PENDIENTE REVISAR
Si el cliente id es null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “El cliente id es incorrecto. Por favor, proporcione uno válido.” }}
Si el articulo id es null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “el articulo id es incorrecto. Por favor, proporcione uno válido.” }}
Si unidades es null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “Las unidades son incorrecto. Por favor, proporcione uno válido.” }}
Si el cliente id no coincide con su carrito id Status: 201 Created { “status”: “OK”, “data”: { “message”: “Articulo Actualizado” }} ACTUALIZA OK PENDIENTE REVISAR
Si envias vacio cualquier parametro Status: 400 Bad Request

AGREGAR COMENTARIOS

ELIMINAR CARRITO VIRTUAL
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/cart/:id_carrito DELETE
 { “status”: “OK”, “data”: true}
RESPUESTAS: ELIMINAR CARRITO VIRTUAL
CASO Respuesta
Si el carrito existe Status: 200 OK
Si el carrito NO existe Status: 202 Accepted { “status”: “OK”, “data”: { “message”: “Carrito no existe.” }}
Si el id del carrito es incorrecto Status: 202 Accepted{ “message”: “Falta el ID del producto. Por favor, proporcione un ID válido en la ruta.”}

AGREGAR COMENTARIOS

AGREGAR PRODUCTO AL CARRITO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/cart/:id_carrito/productos POST
 {“status”:“OK”,“data”:{“id”:510}}
RESPUESTAS: AGREGAR PRODUCTO AL CARRITO
CASO Respuesta
Agregar producto al carrito Status: 200 OK
Si ya existe producto : Actualizar Status: 200 OK {“status”:“OK”,“data”:{“message”:“Articulo Actualizado”}}
Si el carrito NO existe Status: 202 Accepted {“status”:“OK”,“data”:{“message”:“Articulo y/o carrito no existe.”}}
Si el articulo NO existe Status: 202 Accepted {“status”:“OK”,“data”:{“message”:“Articulo y/o carrito no existe.”}}
Si articulo id estan en null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “el articulo id es incorrecto. Por favor, proporcione uno válido.” }}
Si las unidades estan en null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “Las unidades son incorrecto. Por favor, proporcione uno válido.” }}
Si el cliente id es null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “El cliente id es incorrecto. Por favor, proporcione uno válido.” }}
Si el articulo id es null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “el articulo id es incorrecto. Por favor, proporcione uno válido.” }}
Si unidades es null Status: 201 Created
{ “status”: “OK”, “data”: { “success”: true, “message”: “Las unidades son incorrecto. Por favor, proporcione uno válido.” }}
Si el cliente id no coincide con su carrito id Status: 201 Created { “status”: “OK”, “data”: { “message”: “Articulo Actualizado” }} ACTUALIZA OK PENDIENTE REVISAR

AGREGAR COMENTARIOS

ELIMINAR PRODUCTO AL CARRITO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/cart/:id_carrito/:id_producto DELETE
 { “status”: “OK”}
RESPUESTAS: ELIMINAR PRODUCTO AL CARRITO
CASO Respuesta
Si el carrito existe Status: 200 OK
Si el carrito NO existe Status: 202 Accepted{ “message”: "No existe carrito o articulo. Revisa Datos "}
Si el articulo NO existe Status: 202 Accepted{ “message”: "No existe carrito o articulo. Revisa Datos "}
Si el articulo y carrito No existe Status: 202 Accepted{ “message”: "No existe carrito o articulo. Revisa Datos "}
Si el id del carrito es incorrecto Status: 202 Accepted{“message”:“el id carrito es incorrecto. Por favor, proporcione uno válido.”}
Si el id del producto es incorrecto Status: 202 Accepted{“message”:“el id producto es incorrecto. Por favor, proporcione uno válido.”}

AGREGAR COMENTARIOS

CREAR ORDEN CON CARRITO VIRTUAL
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/orders POST
{ “docto_ve_id”: 515, “tipo_docto”: “Pedido”, “estatus”: “P”, “vendedor_id”: 123, “cliente_id”: 4, “estatus_pago”: “P”, “metadata_pago”: { “pasarela_pago”: “2” }}		 { “status”: “OK”, “data”: { “error”: true, “message”: “Orden creada con exito”, “getCartId”: { “cliente_id”: 4, “carrito_id”: 515, “orden_id”: 517 } }}
RESPUESTAS: CREAR ORDEN CON CARRITO VIRTUAL
CASO Respuesta
Si el carrito existe Status: 200 OK
Si la orden ya fue creada Status: 200 OK { “status”: “OK”, “data”: { “error”: false, “message”: “El valor ya existe.”, “getCartId”: { “cliente_id”: 4, “carrito_id”: 515, “orden_id”: 517 } }}
Si el carrito NO existe Status: 200 OK { “status”: “OK”, “data”: { “error”: true, “message”: “No hay relación con el cliente” }}
Si el cliente NO existe Status: 200 OK { “status”: “OK”, “data”: { “error”: true, “message”: “El valor ya existe.”, “getCartId”: { “cliente_id”: 4, “carrito_id”: 515, “orden_id”: 517 } }}
Si el ID del cliente no tiene relacion con el ID del carrito Status: 201 Created
{ “status”: “OK”, “data”: { “error”: true, “message”: “No hay relación con el cliente”}}
Si el ID del carrito es null Status: 200 OK
{ “success”: true, “message”: “Falta el ID del carrito. Por favor, proporcione un ID válido en la ruta.”}
Si el tipo de documento es null Status: 200 OK
{ “success”: true, “message”: “Falta el tipo de documento. Por favor, proporcione un tipo de documento válido…”}
Si el estatus del documento es null Status: 200 OK
{ “success”: true, “message”: “Falta el estatus del documento. Por favor, proporcione un estatus válido.”}
Si el ID del vendedor es null Status: 200 OK
{ “success”: true, “message”: “Falta el ID del vendedor. Por favor, proporcione un ID válido en la ruta…”}
Si el ID del cliente es null Status: 200 OK
{ “success”: true, “message”: “Falta el ID del cliente. Por favor, proporcione un ID válido en la ruta.”}
Si el estatus de pago es null Status: 200 OK
{ “success”: true, “message”: “Falta el estatus de pago. Por favor, proporcione un estatus de pago válido.”}
Si el metadata de pago es null Status: 200 OK
{ “success”: true, “message”: “Falta la metadata de pago. Por favor, proporcione información de pago válida…”}
Si envias vacio cualquier parametro Status: 400 Bad Request
LISTADO DE ORDENES POR USUARIO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/orders/user/:user_id GET
 [ { “id_orden”: 517 }]
RESPUESTAS: LISTADO DE ORDENES POR USUARIO
CASO Respuesta
Si el usuario existe Status: 200 OK
Si el usuario NO existe Status: 200 OK { “message”: “El cliente no tiene ninguna orden.”}
Si el ID de orden es incorrecto Status: 200 OK
{ “message”: “el id carrito es incorrecto. Por favor, proporcione uno válido.”}
Si el cliente no tiene ninguna orden Status: 200 OK
{ “message”: “El cliente no tiene ninguna orden.”}
Si envias vacio cualquier parametro Status: 400 Bad Request

AGREGAR COMENTARIOS

ESTADO DE LA ORDEN
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/orders/:id_order/status GET
 [ { “cliente_id”: 4, “estatus_orden”: “P”, “estatus_pago”: “P” }]
RESPUESTAS: ESTADO DE LA ORDEN
CASO Respuesta
Si la orden existe Status: 200 OK
Si la orden NO existe Status: 200 OK { “message”: “No existe Orden.”}
Si el ID de orden es incorrecto Status: 200 OK
{ “message”: “el ID de la orden es incorrecto. Por favor, proporcione uno válido.”}
Si envías vacio cualquier parametro Status: 400 Bad Request

AGREGAR COMENTARIOS

ACTUALIZAR ESTADO DE PAGO DE LA ORDEN
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/orders/:id_order/status POST
{ “estatus_pago”: “pagado”}		 { “status”: “OK”, “data”: true}
RESPUESTAS: ACTUALIZAR ESTADO DE PAGO DE LA ORDEN
CASO Respuesta
Si la orden existe Status: 200 OK
Si la orden NO existe Status: 200 OK { “status”: “OK”, “data”: { “message”: “No existe Orden.” }}
Si el ID de orden es incorrecto Status: 201 Created*
{ “status”: “OK”, “data”: { “message”: “el ID de la orden es incorrecto. Por favor, proporcione uno válido.”}}
Si es el estatus de pago es null Status: 200 OK
{ “success”: true, “message”: “Falta el estatus del pago. Por favor, proporcione un valor.”}
Si envías vacío cualquier parametro Status: 400 Bad Request

AGREGAR COMENTARIOS

ACTUALIZAR ESTADO DE LA ORDEN
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/ordenes/:id_order/estado-orden POST
 { “status”: “OK”, “data”: true}
RESPUESTAS: ACTUALIZAR ESTADO DE LA ORDEN
CASO Respuesta
Si la orden existe Status: 200 OK
Si la orden NO existe Status: 200 OK { “status”: “OK”, “data”: { “message”: “No existe Orden.” }}
Si el ID de orden es incorrecto Status: 201 Created*
{ “status”: “OK”, “data”: { “message”: “el ID de la orden es incorrecto. Por favor, proporcione uno válido.”}}
Si es el estatus de pago es null Status: 200 OK
{ “success”: true, “message”: “Falta el estatus de la orden. Por favor, proporcione un valor.”}
Si envías vacío cualquier parametro Status: 400 Bad Request

AGREGAR COMENTARIOS

MUESTRA LA LISTA DE CATEGORIAS
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/products/category GET
 Muestra las categorias disponibles
RESPUESTAS: MUESTRA LA LISTA DE CATEGORIAS
CASO Respuesta
Si categorias existe Status: 200 OK
Si no hay categorias en las tablas Status: 200 OK
{ “success”: true, “message”: “Ocurrió un problema al procesar la solicitud, pero la operación continúa.”

AGREGAR COMENTARIOS

CREAR UN ID INVITADO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/invitado GET
 { “nombre”: “Invitado”, “cliente_id”: 95}
RESPUESTAS: CREAR UN ID INVITADO
CASO Respuesta
Si el invitado NO existe Status: 200 OK
Si el invitado existe Status: 200 OK

AGREGAR COMENTARIOS

paginación para obtener todos los productos

PAGINACIÓN PARA OBTENER TODOS LOS PRODUCTOS
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/getOrders/category/pag POST
{ “perPages”: 5, “current_page”: 1, “searchQuery”: “” }		 En este caso te muestra 5 productos de la pagina 1
RESPUESTAS: PAGINACIÓN PARA OBTENER TODOS LOS PRODUCTOS
CASO Respuesta
Si el producto existe Status: 200 OK
Si el campo de entrada “perPages” y/o “current_page” es null Status: 200 OK
{ “success”: true, “message”: “Campo vacío. Por favor, proporcione un ID válido en la ruta.”}
Si envías vacío cualquier parametro Status: 400 Bad Request

AGREGAR COMENTARIOS

OBTENER CARRITOS DE UN USUARIO
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/getUserCarrito/4 GET
 [ { “nombre_cliente”: “Mariana Duarte”, “carritos_id”: [ 514, 515 ] }]
RESPUESTAS: OBTENER CARRITOS DE UN USUARIO
CASO Respuesta
Si el cliente existe Status: 200 OK
Si el cliente NO existe Status: 200 OK [ { “nombre_cliente”: “name”, “carritos_id”: null }]
Si el cliente no tiene carritos Status: 200 OK [ { “nombre_cliente”: “Mario Duarte”, “carritos_id”: null }]

AGREGAR COMENTARIOS

PAGINACIÓN PARA OBTENER TODAS LAS CATEGORIAS
Url Parametros Respuesta
https://devdaiko.wintook.com/v1/api/getOrders/CategoryPag POST
{ “perPages”: 5, “current_page”: 1, “searchQuery”: “” }		 En este caso te muestra 5 categorias de la pagina 1
RESPUESTAS: PAGINACIÓN PARA OBTENER TODAS LAS CATEGORIAS
CASO Respuesta
Si el producto existe Status: 200 OK
Si el campo de entrada “perPages” y/o “current_page” es null Status: 200 OK
{ “success”: true, “message”: “Campo vacío. Por favor, proporcione un ID válido en la ruta.”}

AGREGAR COMENTARIOS

BASE name
Url Parametros Respuesta
url GET
 VALORES
RESPUESTAS: name
CASO Respuesta
Si el producto existe Status: 200 OK
Si el producto NO existe Status: 200 OK

AGREGAR COMENTARIOS