Estructura de llamadas a la API rest de Sales Layer
Toda llamada a la API se deberá realizar a través este subdominio:
https://api.saleslayer.com
Envío de petición desde el cliente
El cliente deberá incluir los parámetros necesarios para poder ejecutar correctamente la consulta. Dichos parámetros pueden incluirse en la propia URL mediante GET o en el cuerpo de la llamada mediante POST.
Parámetros obligatorios de identificación y securización
code | Código de relación de conector. |
time | timestamp() (Fecha UNIX internacional) |
unique | mt_rand() o rand() (Número aleatorio de seguridad) |
key256 | Código SHA2 con la combinación de 'code' + 'secret_key' + 'time' + 'unique' |
Resto de parámetros modeladores
Los siguientes parámetros modeladores solo se podrán utilizar en peticiones GET.
last_update | Timestamp (fecha UNIX) de última actualización de datos. Si este parámetro no se envía, se presupone que hay que devolver toda la estructura de datos de catálogo completa, ya que el cliente está pidiendo instalar datos por primera vez o refrescarlos completamente. Nota: cualquier modificación del conector reinicializará la fecha de last_update. |
ver | Versión de la API sobre la que se desea trabajar. Si se omite este parámetro se presupone la versión 1.17. Actualmente, tenemos las versiones 1.17 y 1.18 activa. |
pagination | Parámetro existente solo para la versión 1.18 y corresponde al número de ítems por página. Atento: este número es figurativo, pues nuestra API trabaja con rangos de números. Por ejemplo, si seleccionamos una pagination menor que 1000, serán exportados 500 ítems. Si seleccionamos una pagination entre 1001 y 1500, 1000 ítems serán exportados, etc. Por defecto, si no enviamos el parámetro de pagination, serán exportados 1000 ítems. |
compression | Booleano para indicar si se prefiere la respuesta comprimida o no. Por defecto: 1 (sí mientras sea posible para el cliente). |
test | Indica que se requiere únicamente verificar la conexión y la autentificación. |
group_category_id | Booleano: por defecto 0, Si se activa a 1, la API devolverá agrupados los productos multicategoría. Si este parámetro de deja a 0, la API devolverá una entrada de producto por cada categoría asociada a él, y también devolverá el resultado de multiplicar cada uno de estos productos por sus respectivos formatos asociados, creando un ID para el formato resultante de aplicar una combinación del ID del producto y el formato (se recomienda activar a 1 siempre). |
group_category_delimiter | Delimitador de valores multicategoría agrupada. (Por defecto salto de línea). |
parents_category_tree | Booleano: por defecto 0, si se activa a 1, la API devolverá los datos de las categorías pertenecientes al árbol superior, de todas las categorías que hayan sido objeto de modificación, por sí mismas, o bien indirectamente por haberse modificado un producto asociado a ellas. |
same_parent_variants | Booleano: por defecto 0, si se activa a 1, la API devolverá como modificados los datos de todos aquellos formatos que comparten un mismo producto padre, cuando haya sido modificado alguno de estos formatos. |
get_file_refereneces | Booleano: por defecto 0, si se activa a 1, la API devolverá los nombres de las imágenes/archivos como índices en vez del código hash. |