Data REST API Entwicklerhandbuch

Online bearbeiten

Der IBM® Maximo Inventory Optimization Data REST API Developer's Guide erklärt, wie die REST Data APIs verwendet und angewendet werden.

Einführung

Die REST-basierten APIs stehen für die Interaktion mit der IBM Maximo Inventory Optimization Data-Anwendung zur Verfügung.

Zugriff auf die Data-API

Um auf die Referenzdokumentation der Daten-API zuzugreifen, senden Sie eine E-Mail an IBM Maximo-Bestandsoptimierung Daten-API.

Datenintegration

Daten müssen zwischen dem ERP und IBM Maximo Inventory Optimization ausgetauscht werden, damit Analysen und Optimierungen durchgeführt werden können. Die Daten-API bietet Entwicklern eine Schnittstelle für die nahtlose Kommunikation zwischen ihrem ERP und IBM Maximo Inventory Optimization Inventory mit HTTPS.

Die Daten-Download-APIs rufen Änderungen ab, die aus IBM Maximo Inventory Optimization exportiert wurden, um sie in das ERP des Kunden zu integrieren. Sie werden auch verwendet, um eine tägliche oder monatliche Datenaktualisierung auszulösen und Daten zurück in IBM Maximo Inventory Optimization zu laden.

Die Verwendung von API-Extraktionen und -Exporten macht sie effizienter und sicherer automatisiert.

Was ist eine API?

API steht für "Application Programming Interface" (Anwendungsprogrammierschnittstelle). Durch die Verwendung einer API werden Funktionen innerhalb einer Anwendung außerhalb dieses Produkts für andere Anwendungen verfügbar gemacht. APIs sind Schnittstellen, die für die Interaktion zwischen zwei Softwarekomponenten vorgesehen sind.

Öffentliche APIs ermöglichen es Entwicklern, im Auftrag des Kunden IBM Maximo Inventory Optimization in andere interne oder externe Systeme zu integrieren.

Durch die Verwendung von APIs können Benutzer die Software IBM Maximo Inventory Optimization in ihre eigenen Geschäftsprozesse integrieren und diese Prozesse effizienter automatisieren.

Die site.data.keyword.iot_mmio_full_notm -APIs werden als REST-konforme Web-Services implementiert. REST (Representational State Transfer) ist ein Softwarearchitekturstil. REST unterliegt bestimmten Einschränkungen, darunter die Kommunikation über HTTP, wodurch es relativ stabil programmiert werden kann.

Was können Sie mit den Daten-APIs tun?

Daten senden: Die Verwendung der IBM Maximo Inventory Optimization-APIs ermöglicht es Konnektoren, Daten automatisch an IBM Maximo Inventory Optimization weiterzuleiten. Jeder MIO-Datentyp hat einen zugehörigen API-Endpunkt.
Daten aktualisieren: Daten können täglich oder am Monatsende (EOM) aktualisiert werden. Die Anfragen zur Datenaktualisierung können durch die Maximo-Bestandsoptimierung unter IBM weiter automatisiert werden.; Neben der Einleitung und Durchführung der Datenaktualisierung ist es auch möglich, den Fortschritt der Datenaktualisierung zu überprüfen. Die Datenaktualisierungen stellen sicher, dass beschädigte Übertragungen gelöscht und wiederholt werden können, bis sie erfolgreich sind.
Daten abrufen: Das Abrufen exportierter Datasets kann ebenfalls automatisiert werden, um sicherzustellen, dass alle Informationen auf dem aktuellen Stand sind.
Daten löschen: Wenn Übertragungen oder Uploads fehlgeschlagen sind, können bestimmte Nutzdaten gelöscht werden.

Sicherheit

Die IBM Maximo Inventory Optimization APIs verwenden das HTTPS -Protokoll (Hypertext Transfer Protocol Secure). Das Protokoll verschlüsselt die Kommunikation über das Internet, erfordert eine Authentifizierung und schützt die Vertraulichkeit und Integrität der Daten.

Für die Authentifizierung ist ein API-Schlüssel erforderlich. Die API-Authentifizierung ist umgebungsspezifisch, sodass unterschiedliche API-Schlüsselberechtigungsnachweise erforderlich sind, wenn der Client Zugriff auf mehrere Umgebungen hat.

Pro Umgebung wird ein clientspezifischer Schlüssel generiert. Der für die Sandbox-Umgebung verwendete API-Schlüssel unterscheidet sich von dem API-Schlüssel, der für den Zugriff auf die Produktionsumgebung verwendet wird.

