Guía para desarrolladores de la API REST de datos

Editar en línea

La guía para desarrolladores de la API REST de datos de optimización de inventario de Maximo de IBM®, explica cómo usar y aplicar las API de datos REST.

Introducción

Las API basadas en REST están disponibles para interactuar con la aplicación Maximo Inventory Optimization Data de IBM.

Aceso a la API de datos

Para acceder a la documentación de referencia de la API de datos, vaya a API de datos IBM Maximo Inventory Optimization.

Integración de datos

Los datos deben transferirse entre el ERP y el módulo Maximo Inventory Optimization ( IBM ) para permitir la ejecución de análisis y optimización. La API de datos proporciona la interfaz para que los desarrolladores se comuniquen sin problemas entre su ERP y IBM Maximo Inventory Optimization Inventory with HTTPS.

Las API de descarga de datos recuperan los cambios exportados desde IBM Maximo Inventory Optimization para su integración en el ERP del cliente. También se utilizan para activar una actualización de datos diaria o mensual, y cargar datos de nuevo en IBM Maximo Inventory Optimization.

El uso de extracciones y exportaciones de API aumenta su eficiencia y las automatiza de manera segura.

¿Qué es una API?

API son las siglas de Application Programming Interface (interfaz de programación de aplicaciones). Mediante una API, las funciones de una aplicación se ponen a disposición de otras aplicaciones fuera de ese producto. Las API son interfaces que constan de dos parte de software que interactúan entre sí.

Las API públicas permiten a los desarrolladores trabajar en nombre del cliente para integrar Maximo Inventory Optimization de IBM con otros sistemas internos o externos.

El uso de API permite a los usuarios integrar el software de optimización de inventario Maximo de IBM en sus propios procesos empresariales y permite una automatización más eficiente de dichos procesos.

Las API de site.data.keyword.iot_mmio_full_notm se implementan como servicios web RESTful. REST (Representational State Transfer) es un estilo de arquitectura de software. REST se rige por restricciones específicas, incluida la comunicación a través del protocolo HTTP, lo que hace que su programación sea relativamente estable.

¿Qué se puede hacer con las API de datos?

Enviar datos: El uso de las API de Optimización de inventario de Maximo de IBM permite que los conectores reenvíen datos automáticamente a la Optimización de inventario de Maximo de IBM. Cada tipo de datos MIO tiene un punto final API asociado.
renovar datos: Los datos se pueden renovar diariamente o a fin de mes (FDM). Las solicitudes de actualización de datos pueden automatizarse aún más a través de la optimización de inventario Maximo de IBM.; Aparte de iniciar y llevar a cabo la renovación de datos, también es posible comprobar el progreso de la renovación de datos. Los datos se renuevan para asegurarse de que las transferencias dañadas se pueden suprimir y repetir hasta que sean satisfactorias.
Recuperación de datos: La recuperación de conjuntos de datos exportados también se puede automatizar, garantizando que toda la información disponible sea precisa y esté actualizada.
Supresión de datos: Si ha fallado las transferencias o cargas, se pueden realizar solicitudes para suprimir cargas útiles específicas.

Seguridad

Las API de Maximo Inventory Optimization de IBM utilizan el protocolo HTTPS ( HTTPS ). El protocolo encripta la comunicación a través de Internet, requiriendo autenticación y protegiendo la privacidad e integridad de los datos.

La autenticación requiere una clave de API. La autenticación de la API es específica del entorno, por lo que cuando el cliente tiene acceso a más de un entorno, se necesitan distintas credenciales de clave de API.

Se genera una clave específica de cliente por entorno. La clave de API que se utiliza para el entorno de recinto de pruebas sería diferente de la clave de API que se utiliza para acceder al entorno de producción.

La autenticación es con una clave de API.
La clave de API es un mínimo de 32 caracteres que consta de números, letras mayúsculas y minúsculas. La clave de API se puede cambiar con una solicitud de soporte.
La API de Maximo Inventory Optimization está detrás de un cortafuegos de aplicaciones web (WAF). Las reglas en vigor restringen las solicitudes repetidas de alto volumen, mitigando contra un ataque de fuerza bruta y DDOS.
Comunicación cifrada a través de HTTPS.

