API
Inventory360 bietet für nahezu alle Bereiche eine vollständig dokumentierte HTTP REST API. Hierüber können externe Systeme mit Inventory360 automatisiert kommunizieren um z.B. Daten abzurufen oder Assets anzulegen.
API Versionen
Seit Release 3.5.1 steht eine neue API Version 2.0 zur Verfügung, welche auch den Schreibzugriff auf das System ermöglicht. Die ältere API 1.0 sollte daher nicht mehr verwendet werden.
Dokumentation¶
Die Entwickler Dokumentation der zur Verfügung stehenden API Endpunkte finden sich im nachfolgenden Dokumentationsbereich:
Zugang anlegen¶
Um einen neuen API Zugang im System anzulegen klicken Sie im Adminbereich zunächst auf den Eintrag API. Mit einem Klick auf den grünen Hinzufügen Button wird der Dialog zur Erstellung eines neuen API Zugangs erstellt.
| Einstellung | Beschreibung |
|---|---|
| (1) Name | Technischer / interner Name des API Zugangs |
| (2) Beschreibung | Interne Beschreibung des Zugangs (Welches System / welche Rechte?) |
| (3) Rechte | Auswahl der Lese- oder Schreibrechte |
Bei der Anlage des Benutzers wird automatisch ein neuer Zugangs-Token generiert. Dieser wird für die Authentifizierung der Abfragen verwendet.
Sicherheitshinweis
Beim API Token handelt es sich um einen vertraulichen Schlüssel. Dieser sollte nicht an unbefugte Dritte weitergegeben werden.
Implementierung von Schnittstellen¶
Über unsere REST API bieten wir eine offen dokumentierte Zugangsmöglichkeit für Dritte oder auch den Endanwender selbst.
Bitte beachten Sie, dass für ein reibungsloses und sinnvolles Zusammenspiel zweier Systeme (z.B. Inventory360 und ERP-System) in 99% der Fälle zusätzlich entsprechende Business-Logik erforderlich ist. Nur so können Geschäftsprozesse vernünftig abgebildet werden.
Consulting & Customizing
Für Rückfragen zur API oder möglichen Anbindungsmöglichkeiten stehen wir Ihnen gerne im Rahmen eines Consulting-Projektes zur Verfügung.
Ist die Umsetzung von Business-Logik auf Inventory360 Seite notwendig, ist dies in der Regel über ein Customizing möglich.
API Pagination bei sehr großen Datenbeständen¶
Seit Release 3.13 kann bei bestimmten API Aufrufen vom Laden gesamter Listen auf einen Pagination-Ansatz gewechselt werden:
Pagniation über die API aussteuern
Bei großen Hardware-Beständen kann ein optionaler Pagination Parameter per_page aktiviert werden, der die Ergebniszahl beschränkt. Die aktuelle Seite kann per page Parameter gewählt oder über next und prev Attribute im _query Parameter aufgerufen werden.
Beispiele sind:
-
Aufruf mit deaktivieren Disovery-Daten:
/api/2.0/assets/hardware?per_page=100&page=1&discovery=0&search=S4711-123456789 -
Aufruf mit aktiven Disovery-Daten und Ansteuerung einer bestimmten Seite:
/api/2.0/assets/hardware?per_page=100&page=5&discovery=1&search=S4711-123456789