Die Authentifizierung erfolgt mit einem API-Schlüssel.
Der API-Schlüssel besteht aus mindestens 32 Zeichen, die aus Zahlen, Großbuchstaben und Kleinbuchstaben bestehen. Der API-Schlüssel kann mit einer Unterstützungsanforderung geändert werden.
Die Maximo Inventory Optimization API befindet sich hinter einer Web Application Firewall (WAF). Die geltenden Regeln beschränken wiederholte Anforderungen mit hohem Volumen, indem sie gegen einen Brute-Force-Angriff und DDOS abwehren.
Die Kommunikation ist über HTTPS verschlüsselt.

Anmerkung: Jeder, der dieses Kennwort kennt, kann mit den APIs interagieren. Daher ist es erforderlich, dass der Client diese Kennwörter sicher hält.

Referenzdokumentation

Eine Referenzdokumentation zur Verwendung der API-Endpunkte ist verfügbar. Entwickler können über IBM Maximo-Bestandsoptimierung Daten-API mit der Swagger-Benutzeroberfläche der API interagieren.

Hinweis: Die Interaktion mit einigen Endpunkten erfordert Berechtigungsnachweise.

Was ist in der Referenzdokumentation verfügbar?

Kurzbeschreibungen der Endpunkte
Parameterbezeichnung
Curl-Beispielbefehle
Informationen zum Eingabeformat
Antwortformate
HTTP und Fehlercodes Das Antwortformat der APIs ist JSON JavaScript ). Einige Endpunkte können auch einen JSON-Anforderungshauptteil erfordern.

Was muss Ihr Programm tun?

Bei der Verwendung der IBM Maximo Inventory Optimization APIs wird eine Reihe von Schritten empfohlen, um den größtmöglichen Nutzen aus der Verwendung zu ziehen. Diese Schritte werden wie folgt beschrieben.

ERP-Extrakt und Upload in Maximo Inventory Optimization
1. Extrahieren Sie Daten aus Ihrem ERP/EAM im API-Format. Weitere Informationen finden Sie unter "So konfigurieren Sie .CSV -Auszüge für den Upload".
2. Fügen Sie alle Dateien in eine einzige .zip -Datei ein.
3. Datei von .zip zu /dataapi/upload/zip endpoint hochladen.
4. Stellen Sie sicher, dass die Datei .zip erfolgreich hochgeladen wurde.
MIO exportieren und herunterladen
1. Fragen Sie den Downloadendpunkt regelmäßig ab. Von Geschäftsbenutzern bestimmte Häufigkeitsempfängern. Empfehlung ist jede Stunde. Die Häufigkeit darf nicht mehr als 24 Stunden betragen.
2. Datei exportieren .zip.
3. Inhalt der Datei .zip extrahieren.
4. Änderungen aus Textdatei in ERP/EAM importieren

Hinweis: Stellen Sie während des gesamten Prozesses sicher, dass Fehler identifiziert und behandelt werden.

EOM-Aktualisierung (Monatsende)

Ihre Software entnimmt verschiedene Auszüge aus Ihrem ERP und verwendet die IBM Maximo Inventory Optimization API-Endpunkte, um diese Auszüge zur Verarbeitung in IBM Maximo Inventory Optimization hochzuladen. Am Monatsende sind Datenaktualisierungen erforderlich, um die Datenintegrität zwischen dem ERP und IBM Maximo Inventory Optimization sicherzustellen.

Die EOM-Aktualisierung wird durch eine POST -Anfrage an den EOM -Endpunkt aufgerufen:

POST /refresh/eom

Überprüfen Sie die Vollständigkeit, indem Sie eine GET -Anfrage an den Status-Endpunkt senden.

GET /refresh/status

MIO-Empfehlungen herunterladen

Wenn Empfehlungen aus Maximo Inventory Optimization exportiert werden, sind sie zum Herunterladen bereit. Bei Bedarf können Sie mithilfe des Endpunkts "Verfügbare Downloads" prüfen, ob Downloads ohne Download verfügbar sind.

GET /download/available.

Maximo Inventory Optimization bietet verschiedene Exportmöglichkeiten, z. B. für Nachbestellungsebenen und Vorlaufzeiten. Während der Software-Implementierungsphase entscheiden die Benutzer von Maximo Inventory Optimization, welcher Export verwendet werden soll. Es werden mindestens die aus Maximo Inventory Optimization exportierten Nachbestellungsebenen implementiert.

Um die aus Maximo Inventory Optimization exportierten Empfehlungen herunterzuladen, senden Sie eine Anfrage an GET an den Endpunkt "Downloads" und geben Sie den Code des Exporttyps an, den Sie herunterladen möchten.

Hinweis : Die Codes, die für den Parameter exportTypeCode verwendet werden müssen, werden IBM bereitgestellt, der den Implementierungsprozess unterstützt. Bitte wenden Sie sich an IBM, um die richtigen Codes für Ihre spezifische Konfiguration zu erhalten.

