INTRODUCCIÓN:

¡Bienvenido al API de Productos de iMotriz! Nuestra API está diseñada para simplificar la creación, actualización y administración de productos de manera fácil y eficiente. Con nuestra solución, podrás gestionar tu inventario de productos de manera rápida y sin complicaciones.

Nuestra API te brinda la flexibilidad para crear nuevos productos en tu sistema con solo unos pocos pasos. Podrás especificar detalles como el nombre o descripción, precio, referencias y cualquier otra información relevante. Además, si necesitas actualizar la información de un producto existente, nuestra API te permite hacerlo de forma sencilla, garantizando que siempre tengas la información más actualizada en tu sistema.

Nuestra API está diseñada pensando en la facilidad de uso y la integración sencilla con tu aplicación o sistema existente. Además, contamos con una documentación completa y clara, que te guiará en cada paso del proceso de integración.

REQUISITOS PARA USAR LA API:

1. Crea una tienda virtual en iMotriz:

La creación de tu tienda es increíblemente fácil y puedes tenerla lista en menos de 5 minutos. No necesitas conocimientos técnicos avanzados ni habilidades de programación. Nuestro proceso de configuración guiado te llevará de la mano en cada paso. En pocos minutos, estarás listo para comenzar a vender tus productos en línea de forma rápida y sencilla. Crea tu tienda aquí.https://www.imotriz.com/store/proveedores

2. Crea una configuración de carga masiva para API:

Una vez que hayas creado tu tienda en iMotriz, dirígete al menú ubicado en la esquina superior izquierda de la pantalla. Allí, elige la opción "Administrar Tienda". Al seleccionar esta opción, se cargará la página principal de administración, donde encontrarás varias pestañas.

Open

Open

Para configurar la carga masiva de inventarios, haz clic en la pestaña "Inventarios" que será la primera en aparecer. Dentro de la pestaña "Inventarios", encontrarás un botón llamado "Carga Masiva". Haz clic en él y se abrirá una nueva pestaña con la página de configuraciones de carga masiva.

En esta página, busca y haz clic en la opción "Nueva Configuración".

Al hacerlo, se abrirá un modal donde podrás agregar un nombre para la configuración. Por ejemplo, puedes ingresar "Configuración API".

A continuación, selecciona la opción "Configuración para API" y completa el formulario de configuración con los datos necesarios. Una vez que hayas ingresado toda la información requerida, haz clic en "Guardar".

El modal se cerrará automáticamente y se cargará una previsualización de los datos de la configuración que has realizado. Además, se mostrará un JSON con los nombres de los atributos que serán requeridos para enviar al API y administrar tu inventario.

Con esta sencilla configuración de carga masiva, podrás agilizar y simplificar la administración de tu inventario en iMotriz, utilizando la potencia de nuestra API. ¡Aprovecha esta funcionalidad y maximiza la eficiencia de tu tienda en línea!

3. Crea un Token de autenticación para el API:

Para autenticarnos en el API, vamos a crear un token de autenticación. Para ello, dirígete al menú ubicado en la esquina superior izquierda de la pantalla y elige la opción "Administrar Tienda". Al seleccionar esta opción, se cargará la página principal de administración con varias pestañas disponibles.

Haz clic en el TAB "Configuración" y busca el apartado "Integración API" en el panel lateral izquierdo. A continuación, selecciona la opción "Generar Nuevo Token". El sistema generará automáticamente un token de autenticación API y lo asociará a tu cuenta.

Recuerda que este token es importante y deberás adjuntarlo en todas las peticiones que realices al API. Es la forma en que verificamos que realmente eres tú quien está accediendo a los recursos. Si en algún momento deseas generar un nuevo token, tienes la opción de hacerlo. Sin embargo, ten en cuenta que una vez cambies el token, los tokens anteriores dejarán de ser válidos para realizar consultas al API.

Asegúrate de mantener tu token de autenticación seguro y no compartirlo con nadie más. Con este mecanismo de autenticación, podrás acceder de manera segura a los recursos de nuestra API y aprovechar al máximo sus funcionalidades.

RECURSOS DE API DISPONIBLES:

1. Atributos requeridos:

Esta solicitud GET te devolverá los atributos de producto requeridos según la configuración de carga masiva para API establecida en tu tienda virtual.

En la respuesta se incluirá información detallada sobre los atributos, como su nombre, tipo de dato aceptado (por ejemplo, cadena de texto, número entero, booleano, etc.) y la longitud permitida en caso de que sea relevante. Puedes utilizar esta información para garantizar que todos los atributos necesarios se incluyan al crear un nuevo producto a través del API.

Ejemplo petición cURL:

Asegúrate de reemplazar "tu_token_de_autenticacion" con el token de autenticación real que has generado en la configuración de la integración API de tu tienda virtual.

2. Crear un producto:

Para enviar una solicitud exitosa, asegúrate de adjuntar el token de autenticación en la cabecera de la petición. Aquí tienes un ejemplo de cómo hacerlo utilizando cURL:

Asegúrate de reemplazar "tu_token_de_autenticacion" con el token de autenticación real que has generado en la configuración de la integración API de tu tienda virtual.

En el cuerpo de la solicitud, debes enviar un JSON con los atributos requeridos para crear el nuevo producto. Asegúrate de incluir todos los atributos necesarios, siguiendo las especificaciones obtenidas del endpoint "requiredAttributes". Los nombres y valores de los atributos deben coincidir con la estructura esperada por la API.

Es importante tener en cuenta que el atributo "code" será el identificador único del producto en la API de iMotriz. Este código se utilizará para actualizar el producto en el futuro, por lo que es fundamental proporcionar un código que no cambie y pueda ser utilizado de manera consistente para identificar el producto en todas las operaciones.