Nota: Cualquier persona que conozca esta contraseña puede interactuar con las API, por lo que es necesario que el cliente mantenga estas contraseñas seguras.

Documentación de referencia

Hay documentación de referencia disponible sobre el uso de los puntos finales de API. Los desarrolladores pueden interactuar con la interfaz de usuario Swagger de la API en IBM Maximo Optimización de inventario API de datos.

Nota: La interacción con algunos puntos finales requiere credenciales de autorización.

¿Qué hay disponible en la documentación de referencia?

Breves descripciones de los puntos finales
Designación de parámetros
Mandatos curl de ejemplo
Información de formato de entrada
Formatos de respuesta
Códigos de estado y de error de HTTP El formato de respuesta las API es JSON (JavaScript Object Notation). Algunos de los puntos finales también pueden requerir un cuerpo de solicitud JSON.

¿Qué necesita hacer su programa?

Se sigue una serie de pasos sugeridos cuando se utilizan las API de Maximo Inventory Optimization ( IBM ) para extraer el máximo beneficio de su uso. Estos pasos se describen a continuación.

Extracción y carga de ERP a Maximo Inventory Optimization
1. Extraiga datos de ERP/EAM en formato de API. Para obtener más información, consulte Cómo configurar .CSV Extracts for Upload.
2. Coloque todos los archivos en un único archivo .zip.
3. Cargue el archivo .zip en /dataapi/upload/zip endpoint.
4. Asegúrese de que el archivo .zip se ha cargado correctamente.
Exportar y descargar MIO
1. Consulte periódicamente el punto final de descarga. Frecuencia decidida por los usuarios empresariales. La recomendación es cada hora. La frecuencia no debe ser superior a 24 horas.
2. Descargue el archivo de exportación .zip.
3. Extrae el contenido del archivo .zip.
4. Importar cambios del archivo de texto a ERP/EAM

Nota: Asegúrese, durante todo el proceso, de que los errores se están identificando y manejando.

Renovación FDM (fin de mes)

Su software toma varios extractos de su ERP y utiliza los puntos finales de la API de Maximo Inventory Optimization ( IBM ) para cargar estos extractos en IBM Maximo Inventory Optimization para su procesamiento. A final de mes, es necesario actualizar los datos para garantizar la integridad de los datos entre el ERP y la optimización de inventario Maximo de IBM.

El EOM Refresh se ejecuta enviando una solicitud POST al punto final EOM :

POST /refresh/eom

Compruebe la integridad emitiendo una solicitud GET al punto final de estado.

GET /refresh/status

Descargar las recomendaciones de MIO

Cuando se exportan las recomendaciones desde Maximo Inventory Optimization, están listas para descargar. Si es necesario, es posible ver si las descargas están disponibles sin descargarlas utilizando el punto final de Descargas disponibles.

GET /download/available.

Maximo Inventory Optimization ofrece diferentes exportaciones, por ejemplo: niveles de reorden y tiempo de entrega. Durante la fase de implementación del software, los usuarios de Maximo Inventory Optimization deciden qué exportación utilizar. Como mínimo, se implementa la exportación de los niveles de reorden de Maximo Inventory Optimization.

Para descargar las recomendaciones exportadas desde Maximo Inventory Optimization, envíe una solicitud de GET al punto final de descargas, junto con el código del tipo de exportación que desea descargar.

Nota: Los códigos a utilizar para el parámetro exportTypeCode son proporcionados por el consultor IBM que da soporte al proceso de implantación. Asegúrese de consultar con el consultor de IBM para obtener los códigos correctos para su configuración específica.

GET {exportTypeCode}.

Se devuelve un .zip archivo que contiene un archivo CSV para cada uno de los perfiles de exportación del tipo de exportación especificado. Sólo se incluyen los lotes nuevos (los lotes que no se descargan).

