🛠️Integración de API

Paso 1: Crea tu organización

Si aún no tienes una organización, por favor contacta a [e-mail] para obtener un código de acceso y soporte. Alternativamente, es posible que otros miembros de tu equipo ya hayan creado una organización.

Paso 2: Acceso de administrador

Para configurar el acceso a la API, necesitarás acceso de administrador a la organización. Si no eres el propietario de la organización o no tienes acceso de administrador, por favor contacta a un administrador para obtener los permisos necesarios. Los permisos de administrador se pueden de la siguiente forma:

1. Consola de administración -> Administrar Usuarios -> Añadir Usuario

2. Copia el enlace y compártelo con el usuario

3. Una vez que el usuario se haya registrado, otorga permisos de administrador con:

4. Administrar Usuarios -> Selecciona la casilla de Administrador en la fila de ese usuario

Paso 3: Token de autorización

Para poder enviar datos a la API de integración, necesitarás un token, que otorgará acceso a usar todos los endpoints de la API de Integración en nombre de tu organización. Sigue estos pasos:

1. Consola de Administración -> Configuración de API de Integración v2

2. Selecciona: Generar Nuevo Token

3. Almacena este token de forma segura. Puedes revocar tokens seleccionando la opción "revocar". El token no expirará automáticamente. Recomendamos reemplazar el token periódicamente por uno nuevo.

Extra (no requerido): para más detalles sobre tokens que no expiran automáticamente y cómo gestionarlos de la mejor manera, por favor leer la documentación relevante de OAuth 2.0.

Paso 4: Códigos de organización y espacios de trabajo

En preparación para el paso 5, también necesitarás el código de tu organización y espacios de trabajo de la Consola de Administración. Esto te permitirá dirigir tus solicitudes de API a la organización y espacios de trabajo correctos. Usuarios de Paqtana en tu organización necesitarán crear espacios de trabajo según la configuración que hayan diseñado. Después de confirmar esto, puedes obtener los códigos siguiendo estos pasos:

1. Consola de Administración -> Administrar Espacios de Trabajo

2. Anota el código de organización que se encuentra sobre la tabla de los espacios de trabajo

3. Anota el valor de la columna Código de cada espacio de trabajo.

Paso 5: Preparar cargas JSON

Para la implementación más sencilla, recomendamos usar solo dos endpoints de nuestra API:

PUT api.paqtana.com/v2/org/{org}/master_inventory
POST api.paqtana.com/v2/org/{org}/historical_demand

1. El primer endpoint recibe datos maestros de inventario. Cada solicitud enviada reemplazará todos los datos del payload anterior (un endpoint estándar PUT).

2. El segundo endpoint (POST) recibe datos históricos de demanda. Esto se puede enviar en segmentos y los datos almacenados se combinarán. Si se envía nuevamente el mismo día e ítem(localidad+código), los nuevos datos reemplazarán el valor anterior para ese día/ítem específico. Los demás datos que no se reemplacen permanecerán igual.

Un escenario común es enviar uno o más segmentos iniciales de datos históricos de demanda que cubran, por ejemplo, un año. Después de esto, es común enviar solo los datos de los últimos días según sea necesario. Por favor, revisa las estructuras JSON para cada uno de estos endpoints en nuestra Referencia de API. Nota: estos endpoints están diseñados para dirigirse a todos los espacios de trabajo a la vez. Por lo tanto, los códigos de los espacios de trabajo deben colocarse en los parámetros workspaceCode en las cargas JSON, como se puede ver en la referencia.

Paso 6: Envío de datos

Consejo: Un ejemplo completo de la implementación básica que recomendamos se puede encontrar en nuestro Ejemplo de Postman.

Para finalizar la integración, vas a necesitar el token de autorización, los datos JSON y que tu organización en Paqtana esté lista con los espacios de trabajo. Hay muchas opciones de implementación para enviar datos, pero los siguientes pasos son para la implementación básica que recomendamos en la mayoría de los casos:

1. Incluye el token en el encabezado de todas las solicitudes de la siguiente manera:

Authorization: Bearer <token>

1. Envíar datos maestros de inventario. Recuerda, esto debe contener todos tus datos maestros de inventario, los cuales reemplazarán los datos anteriores en ese endpoint. Asegúrate de que {org} sea reemplazado por el código de tu organización en ambas solicitudes.

2. Enviar datos históricos de demanda. Recuerda, puedes enviar tus datos iniciales en lotes más grandes, antes de configurar una actualización regular más pequeña. El tamaño máximo de la carga útil es de 32MB. Como este es el último endpoint en este ejemplo, asegúrate de incluir siempre auto_calculate=True como un parámetro (query string) para generar y ver las sugerencias de pedidos al enviar los datos de la siguiente manera:

api.paqtana.com/v2/org/{org}/historical_demand?auto_calculate=True

Paso 7: Revisar el resultado y automatizar el proceso

Ahora puedes volver a la interfaz de Paqtana y ver los resultados en la tabla de pedidos. Ten en cuenta que el planificador de la cadena de suministro querrá configurar los grupos, eventos del calendario y otras opciones en Paqtana antes de estar completamente operativo. Ahora puedes automatizar el proceso de envío de datos desde tu ERP, BI o proceso independiente. Recomendamos enviar los datos una vez al día, cuando sea óptimo para tu organización.

Recursos adicionales:

1. Referencia API

2. Ejemplo de Postman