INTRODUCCIÓN:

¡Bienvenido al API de Transacciones de iMotriz! Nuestra API está especialmente diseñada para facilitar la consulta de pedidos generados en tu tienda virtual en iMotriz, permitiéndote integrarlos de manera sencilla en tu aplicación o sistema existente.

En iMotriz, nos preocupamos por brindarte una experiencia de integración sin complicaciones. Nuestra API ha sido desarrollada pensando en la facilidad de uso y en ofrecerte una integración fluida con tu aplicación o sistema actual. Además, hemos preparado una documentación completa y clara que te guiará paso a paso en el proceso de integración.

Estamos emocionados de trabajar contigo y ayudarte a aprovechar al máximo las funcionalidades de nuestra API de Transacciones.

REQUISITOS PARA USAR LA API:

1. 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.

Open

Open

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 a la 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.

2. Configura la fecha desde la cual se deben empezar a sincronizar los pedidos:

Estando en la sección Administrar tienda -> Configuración busca el apartado "Integración API" en el panel lateral izquierdo. Allí podrás encontrar un campo de fecha “Sincronizar pedidos desde:” Selecciona la fecha a partir de la cual deseas que los pedidos comiencen a registrarse a través del API, ten presente que el sistema te permitirá retroceder un máximo de 30 días frente a la fecha actual.

Una vez establezcas la fecha deberás guardar la configuración para que se apliquen los cambios.

RECURSOS DE API DISPONIBLES:

• Nuevas transacciones

Este endpoint permite consultar los nuevos pedidos que aún no han sido marcados como sincronizados. Solo se devolverán los registros que no hayan sido consultados anteriormente y que se encuentren en el rango de fecha configurado en tu tienda virtual de iMotriz.

El endpoint retornará un máximo de 30 registros en formato JSON, donde cada registro incluirá tres partes:

1. order: Detalles sobre el pedido realizado.

2. products: Información detallada sobre los productos incluidos en el pedido.

3. buyer: Información del cliente que realizó el pedido.

La información mencionada anteriormente estará disponible en el campo "data" de la respuesta. Además, la respuesta contendrá metadatos (metadata) que indicarán tres datos numéricos:

1. total_transactions_found: La cantidad total de pedidos nuevos que no han sido marcados como sincronizados.

2. returned_transactions: La cantidad de pedidos incluidos en la respuesta actual.

3. pending_transactions: La cantidad de pedidos que aún no se han consultado y quedan pendientes.

Los pedidos consultados en esta petición se marcarán como sincronizados, por lo cual no se volverán a reportar al consultar este endpoint.

En caso de que existan registros pendientes por consultar, se deberá realizar una nueva petición al mismo endpoint para obtener los pedidos restantes.

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.

Aquí tienes un ejemplo de como se vería la respuesta:

En caso de que quieras marcar una transacción como no sincronizada, deberás manualmente dar clic en el icono de sincronización, el cual te pedirá confirmar la acción para marcar como no sincronizada la transacción.

Al dar clic en “Aceptar” la transacción se marcará como no sincronizada, por lo tanto, se volverá a reportar en la próxima petición que realices para conocer los nuevos pedidos disponibles.

• IDs de los pedidos de los últimos 8 días

Este endpoint retorna los IDs de todos los pedidos de los últimos 8 días o dentro del rango de fecha configurado para la sincronización de pedidos en la tienda virtual. Devuelve los IDs de las transacciones sin importar si están marcadas como sincronizadas con la API.

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.

Aquí tienes un ejemplo de como se vería la respuesta:

Ten en cuenta que esta solicitud no tiene un límite específico de registros para devolver. Se recuperarán todos los IDs de pedidos encontrados en los últimos 8 días sin ninguna restricción en cuanto a la cantidad.

• Consulta un pedido específico

Este endpoint permite consultar un pedido específico utilizando su ID. El sistema buscará el pedido dentro del rango de fechas configurado en la tienda virtual para la sincronización de pedidos a través de la API y devolverá la información correspondiente al pedido.

En caso de no encontrar el pedido, se devolverá un error 404 indicando que el pedido no ha sido encontrado.

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 "id_del_pedido_en_imotriz" por el ID del pedido que deseas consultar.

Aquí tienes un ejemplo de como se vería la respuesta:

LISTADO DE ERRORES