Manejo de errores

Error al cargar

Cuando se envía un archivo a una de las API de carga, la respuesta siempre devuelve un identificador exclusivo, al que se hace referencia como ID de carga útil. Al recibir el archivo, la API valida rápidamente el formato del archivo. Si se encuentra un error, se devuelve un código de error con el ID de carga útil.

Si se devuelve un código de error para una carga, asegúrese de rectificar el problema con los pasos siguientes.

Realice una llamada DELETE a la API de carga.
- Proporcione el ID de carga útil de la carga anómala.
- DELETE {payLoadID}.
Esto se hace para asegurarse de que el extracto no está incluido en la próxima renovación de datos.
Vuelva a cargar la extracción afectada.
Realice una llamada a GET al endpoint Upload Status para asegurarse de que la carga se ha realizado correctamente.
GET {payloadID}.

Actualización de datos fallida

Si falla una renovación de datos (ya sea un EOM o una ejecución de renovación delta), se necesita una restauración de base de datos.

IBM El soporte es necesario para resolver este problema, por lo que se sugiere que se ponga en contacto con el equipo de soporte de optimización de inventario de IBM Maximo.

Configuración de extractos.csv para su carga

Los puntos finales del controlador de la API de carga de datos permiten a los clientes de Maximo Inventory Optimization de IBM cargar los archivos de .CSV adecuados. Los registros de estos archivos se procesan y se aplican a las tablase de entrada respectivas.

Para obtener más información, consulte el artículo de referencia API de carga de datos.

Para que los clientes sean guiados con precisión en cuanto a la configuración de los archivos .CSV, pueden realizar llamadas a GET a los mismos puntos finales de carga de datos. No se pueden realizar llamadas para Conector, Estado, y Eliminar puntos finales.

Ejemplo de solicitud: solicitud GET a la API de carga de actividades

Ejemplo de solicitud - Solicitud GET a la API de carga de actividad

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer ZGVtbzo4MTdlYWU3MDFkMjQ1YmE4NzMzZGIyZDEzZmZhMzZhZQ'

Al realizar una solicitud GET a los puntos finales de la API de carga de datos se obtiene una respuesta JSON.

La respuesta es una matriz de objetos que enumera los campos que deben incluirse en el correspondiente archivo de carga .CSV. La respuesta indica qué campos son obligatorios y qué campos son opcionales.

Ejemplo de respuesta de una solicitud GET anterior

  [
  {
  "column": "DIVISION",
  "mandatory": true
  },
  {
  "column": "PKG_HDR_NO",
  "mandatory": true },
  {
  "column": "DISTRICT_CD",
  "mandatory": true
  },
  ...
   ]

Si observa el ejemplo proporcionado, ahora sabe que el archivo .CSV que se cargará mediante el punto final de la API de carga de actividad tiene los campos DIVISION, PKG_HDR_NO y DISTRICT_CD. Estos campos deben estar presentes en el fichero, ya que figuran como obligatorios.

Haciendo GET llamadas a cada carga de datos (excepto para Conector, Estado y Eliminar puntos finales ), los desarrolladores pueden ser guiados en cuanto a la mejor manera de configurar sus extractos.

Para obtener más información, consulte la API de obtención de columna.

Reglas para la carga (extractos de .CSV)

Los archivos (extractos) que se cargarán en las API de carga de datos IBM Maximo Inventory Optimization deben cumplir algunas reglas específicas:

Deben estar codificados en UTF-8.
La primera fila del archivo debe ser los nombres de columna de cabecera.
Los nombres de columna específicos dependen del punto final en el que está cargando.
El número de campos de cada fila debe coincidir con el número de campos de la cabecera.
Las comillas dobles deben utilizarse como calificador de texto.

Nota: Sin embargo, el cumplimiento de las reglas descritas es necesario para los archivos de validación de archivos que pasan la validación pueden seguir teniendo errores que impiden el proceso completo. Compruebe siempre la existencia de respuestas de error.