GET /download {exportTypeCode} }.

Es wird eine .zip -Datei zurückgegeben, die eine CSV-Datei für jedes der Exportprofile im angegebenen Exporttyp enthält. Nur neue Batches (Batches, die nicht heruntergeladen werden) werden eingeschlossen.

Fehlerbehandlung

Upload fehlgeschlagen

Wenn eine Datei an eine der Upload-APIs gesendet wird, gibt die Antwort immer eine eindeutige ID zurück, die als Nutzdaten-ID bezeichnet wird. Nach dem Empfang der Datei überprüft die API schnell das Format der Datei. Wird ein Fehler gefunden, wird ein Fehlercode mit der Nutzdaten-ID zurückgegeben.

Wenn für einen Upload ein Fehlercode zurückgegeben wird, müssen Sie das Problem mit den folgenden Schritten beheben.

Rufen Sie DELETE über die Upload-API auf.
- Geben Sie die Nutzdaten-ID des fehlgeschlagenen Uploads an.
- DELETE /upload {payLoadID} }.
Dadurch wird sichergestellt, dass die Extraktion nicht in die nächste Datenaktualisierung einbezogen wird.
Laden Sie den betroffenen Auszug erneut hoch.
Rufen Sie GET an, um sicherzustellen, dass der Upload erfolgreich war.
GET /upload/status {payloadID}.

Fehlgeschlagene Datenaktualisierung

Wenn eine Datenaktualisierung fehlschlägt (entweder eine EOM-oder eine Delta-Aktualisierungsausführung), ist eine Datenbankzurückschreibung erforderlich.

IBM Zur Lösung dieses Problems ist Unterstützung erforderlich. Wir empfehlen Ihnen daher, sich an das Support-Team für die Maximo-Bestandsoptimierung unter IBM zu wenden.

Konfigurieren von .CSV-Auszügen für den Upload

Die Endpunkte des Data Upload API-Controllers ermöglichen es IBM Maximo Inventory Optimization-Clients, entsprechende .CSV -Dateien hochzuladen. Die Datensätze in diesen Dateien werden verarbeitet und auf ihre jeweiligen Eingabetabellen angewendet.

Weitere Informationen finden Sie im Referenzartikel Data Upload API.

Damit Kunden genau über die Konfiguration der .CSV -Dateien informiert werden, können sie GET -Anrufe an dieselben Endpunkte für den Daten-Upload tätigen. Anrufe an Steckverbinder, Status und Endpunkte löschen sind nicht möglich.

Beispielanfrage – GET-Anfrage an die API zum Hochladen von Aktivitäten

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

Wenn Sie eine Anfrage an GET an die Endpunkte der Daten-Upload-API senden, erhalten Sie eine JSON-Antwort.

Die Antwort ist ein Objektarray, das die Felder auflistet, die in die entsprechende .CSV -Upload-Datei aufgenommen werden sollen. Die Antwort gibt an, welche Felder obligatorisch und welche optional sind.

Beispielantwort auf frühere GET-Anfrage

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

Wenn Sie sich das bereitgestellte Beispiel ansehen, wissen Sie jetzt, dass die Datei .CSV, die über den Endpunkt Activity Upload API hochgeladen werden soll, die Felder DIVISION, PKG_HDR_NO und DISTRICT_CD enthält. Diese Felder müssen in der Datei vorhanden sein, da sie als Pflichtfelder aufgeführt sind.

Durch Anrufe bei GET zu jedem Daten-Upload (außer bei Steckverbinder, Status und Endpunkte löschen ) können Entwickler angeleitet werden, wie sie ihre Extrakte am besten konfigurieren.

Weitere Referenzinformationen finden Sie unter API 'Spalte abrufen'.

Regeln für Uploads (.CSV-Extrakten)

Dateien (Auszüge), die an IBM Maximo Inventory Optimization hochgeladen werden sollen. Die Daten-Upload-APIs müssen einige spezifische Regeln einhalten:

Sie müssen UTF-8 codiert sein.
Die erste Zeile der Datei muss die Headerspaltennamen sein.
Die spezifischen Spaltennamen hängen von dem Endpunkt ab, auf den Sie hochladen.
Die Anzahl der Felder in jeder Zeile muss mit der Anzahl der Felder im Header übereinstimmen.
Anführungszeichen müssen als Textqualifikationszeichen verwendet werden.

Hinweis: Die Einhaltung der beschriebenen Regeln ist jedoch erforderlich, damit Dateivalidierungsdateien, die die Validierung bestehen, weiterhin Fehler enthalten können, die eine vollständige Verarbeitung verhindern. Immer nach Fehlerantworten suchen.