Al crear un nuevo producto a través del endpoint de creación, asegúrate de asignar un valor al atributo "code" que sea único y no esté sujeto a cambios. Este código debe ser significativo y fácilmente identificable, y se recomienda que sigas una convención de nomenclatura consistente para asegurarte de mantener la integridad y coherencia de tus productos en la API.

Es importante destacar que una vez que hayas asignado un código a un producto, debes utilizar el mismo código en futuras actualizaciones o consultas relacionadas con ese producto. Si cambias el código del producto, se considerará como un producto diferente en la API y cualquier actualización o consulta basada en el código anterior no se aplicará correctamente.

Al seguir estas recomendaciones y proporcionar un código estable y único para cada producto, podrás utilizar el atributo "code" como un identificador confiable para actualizar y administrar tus productos de manera efectiva a través de la API de iMotriz.

3. Actualizar un producto

Para actualizar un producto a través de la API de iMotriz, debes realizar una solicitud PATCH al mismo endpoint utilizado para crear productos. En esta ocasión, no es necesario adjuntar todos los atributos del producto en el cuerpo de la solicitud. Solo debes incluir el atributo "code", que es el identificador único del producto, y los atributos que deseas actualizar.

Aquí tienes un ejemplo de cómo realizar la solicitud de actualización utilizando cURL:

Asegúrate de reemplazar "tu_token_de_autenticacion" con el token de autenticación real que has generado en la configuración de la integración API de tu tienda virtual. Además, cambia "codigo_del_producto" por el código del producto que deseas actualizar y proporciona los atributos que deseas modificar con sus nuevos valores.

Al enviar esta solicitud POST, la API de iMotriz identificará el producto a través del atributo "code" y actualizará los atributos especificados con los nuevos valores proporcionados. Los demás atributos del producto se mantendrán sin cambios.

Recuerda que es importante incluir el atributo "code" en todas las solicitudes de actualización y asegurarte de que sea válido y coincida con un producto existente en tu tienda virtual. De esta manera, podrás realizar actualizaciones precisas y específicas en los atributos deseados sin afectar los demás datos del producto.

¡Utiliza esta metodología para actualizar eficientemente tus productos a través de la API de iMotriz, proporcionando únicamente los atributos que deseas modificar!

4. Consulta un producto existente:

Para consultar un producto existente a través de la API de iMotriz, realiza una solicitud GET y anexa el parámetro "code" para indicar el código del producto que deseas consultar.

Aquí tienes un ejemplo de cómo realizar la solicitud utilizando cURL:

Asegúrate de reemplazar "tu_token_de_autenticacion" con el token de autenticación real que has generado en la configuración de la integración API de tu tienda virtual. Además, cambia "codigo_del_producto" por el código del producto que deseas consultar.

Al enviar esta solicitud GET con el parámetro "code", la API de iMotriz buscará y devolverá la información del producto correspondiente al código proporcionado. La respuesta contendrá todos los atributos y detalles del producto consultado.

Recuerda que la consulta se realizará utilizando el código del producto como identificador único, asegúrate de proporcionar un código válido que corresponda a un producto existente en tu tienda virtual.

Utiliza esta funcionalidad de consulta para obtener información precisa y actualizada de tus productos a través de la API de iMotriz.

5. Creación y actualización de productos masivamente:

Para la creación y actualización masiva de productos en la API de iMotriz. Funciona de manera similar a la creación y actualización de productos individuales, pero con la capacidad de procesar varios productos al mismo tiempo.

Para utilizar este endpoint, debes enviar una solicitud POST con un array de productos en el cuerpo de la petición. Cada producto en el array debe incluir su propio atributo "code" para identificarlo de manera única. El sistema verificará si cada producto existe o no utilizando su "code". Si un producto con el mismo "code" ya existe, se actualizarán los atributos proporcionados; de lo contrario, se creará un nuevo producto.

Es importante tener en cuenta lo siguiente al utilizar este endpoint:

1. Para crear un nuevo producto, debes incluir todos los atributos requeridos según se especifica en el endpoint “requiredAttributes”.

2. Para actualizar un producto existente, solo es necesario proporcionar el "code" del producto y los atributos que deseas actualizar.

3. Ten en cuenta que se pueden enviar hasta un máximo de 10,000 productos en cada solicitud.

4. Es posible que los cambios realizados a través de esta funcionalidad masiva tarden hasta 30 minutos en reflejarse completamente en la plataforma iMotriz.

Asegúrate de utilizar correctamente este endpoint, enviando el array de productos con sus respectivos "code" y atributos para crear o actualizar los productos de manera eficiente y en lotes.

Aquí tienes un ejemplo de cómo realizar la solicitud utilizando cURL:

Asegúrate de reemplazar "tu_token_de_autenticacion" con tu token de autenticación real generado en la configuración de la integración API de iMotriz. Además, en el cuerpo de la solicitud, proporciona un array de objetos JSON, donde cada objeto representa un producto con su respectivo "code" y los atributos que deseas crear o actualizar.

¡Utiliza esta funcionalidad para administrar grandes volúmenes de productos en la API de iMotriz y agilizar tus procesos de creación y actualización!

LOG DE PROCESOS EJECUTADOS POR EL API DE INVENTARIOS

En una tienda virtual, en la seccion de inventarios → API, se encontrará una tabla que le permite visualizar el LOG DE PROCESOS ejecutados por el API:

La tabla permite identificar cuales de ellos fueron correctos, y cuales de ellos presentaron errores.

TABLA DE ERRORES DEL API DE INVENTARIOS: