Entrada de datos y estructura

En la documentación de la API de Sales Layer, las solicitudes GET se utilizan para recuperar información y las solicitudes POST se utilizan para importar información.

Los ejemplos anteriores muestran cómo trabajar con la API a través del SDK. Este artículo explica cómo probar la misma API en Postman.

Para probar solicitudes GET, crea un conector genérico. Para probar solicitudes POST, crea un conector de importación. Ambos se pueden editar desde la Tienda de canales.

En el conector genérico, configura los idiomas, el estado de los ítems, y las tablas y campos que quieres exportar.

En el conector de importación, configura los idiomas que quieres importar y los campos que quieres recibir. Los nombres de los campos en el conector de importación deben coincidir exactamente con la estructura de input_data.

Otra configuración importante en los conectores de importación es la opción que decide si el conector debe importar solo ítems existentes.

Si quieres crear ítems nuevos, selecciona No en esa primera opción.

En Postman

Para empezar, instala la aplicación de Postman o utiliza su versión en la nube. Antes de hacer pruebas, asegúrate de entender los parámetros obligatorios y opcionales de la API.

La URL de la solicitud es: https://api.saleslayer.com.

Tanto las solicitudes GET como las POST utilizan los mismos parámetros obligatorios:

• code: identificador del conector
• time: marca de tiempo UNIX actual
• unique: número aleatorio de seguridad
• key: combinación de los tres parámetros anteriores más la clave privada
• key256: versión SHA256 de esa firma

Define esos parámetros en la pestaña Params de Postman.

Si utilizas SHA256, envía el parámetro como key256 en lugar de key.

Para generar los valores automáticamente, define variables en Postman y añade un script de pre-solicitud.

El script de ejemplo establece el código del conector, la clave privada, el valor aleatorio, la marca de tiempo UNIX actual y la firma SHA256 final. La misma lógica también se puede implementar de otras formas.

pm.globals.set("code", "ID_connector");
var secret_key = "secret_key";
var unique = Math.round(Math.random() * 100000);
pm.globals.set("unique", unique);
var timeInSeconds = parseInt((new Date()).getTime() / 1000);
pm.globals.set("time", timeInSeconds);
var sigString = pm.globals.get("code") + secret_key + timeInSeconds + unique;
var CryptoJS = require("crypto-js");
var key = CryptoJS.SHA256(sigString);
pm.globals.set("key256", key.toString());

Para las solicitudes POST, cambia el tipo de solicitud, ve a Body, selecciona Raw y JSON, y envía la estructura input_data que coincida con tu conector de importación.

Cuando todo esté listo, haz clic en Send.

Interpretar los resultados

Solicitud GET

Después de una solicitud GET, la API devuelve una respuesta JSON que incluye las estructuras conocidas en data_schema y la información modificada en data.

Si trabajas con last_update, es útil prestar atención al tiempo de respuesta de la llamada anterior. Cuando hay información que eliminar, la API exporta esos ítems con estado D.

Solicitud POST

Después de una solicitud POST, la API devuelve el resultado de la importación. Ten en cuenta que la respuesta exacta puede variar según la versión de API utilizada.

En el ejemplo original, la respuesta de importación se muestra con la versión 1.17 de la API, que era la versión predeterminada en ese momento.

Extra: trabajar con parámetros opcionales

Los parámetros opcionales de exportación también se pueden probar en Postman enviándolos como parámetros de solicitud separados.

Un ejemplo habitual es last_update. Puedes tomar el valor response_time de la solicitud anterior y utilizarlo como valor de last_update en la siguiente para recuperar solo los cambios realizados entre ambas sincronizaciones.

Otro ejemplo es group_category_id, que acepta los valores 0 y 1. Según el valor enviado, la API exportará los productos multicategoría agrupados en un único registro o repetidos por categoría.