Este artículo presenta los pasos para cargar y descargar productos con la API de Scantrust. Primero, necesitará un token UAT con los siguientes permisos:
- producto_crear
- eliminar producto
- edición_de_producto
- vista del producto
También necesitarás al menos una marca configurada en el Portal: cada producto que crees debe estar asignado a una marca.
Importante:
Para acceder a la API REST de Scantrust, puede utilizar una plataforma de API como Postman, la más popular del mundo, con más de 17 millones de usuarios y 500 000 organizaciones en todo el mundo. La herramienta ofrece un entorno flexible y colaborativo que le permite diseñar, desarrollar, documentar y probar sus API con mayor rapidez.
Puedes probar la aplicación web o descargar e instalar esta aplicación desde este enlace: https://www.postman.com/downloads/ En cualquier caso, deberá registrarse con una dirección de correo electrónico válida.
Nota: En el contexto de Scantrust, Postman solo debe usarse con fines de prueba. No debe utilizarse en escenarios reales ni en implementaciones de proyectos.
Pasos para configurar Postman:
1. Abra Postman. En la página de inicio, debería ver lo siguiente:
2. Luego, haga clic en la pestaña "Workspaces" en la esquina superior izquierda:
3. Luego, haz clic en la opción “My Workspace”:
4. Una vez que esté en su espacio de trabajo, haga clic en el signo “+” de la siguiente manera:
5. Después de eso, aparecerá una nueva pestaña con una solicitud de API preconfigurada: GET:
6. Ahora es importante configurar la Autorización de la API. Para ello, haga clic en la pestaña "Autorization":
7. A continuación, haga clic en la sección "Type" y seleccione la opción "API Key", como se indica a continuación:
8. Ahora, escriba la palabra "Autorización" en el campo clave, luego copie su token UAT del portal ST y péguelo en el campo "Value", incluyendo los caracteres UAT. UAT [tu token], dejando una barra espaciadora entre la cadena UAT y el token:
9. Luego, vaya a la pestaña “Body”, seleccione “raw” y seleccione “JSON”:
Pasos para cargar productos con la API de Scantrust
1. En este punto, ya puede cargar un producto mediante la API de Scantrust. Para el primer paso, debe cambiar la solicitud de la API a POST. Haga clic en el botón de solicitud y seleccione la opción "POST".
2. Para configurar esta solicitud, deberás escribir la URL, que en este caso es la siguiente: https://api.scantrust.com/api/v2/products/:
3. Luego, en la pestaña del cuerpo, escribe lo siguiente:
{
"sku": "PR3",
"marca": 2841,
"nombre": "Producto tres",
"description": "El tercer producto de una línea de muchos otros.",
"url_del_cliente": "http://www.examplebrand.com/productone",
"campaña": 575
}
Donde el SKU se refiere al SKU único del producto en la empresa, la marca se refiere al ID (entero) o referencia (cadena) de la marca, y el nombre se refiere al nombre del producto. Todos estos son campos obligatorios para establecer la solicitud.
Por otro lado, el campo de descripción se refiere a una breve descripción del producto; la URL del cliente se refiere a la URL del producto que puede usarse para redirigir códigos si no hay una campaña activa para el producto; y la imagen permite incluir una imagen del producto, generalmente usada en las páginas de destino de STC. Si no se configura, se usará la imagen de la marca y la campaña, que es el ID de una campaña existente en la empresa a la que se debe agregar este producto. Todos estos son campos opcionales.
4. Una vez que termine su script de código, podemos hacer clic en el botón ENVIAR:
5. Cuando un producto se publica correctamente, la respuesta se ve así:
Si la carga fue exitosa, la respuesta de estado debería ser 200 o 201. Luego puede verificar en el portal Scantrust la creación de este nuevo producto.
Pasos para descargar productos con la API de Scantrust
Necesitará un token UAT con los siguientes permisos:
- product_view
En este caso, recuperaremos la información del producto de una empresa completa o de un producto específico utilizando solo el SKU del producto.
1. Por favor, vaya a su espacio de trabajo en Postman y abra una nueva pestaña con el signo “+”:
2. Luego, vaya a la pestaña “Body” y seleccione “none”:
3. Para poder descargar información del producto, deberá configurar una solicitud GET ingresando la URL, que en este caso es la siguiente: https://api.scantrust.com/api/v2/products/:
4. Luego, haga clic en el botón ENVIAR:
5. Cuando la solicitud de API fue exitosa, la respuesta de estado debe ser 200 y se proporcionará la respuesta:
Esta respuesta incluye todos los productos que están incluidos en su empresa, con atributos específicos como SKU, nombre, descripción, marca y otros.
6. Si desea conocer información específica del producto, deberemos configurar la solicitud GET ingresando la URL, que en este caso es la siguiente: https://api.scantrust.com/api/v2/products/?sku_exact=[SKU]:
En este caso, la respuesta incluye solo la información del producto del ID que usted indicó en la URL.
Comentarios