API REST

¿Qué es la API de Webered?


Una API (Application Programming Interface por sus siglas en Inglés) o Interfaz de Programación de Aplicaciones permite que otras aplicaciones o servicios externos se integren a tu Tienda Webered.

A través de la API es posible realizar acciones del tipo ABM Alta, Baja y Modificación de ciertos datos de la Tienda.

Nuestra API es de tipo REST, y utiliza JSON para el intercambio de datos.

⚠️ IMPORTANTE : Para poder utilizar la API, es necesario contar con un certificado SSL instalado en el dominio o subdominio de la Tienda.


Documentación de la API de Webered :


Acceso a la API
El primer paso para poder utilizar la API es generar una clave, para ello hay que dirigirse al panel de control y entrar en la sección Configuración -> API. Una vez allí, presionar el botón "Generar" para obtener la clave.

Todos los accesos a la API son dentro del dominio del sitio y bajo HTTPS únicamente.
Si el sitio web no cuenta con SSL no podrá utilizar la API.
https://{DOMINIO DEL SITIO WEB}/pw/api
La URL debe incluir el valor "apikey={CLAVE DE API DEL SITIO WEB}".

API REST

La API opera con los siguientes métodos HTTP:
GET: obtener recursos.
POST: crear recursos.
PUT: actualizar recursos.
DELETE: borrar recursos.

Formato de las respuestas
Todos los datos son devueltos en formato JSON.
El código de estado HTTP será 200 si no ocurrió ningún error.
El código de estado HTTP será 4xx si ocurrió algún error y se incluye también dentro de la respuesta JSON. Por ejemplo:

error-5fa96a6612f29.png


Puntos de acceso


1 - Productos

1.1 - Obtener todos los productos
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- page: número de página. Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado. Por defecto 100 si no es proporcionado (valor máximo).

Respuesta:
Lista de productos en formato JSON.

get-productos-5fa96612253f6.png


1.2 - Obtener un producto

URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- Ninguno.

Respuesta:
Datos de un producto en formato JSON.

get-producto-5fa9661b42f99.png


1.3 - Obtener las variantes 1 de un producto (por defecto, tamaños)
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}/variantes1?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- Ninguno.

Respuesta:
Lista de variantes en formato JSON.

get-producto-variantes1-5fa9662c5546f.png


1.4 - Obtener las variantes 2 de un producto (por defecto, colores)
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}/variantes2?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- Ninguno.

Respuesta:
Lista de variantes en formato JSON.

get-producto-variantes2-5fa966316f2ba.png


1.5 - Obtener las cantidades de stock de un producto
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}/stock?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- Ninguno.

Respuesta:
Lista de stock en formato JSON.

get-producto-stock-5fa966370b1d6.png


1.6 - Asignar una cantidad al stock de un producto.
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}/stock/asignar?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
PUT

Parámetros:
- variante1_id: ID numérico de variante 1.
- variante2_id: ID numérico de variante 2.
- cantidad: cantidad de stock a asignar.

Respuesta:
Registro con stock actualizado en formato JSON.

put-producto-stock-5fa9663b8a1d4.png


1.7 - Sumar una cantidad al stock de un producto.
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}/stock/sumar?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
PUT

Parámetros:
- variante1_id: ID numérico de variante 1.
- variante2_id: ID numérico de variante 2.
- cantidad: cantidad de stock a sumar.

Respuesta:
Registro con stock actualizado en formato JSON.


1.8 - Restar una cantidad al stock de un producto.
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/productos/{ID PRODUCTO}/stock/restar?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
PUT

Parámetros:
- variante1_id: ID numérico de variante 1.
- variante2_id: ID numérico de variante 2.
- cantidad: cantidad de stock a restar.

Respuesta:
Registro con stock actualizado en formato JSON.


2 - Variante 1 (por defecto, tamaños)

2.1 - Obtener todas las variantes
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/variantes1?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- page: número de página (opcional). Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado (opcional). Por defecto 100 si no es proporcionado (valor máximo).

Respuesta:
Lista de variantes en formato JSON.


2.2 - Obtener una variante

URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/variantes1/{ID VARIANTE}?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- Ninguno.

Respuesta:
Datos de una variante en formato JSON.


3 - Variante 2 (por defecto, colores)

3.1 - Obtener todas las variantes
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/variantes2?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- page: número de página. Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado. Por defecto 100 si no es proporcionado (valor máximo).

Respuesta:
Lista de variantes en formato JSON.


3.2 - Obtener una variante
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/variantes2/{ID VARIANTE}?apikey={CLAVE DE API DEL SITIO WEB}

Método HTTP:
GET

Parámetros:
- Ninguno.

Respuesta:
Datos de una variante en formato JSON.

Creado con Webered WEBERED