API REST

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


Acceso a la API

Para poder utilizar la API es necesario primero generar una clave única para la tienda.

La clave puede obtenerse accediendo como administrador al panel de control de Webered y luego ingresando en la sección Configuración -> API Webered.

Una vez allí, presionar el botón "Generar" para obtener la clave.

Importante:
Todas las conexiones a la API deben realizarse mediante HTTPS.
La API puede utilizarse desde el dominio centralizado api.webered.com o desde el dominio propio de la tienda para mantener compatibilidad con integraciones existentes.


URL de acceso (recomendado)

La forma recomendada de acceder a la API es utilizando el dominio centralizado:
https://api.webered.com

Ejemplo:
https://api.webered.com/productos

La autenticación debe enviarse mediante el header HTTP:
Authorization: Bearer {CLAVE DE API}

Ejemplo usando cURL:
curl -X GET "https://api.webered.com/productos" \
-H "Authorization: Bearer {CLAVE DE API}"


Compatibilidad con integraciones existentes

Por compatibilidad, también es posible continuar accediendo a la API utilizando el dominio propio de la tienda y el parámetro apikey en la URL.
Ejemplo:
https://{DOMINIO_DEL_SITIO}/pw/api/productos?apikey={CLAVE DE API}

Este método se mantiene para integraciones existentes, aunque se recomienda utilizar el nuevo esquema con Authorization: Bearer.


Recomendaciones de seguridad

  • Utilizar siempre conexiones HTTPS.
  • No compartir ni exponer la clave de la API públicamente.
  • Evitar enviar la clave en URLs de nuevas integraciones.
  • Se recomienda utilizar el header Authorization: Bearer.
  • No se acepta recibir la clave en header y URL al mismo tiempo en una misma petición.


Formato de códigos

Muchos de los recursos administrables mediante la API necesitan un código identificatorio.
Este código se recomienda que sea alfanumérico (A-Z, 0-9) y puede incluir guiones como separadores (guion medio: "-", guion bajo: "_"). Además, la longitud del código no puede superar los 50 caracteres.

Ejemplo:
https://api.webered.com/productos/{CODIGO PRODUCTO}
CODIGO PRODUCTO debe ser alfanumérico y puede incluir guiones: "ABC-123", "67890", "ZXCVBN".

Si el código incluye caracteres especiales que tienen significado propio en la construcción de URLs ("?", "/", ".", "&", "=") es necesario codificar ese valor en formato Base64 URL, de lo contrario la API no lo reconocerá como parte del valor a manejar.
Debe ser enviado de esta manera:
https://api.webered.com/productos/base64:{CODIGO PRODUCTO}

El formato Base64 URL es una variante del Base64 común en el que se realizan estos reemplazos:
- Se eliminan los signos "=".
- Se reemplaza el signo "+" por "-".
- Se reemplaza el signo "/" por "_".

Ejemplo:
Si el código original es "PROD/XL" su valor en Base64 URL es "UFJPRC9YTA" y debe ser enviado así:
https://api.webered.com/productos/base64:UFJPRC9YTA

Creado con Webered WEBERED