API ausreizen und Events triggern

• i-doit bringt eine vollumfängliche Programmierschnittstelle mit
• Daten erstellen? Lesen? Aktualisieren? Löschen? Kein Problem.
• Sehr gute Ergänzung oder gar Alternative zu bestehenden Features und Schnittstellen

• Beruht auf JSON-RPC: jsonrpc.org
• Zur Authentifizierung kann API Key verwendet werden
• Optional: explizit User und Passwort mitgeben (gut für Logs)
• Rechte werden nicht berücksichtigt
• Gewünschte Sprache kann mitgegeben werden
• Client-Anfrage: HTTP POST mit Content-Type application/json
• Server-Antwort: JSON
• Batch Requests sind möglich

Beispiel

Request vom Client

{
    "jsonrpc": "2.0",
    "method": "cmdb.object_types",
    "params": {
        "order_by": "title",
        "filter": {
            "enabled": "true"
        },
        "language": "en",
        "apikey": "c1ia5q"
    },
    "id": 1
}
                    

Request mit cURL

curl \
--data '{"jsonrpc":"2.0", \
"method":"cmdb.object_types", \
"params":{"order_by":"title","filter":{"enabled":"true"}, \
"language":"en","apikey":"c1ia5q"},"id":1}' \
--header "Content-Type: application/json" \
https://demo.i-doit.com/src/jsonrpc.php
                    

Response vom Server

{
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "12",
            "title": "Air Condition System",
            "const": "C__OBJTYPE__AIR_CONDITION_SYSTEM",
            "status": "2",
            "type_group": "2",
            "type_group_title": "Infrastructure",
            // …
        },
        // …
    ],
    "id":1
}
                    

Methoden

Objekte

• cmdb.object.{create,read,update,delete}
• cmdb.objects.read

Objektbeziehungen

• cmdb.objects_by_relation.read
• cmdb.impact.read
• cmdb.location_tree.read
• cmdb.workstation_components.read

Objekttypen und -gruppen

• cmdb.object_types.read
• cmdb_object_type_groups.read
• cmdb_object_type_categories.read

Kategorien und Dialog-Felder

• cmdb.category.{create,read,update,delete}
• cmdb.category_info.read
• cmdb.dialog.read

Logbuch und Reports

• cmdb.logbook.{create,read}
• cmdb.reports.read

Authentifizierung, Suche & Co.

• idoit.{login,logout}
• idoit.search
• idoit.version
• idoit.constants

Ressourcen

• Referenz-Client und Library (in PHP)
• Artikel in der Knowledge Base
• Handbuch zur API in Version >= 1.7.1 (PDF)
• Kategorien und Attribute: https://demo.i-doit.com/?load=api_properties
• Quellcode von i-doit: src/classes/api/model

API ab i-doit 1.8 als separates Modul

Referenz-Client und Library

Download

git clone git@bitbucket.org:dstuecken/i-doit-api-clients.git
cd i-doit-api-clients/php/
make initialize
                    

Einbinden

require 'i-doit-api-clients/php/apiclient.php';
                    

• Wenn sich die IT-Dokumentation verändert, wird ein Script ausgeführt.
• Pro Event können beliebig viele Scripts ausgeführt werden.
• Script läuft lokal mit den Rechten des Apache Webservers.
• Vom Script aus ist alles möglich (es muss nur programmiert werden).

Events

• Objekt
  • Erstellen
  • Unwiderrufliches Löschen (Purge)
• Kategorie-Eintrag
  • Erstellen (nur über die Web GUI)
  • Speichern
  • Archivieren/als gelöscht markieren/wiederherstellen/unwiderruflich löschen
• Objekttyp
  • Erstellen/Speichern
  • Unwiderrufliches Löschen

Event konfigurieren

Liste von Events

Event Log

Dem Script werden Angaben zu den Änderungen übergeben (JSON).

{
    "success": 0,
    "objectID": "2912",
    "categoryID": 1,
    "categoryConst": "C__CATG__GLOBAL",
    "categoryDataID": "2949",
    "multivalue": false,
    "changes": [],
    "postData": {
        "data_id": "2948",
        "properties": {
            "title": {
                "tag": "title",
                "value": "Headquarter Network",
                "title": "LC__UNIVERSAL__TITLE"
            },
            […]
        }
    },
    "data": {
        "2949":{
            "title": "Headquarter Network",
            "status": "Normal",
            "created": "2016-04-26 14:47:57",
            "created_by": "admin",
            "changed": "2016-04-26 14:47:57",
            "changed_by": "admin",
            "purpose": "Produktion",
            "category": "Demo",
            "sysid": "SYSID_1461674878",
            "cmdb_status": "In Betrieb",
            "type": "Supernet",
            "tag": null,
            "description": "",
            "_id": 2912,
            "_title": "[…]"
        }
    }
}
                    

Ressourcen

• Artikel in der Knowledge Base