Unter die Lupe genommen: die API von i-doit

1
Im Fokus: die i-doit API

Im Fokus: die i-doit API

Als IT-Dienstleister sind wir immer bemüht, Probleme unserer Kunden schnell zu lösen. Dazu gehören interne Schulungen zu den Lösungen, die wir einsetzen. Letzte Woche stellten wir uns dem „Mysterium“ i-doit API. Dazu besuchten uns zwei Kollegen unseres Partners Synetics, Hersteller der IT-Dokumentationssoftware i-doit, um uns die API näher zu bringen.

i-doit ist eine Software für die Dokumentation von IT-Komponenten. Mit ihr können alle Bestandteile einer IT-Landschaft in einer Configuration Management Database (CMDB) erfasst werden. Der API-Client von i-doit wurde von Dennis Stücken von Synetics zur einfacheren Handhabung der API entwickelt. Er kann bei Bitbucket heruntergeladen werden. Mit dem API Client werden bereits Klassen vordefiniert, um auf die entsprechenden Objekttypen, Kategorien und Beziehungen innerhalb von i-doit zugreifen zu können. So erspart man sich einiges an Arbeit.

Nach dem Download verbanden wir den Client über einen API Key mit der i-doit-Installation und starteten ihn. Nun ging es mit den Basics weiter: Anlegen von Server- und Client-Objekten, Hinzufügen und Aktualisieren der entsprechenden Objektkategorien sowie am Ende das Löschen derselbigen.

Nach den Grundlagen wendeten wir uns konkreten Problemen aus dem Consulting-Alltag zu. Gemeinsam mit den Kollegen von Synetics entwickelten wir auf Basis der API Lösungsansätze, z.B. für das Herstellen von Beziehungen über die API, die Verknüpfung von Objekten mit Lokationen und das Hochladen und Einbinden von Bildern.

Datenbankschema und Report-Funktionen
Die API bedienen und Skripte schreiben ist eine Sache. Um Objekte an der richtigen Stelle zuordnen und später wiederfinden zu können, muss man aber wissen, wie die Daten organisiert sind. Aus diesem Grund schauten wir uns das Datenbankschema von i-doit genauer an und blickten hinter die Namensgebung und Struktur. Gerade bei der Entwicklung von Modulen für i-doit ist es wichtig, sich an bereits vorhandene Strukturen zu halten, damit die selbst erstellten Module auch über die API ansprechbar sind.

Events und Cronjobs
Nach der Funktionsweise von Skripten wendeten wir uns ihrer Aktivierung zu. Für regelmäßig wiederkehrende Aufgaben, wie zum Beispiel den Import von Daten, kann das Skript im Backend in einem Cronjob eingerichtet werden. Will man das Ganze etwas flexibler haben, kann man Skripte mit Hilfe von Events in i-doit auslösen. So lässt sich zum Beispiel beim Import eines neuen Objektes in i-doit ein Ticket in einem Ticketsystem eröffnen oder eine E-Mail an einen Benutzer versenden. Das ist zum Beispiel dann sinnvoll, wenn ein Objekt angelegt ist und noch eine Seriennummer nachgepflegt werden muss.

Die zwei Tage Schulung war für alle Beteiligten sehr lehrreich und gaben uns einen fundierten Einblick darin, wie sich Skripte und Module zur Erweiterung von i-doit erstellen lassen, um auch spezielle Kundenanforderungen zu erfüllen.

Diese Artikel könnten Sie auch interessieren:

Tags: , , ,

Christian Piazzi, Data Scientist
Als staatlich geprüfter Techniker für IT-Sicherheitsmanagement kommt Christian Piazzi aus der IT-Security. Bei der it-novum war Christian zuerst Teil des IT Service Management- und openITCOCKPIT-Teams, bevor er in den Bereich Big Data Analytics wechselte. Als Data Scientist berät er Kunden bei ihren Daten- und Analytics-Projekten.
Webprofile von Christian: Blog, Twitter, Google+, XING.