i-doit API client

Simple PHP client for i-doit's JSON-RPC API

About

i-doit is a software application for IT documentation and a CMDB (Configuration Management Database). This application is very useful to collect all your knowledge about the IT infrastructure you are dealing with. i-doit is a Web application and has an exhausting API which is very useful to automate your infrastructure.

This client provides a simple, but powerful abstraction layer to send requests to i-doit's API. It is written in PHP so you may use it in your own project.

Features

Why should you use this client? There are some good reasons:

Easy to use
There is a PHP function for each API method
Supports batch requests
Sends user-defined requests
Upload files and images
Supports login and logout to save sessions
Follows redirects (HTTP 301/302)
Uses optional HTTP or SOCKS5 proxy
Verifies TLS certificate chains
Throws exception on error
Many examples
Well-documented
Easy to install via Composer
Unit tests!!!11

Download

You have several options to download (and kinda install) the API client:

Install any version via Composer (recommended)
Download any stable release manually
Clone the Git repository to fetch the (maybe unstable) development branch

Using Composer

Change to your project's root directory and type the following command:

composer require "bheisig/idoitapi=>=0.1"

For a system-wide installation add global as an option:

composer global require "bheisig/idoitapi=>=0.1"

As an alternative add a new dependency on bheisig/idoitapi to your project's composer.json file. Here is a minimal example to install the current development branch locally:

{
    "require": {
        "bheisig/idoitapi": ">=0.1"
    }
}

After that you need to call composer to install the API client (under vendor/bheisig/idoitapi/ by default):

composer install

This installs version 0.1 or higher if available. Instead of sticking to a specific/minimum version you may switch to the current development branch by using @DEV:

composer require "bheisig/idoitapi=@DEV"
composer install

Updates

Composer has the great advantage (besides many others) that you can simply update the API client by running:

composer update

Download Release

You find all releases on the project site. Fetch the latest stable release:

wget https://github.com/bheisig/i-doit-api-client-php/releases/download/0.1/i-doit-api-client-php-0.1.tar.gz
tar xvzf i-doit-api-client-php-0.1.tar.gz
cd i-doit-api-client-php/

Fetch Source Code

Fetch the current (maybe unstable) development branch:

git clone https://github.com/bheisig/i-doit-api-client-php.git
cd i-doit-api-client-php/

To fetch updates run:

git pull

Usage

If you use Composer you should use its own autoloader:

require_once 'vendor/autoload.php';

Without Composer just include this file into your PHP code:

require_once 'idoitapi.php';

That's it. All other files will be auto-loaded if needed.

Configuration

The API client class requires a configuration:

use bheisig\idoitapi\API;

$api = new API([
    'url' => 'https://demo.i-doit.com/src/jsonrpc.php',
    'port' => 443,
    'key' => 'c1ia5q',
    'username' => 'admin',
    'password' => 'admin',
    'language' => 'en',
    'proxy' => [
        'active' => false,
        'type' => 'HTTP', // 'HTTP' or 'SOCKS5'
        'host' => 'proxy.example.net',
        'port' => 8080,
        'username' => '',
        'password' => ''
    ]
]);

url: URL to i-doit's API, probably the base URL appended by src/jsonrpc.php
port: optional port on which the Web server listens; if not set port 80 will be used for HTTP and 443 for HTTPS
key: API key
username and password: optional credentials if needed, otherwise System API user will be used
language: requests to and responses from i-doit will be translated to this language (de and en supported); this is optional; defaults to user's prefered language
proxy: use a proxy between client and server
- active: if true proxy settings will be used
- type: use a HTTP or a SOCKS5 proxy
- host: FQDN or IP address to proxy
- port: port on which the proxy server listens
- username and password: optional credentials used to authenticate against the proxy

Examples

A basic example:

use bheisig\idoitapi\API;
use bheisig\idoitapi\Idoit;

$api = new API([
    'url' => 'https://demo.i-doit.com/src/jsonrpc.php',
    'key' => 'c1ia5q',
    'username' => 'admin',
    'password' => 'admin'
]);

$request = new Idoit($api);
$info = $request->readVersion();

var_dump($info);

It's simple like that. For more examples take a look at the next sub sections.

Login and Logout

One sweet thing about i-doit's API you can (and should) use one user session for your stuff. This saves resources on the server side and allows you to perform a lot more calls in a short time.

The session handling is done by the API client. You just need to login. And if you are nice you want to logout after your work is done.

use bheisig\idoitapi\API;

$api = new API([/* … */]);

$api->login();
// Do your stuff…
$api->logout();

If you are unsure in which condition your session is try isLoggedIn():

$api->isLoggedIn(); // Returns true or false

Pre-defined Methods

For almost every case there is a remote procedure you may call to read from or manipulate i-doit's database through its API. Each remote procedure is assigned to a namespace to keep the API clean and smoothly. Furtunately, you do not need to call these remote procedures on your own. The API client provides for each namespace a class and for each remote procedure a method. Here is a quick overview:

Namespace	Remote Procedure Call (RPC)	API Client Class	Method
`idoit`	`idoit.version`	`Idoit`	`readVersion()`
	`idoit.search`		`search()`
	`idoit.constants`		`readConstants()`
	`idoit.login`	`API`	`login()`
	`idoit.logout`		`logout()`
`cmdb.object`	`cmdb.object.create`	`CMDBObject`	`create()`
	`cmdb.object.read`		`read()`
	`cmdb.object.update`		`udpate()`
	`cmdb.object.delete`		`archive()`, `delete()`, `purge()`
`cmdb.objects`	`cmdb.objects.read`	`CMDBObjects`	`read()`
`cmdb.category`	`cmdb.category.create`	`CMDBCategory`	`create()`
	`cmdb.category.read`		`read()`, `readOneByID()`, `readFirst()`
	`cmdb.category.update`		`update()`
	`cmdb.category.delete`		`archive()`, `delete()`, `purge()`
`cmdb.category_info`	`cmdb.category_info.read`	`CMDBCategoryInfo`	`read()`
`cmdb.dialog`	`cmdb.dialog.create`	`CMDBDialog`	`create()`
	`cmdb.dialog.read`		`read()`
`cmdb.impact`	`cmdb.impact.read`	`CMDBImpact`	`readByID()`, `readByConst()`
`cmdb.location_tree`	`cmdb.location_tree.read`	`CMDBLocationTree`	`read()`, `readRecursively()`
`cmdb.logbook`	`cmdb.logbook.create`	`CMDBLogbook`	`create()`
	`cmdb.logbook.read`		`read()`
`cmdb.objects_by_relation`	`cmdb.objects_by_relation.read`	`CMDBObjectsByRelation`	`readByID()`, `readByConst()`
`cmdb.object_type_categories`	`cmdb.object_type_categories.read`	`CMDBObjectTypeCategories`	`readByID()`, `readByConst()`
`cmdb.object_type_groups`	`cmdb.object_type_groups.read`	`CMDBObjectTypeGroups`	`read()`
`cmdb.object_types`	`cmdb.object_types.read`	`CMDBObjectTypes`	`read()`, `readOne()`, `readByTitle()`
`cmdb.reports`	`cmdb.reports.read`	`CMDBReports`	`read()`, `listReports()`
`cmdb.workstation_components`	`cmdb.workstation_components.read`	`CMDBWorkstationComponents`	`read()`, `readByEMail()`, `readByEMails()`

Additionally, this API client is shipped with methods as workarounds for remote procedure call you probably miss. The RPC cmdb.objects.create does not exist but you may use CMDBObjects::create(). It simulates the missing RPC and gives you an easier and faster way to manipulate your IT documentation/CMDB.

When it makes sense for most RPCs there is method performing a batch request. For example: CMDBCategory::batchRead().

Search in i-doit's database

use bheisig\idoitapi\API;
use bheisig\idoitapi\Idoit;

$api = new API([/* … */]);

$idoit = new Idoit($api);
$result = $idoit->search('Server XY');

var_dump($result);

Perform more than one search at once:

use bheisig\idoitapi\API;
use bheisig\idoitapi\Idoit;

$api = new API([/* … */]);

$idoit = new Idoit($api);
$result = $idoit->batchSearch([
    'Server XY',
    'Client A',
    'John Doe'
]);

var_dump($result);

Create a New Object

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObject;

$api = new API([/* … */]);

$object = new CMDBObject($api);
$objectID = $object->create(
    'C__OBJTYPE__SERVER',
    'Server XY'
);

var_dump($objectID);

Read Common Information About an Object

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObject;

$api = new API([/* … */]);

$object = new CMDBObject($api);
$objectInfo = $object->read(42);

var_dump($objectInfo);

Load All Data of an Object

This will fetch everything about an object: common data, assigned categories and category entries as well.

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObject;

$api = new API([/* … */]);

$object = new CMDBObject($api);
$objectInfo = $object->load(42);

var_dump($objectInfo);

The method load() triggers round about 4 API calls. So be aware if it is heavily used.

Update an Existing Object

Currently, you are able to update an object's title:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObject;

$api = new API([/* … */]);

$object = new CMDBObject($api);
$object->update(
    42,
    [
        'title' => 'A shiny new object title'
    ]
);

Create or Update an Object ("Upsert")

You you like to get an identifier of an object but you are unsure whether or not it exists, try an upsert. This is an "update" and an "insert" at the same time. This means, if the object exists you will get its identifier directly. If not the object will be created and then you will get its identifier. Objects must match against type and title. Additional attributes will be stored.

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObject;

$api = new API([/* … */]);

$object = new CMDBObject($api);
$object->upsert(
    'C__OBJTYPE__SERVER',
    'My little server',
    [
        'purpose' => 'Private stuff'
    ]
);

Fetch an Object Identifier

Fetch an object identifier by object title and (optional) type:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjects;

$api = new API([/* … */]);

$object = new CMDBObjects($api);
$objectID = $object->getID('My little server');
$objectID = $object->getID('My little server', 'C__OBJTYPE__SERVER');

An exception error will be thrown if there is either no object or more than one.

Change Documentation Status of an Object

i-doit has the concept of archiving your IT documentation. Each object has an status (normal, archived, marked as deleted). And last but not least, an object may be purged from the database.

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObject;

$api = new API([/* … */]);

$object = new CMDBObject($api);
$objectID = 42;
// Archive:
$object->archive($objectID);
// Mark as deleted:
$object->delete($objectID);
// Purge from database:
$object->purge($objectID);

Create Multiple Objects

Create multiple objects at once:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjects;

$api = new API([/* … */]);

$cmdbObjects = new CMDBObjects($api);

$objectIDs = $cmdbObjects->create(
    [
        ['type' => 'C__OBJTYPE__SERVER', 'title' => 'Server No. One'],
        ['type' => 'C__OBJTYPE__SERVER', 'title' => 'Server No. Two'],
        ['type' => 'C__OBJTYPE__SERVER', 'title' => 'Server No. Three']
    ]
);

var_dump($objectIDs);

Read Multiple Objects

Reading multiple objects at once is provided by several methods. Let's see:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjects;

$api = new API([/* … */]);

$cmdbObjects = new CMDBObjects($api);

// Fetch every object:
$objects = $cmdbObjects->read();
var_dump($objects);

// Fetch max. 10 servers and sort them descending by title:
$objects = $cmdbObjects->read(['type' => 'C__OBJTYPE__SERVER'], 10, 0, 'title', CMDBObjects::SORT_DESCENDING);
var_dump($objects);

// Get them by their identifiers:
$objects = $cmdbObjects->readByIDs([1, 2, 3]);
var_dump($objects);

// Get all servers:
$objects = $cmdbObjects->readByType('C__OBJTYPE__SERVER');
var_dump($objects);

// Get archived clients:
$objects = $cmdbObjects->readArchived('C__OBJTYPE__CLIENT');
var_dump($objects);

// Get clients marked as deleted:
$objects = $cmdbObjects->readDeleted('C__OBJTYPE__CLIENT');
var_dump($objects);

Update Multiple Objects

Update multiple objects at once:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjects;

$api = new API([/* … */]);

$cmdbObjects = new CMDBObjects($api);

// Rename objects 1, 2, 3:
$cmdbObjects->update([
  ['id' => 1, 'title' => 'New name'],
  ['id' => 2, 'title' => 'Another name'],
  ['id' => 3, 'title' => 'Just a name'],
]);

Archive/Delete/Purge Multiple Objects

Archive objects, mark them as deleted or even purge them from database:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjects;

$api = new API([/* … */]);

$cmdbObjects = new CMDBObjects($api);

$cmdbObjects
    ->archive([1, 2, 3])
    ->delete([1, 2, 3])
    ->purge([1, 2, 3]);

Create Category Entries with Attributes

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
$entryID = $this->category->create(
    42,
    'C__CATG__IP',
    [
        'net' => 123,
        'active' => false,
        'primary' => false,
        'net_type' => 1,
        'ipv4_assignment' => 2,
        "ipv4_address" =>  '10.20.10.100',
        'description' => 'API TEST'
    ]
);

var_dump($entryID);

Read Categories and Attributes

Read one or more category entries for one specific object:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
$result = $category->read(42, 'C__CATG__IP');

var_dump($result);

Read one specific categoy entry for one specific object:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
$result = $category->readOneByID(42, 'C__CATG__IP', 23);

var_dump($result);

Read just one category entry (easier than read() when using single-valued categories):

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
$result = $category->readFirst(42, 'C__CATG__IP');

var_dump($result);

Read data for multiple objects and categories at once:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
$result = $category->batchRead(
    [23, 42],
    ['C__CATG__IP', 'C__CATG__MODEL']
);

var_dump($result);

Update Categories and Attributes

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
$category->update(
    42,
    'C__CATG__GLOBAL',
    [
        'cmdb_status' => 10
    ]
);

Change Documentation Status of a Category and its Attributes

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBCategory;

$api = new API([/* … */]);

$category = new CMDBCategory($api);
// Archive:
$category->archive(42, 'C__CATG__CPU', 1);
// Mark as deleted:
$category->delete(42, 'C__CATG__CPU', 2);
// Purge from database:
$category->purge(42, 'C__CATG__CPU', 3);

Create Values in Drop-down Menus

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBDialog;

$api = new API([/* … */]);

$dialog = new CMDBDialog($api);

$entryID = $dialog->create('C__CATG__MODEL', 'model', 'My model');
var_dump($entryID);

$entryIDs = $dialog->batchCreate([
    'C__CATG__MODEL' => [
        'manufacturer' => 'My manufacturer',
        'model' => 'My model'
    ],
    'C__CATG__GLOBAL' => [
        'category' => [
            'cat 1',
            'cat 2',
            'cat 3'
        ],
        'purpose' => 'API TEST'
    ]
]);
var_dump($entryIDs);

Fetch Values from Drop-down Menus

Drop-down menus in i-doit are called "dialog" (read-only) or "dialog+" (editable).

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBDialog;

$api = new API([/* … */]);

$dialog = new CMDBDialog($api);

$models = $dialog->read('C__CATG__MODEL', 'model');
var_dump($models);

$modelsAndManufacturers = $dialog->batchRead([
    'C__CATG__MODEL' => [
        'manufacturer',
        'model'
    ]
]);
var_dump($modelsAndManufacturers);

Build a Location Tree

Read objects located directly under an object:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBLocationTree;

$api = new API([/* … */]);

$locationTree = new CMDBLocationTree($api);
$result = $locationTree->read(1);

var_dump($result);

Read recursively objects located under an object:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBLocationTree;

$api = new API([/* … */]);

$locationTree = new CMDBLocationTree($api);
$result = $locationTree->readRecursively(1);

var_dump($result);

Fetch Relations Between Objects

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjectsByRelation;

$api = new API([/* … */]);
$relation = new CMDBObjectsByRelation($api);

$result = $relation->read(
    10,
    'C__RELATION_TYPE__PERSON_ASSIGNED_GROUPS'
);

var_dump($result);

Fetch Workplace Components For a Person

A Person may be assigned to a workplace with several components like a PC, a monitor and a telephone. These components can be fetched by the person. You either need the object ID or the email address. Even more than one workplaces are supported.

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBWorkstationComponents;

$api = new API([/* … */]);
$components = new CMDBWorkstationComponents($api);

$result = $components->read(111); // Person object with ID 111
var_dump($result);

$result = $components->batchRead([111, 222]); // Person objects with IDs 111 and 222
var_dump($result);

$result = $components->readByEMail('alice@example.org'); // Person object with email address
var_dump($result);

$result = $components->readByEMails(['alice@example.org', 'bob@example.org']); // Person objects with email addresses
var_dump($result);

Reports

List all reports:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBReports;

$api = new API([/* … */]);
$reports = new CMDBReports($api);

$result = $reports->listReports();

var_dump($result);

Fetch the result of a report:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBReports;

$api = new API([/* … */]);
$reports = new CMDBReports($api);

$result = $reports->read(1);

var_dump($result);

Fetch the result of one or more reports:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBReports;

$api = new API([/* … */]);
$reports = new CMDBReports($api);

$result = $reports->batchRead([1, 2]);

var_dump($result);

Fetch Next Free IP Address From Subnet

use bheisig\idoitapi\API;
use bheisig\idoitapi\Subnet;

$api = new API([/* … */]);

$subnet = new Subnet($api);
// Load subnet object by its identifier:
$nextIP = $subnet->load(123)->next();

echo 'Next IP address: ' . $nextIP . PHP_EOL;

Upload Files

This API client is able to upload a file, create a new "File" object an assigned it to an existing object identified by its ID:

use bheisig\idoitapi\API;
use bheisig\idoitapi\File;

$api = new API([/* … */]);

$file = new File($api);

// Assign one file to object with identifier 100:
$file->add(100, '/path/to/file', 'my file');

// Assign many files to this object:
$file->batchAdd(
    100,
    [
        'file1.txt' => 'File 1',
        'file2.txt' => 'File 2',
        'file3.txt' => 'File 3'
    ]
);

Self-defined Request

Sometimes it is better to define a request on your own instead of using pre-defined methods provided by this client. Here is the way to perform a self-defined request:

use bheisig\idoitapi\API;

$api = new API([/* … */]);

$result = $api->request('idoit.version');

var_dump($result);

request() takes the method and optional parameters.

Self-defined Batch Request

Similar to a simple requests you may perform a batch requests with many sub-requests as you need:

use bheisig\idoitapi\API;

$api = new API([/* … */]);

$result = $api->batchRequest([
    [
        'method' => 'idoit.version'
    ],
    [
       'method' => 'cmdb.object.read',
       'params' => ['id' => 1]
    ]
]);

var_dump($result);

Read Information About Your CMDB Design

Fetch information about object types, object types per group, categories assigned to object types, and attributes available in categories:

use bheisig\idoitapi\API;
use bheisig\idoitapi\CMDBObjectTypes;
use bheisig\idoitapi\CMDBObjectTypeGroups;
use bheisig\idoitapi\CMDBObjectTypeCategories;
use bheisig\idoitapi\CMDBCategoryInfo;

$api = new API([/* … */]);

// Object types:
$objectTypes = new CMDBObjectTypes($api);
$allObjectTypes = $objectTypes->read();
var_dump($allObjectTypes);
$server = $objectTypes->readOne('C__OBJTYPE__SERVER');
var_dump($server);
$someObjectTypes = $objectTypes->batchRead('C__OBJTYPE__SERVER', 'C__OBJTYPE__CLIENT');
var_dump($someObjectTypes);
$client = $objectTypes->readByTitle('LC__CMDB__OBJTYPE__CLIENT');
var_dump($client);

// Object types per group:
$objectTypesPerGroup = new CMDBObjectTypeGroups($api);
$objectTypes = $objectTypesPerGroup->read();
var_dump($objectTypes);

// Categories assigned to object types:
$assignedCategory = new CMDBObjectTypeCategories($api);
$serverCategories = $assignedCategory->readByConst('C__OBJTYPE__SERVER');
var_dump($serverCategories);
// Read by identifiers is also possible. And there are methods for batch requests.

// Attributes available in categories:
$categoryInfo = new CMDBCategoryInfo($api);
$modelCategory = $categoryInfo->read('C__CATG__MODEL');
var_dump($modelCategory);
$personCategory = $categoryInfo->read('C__CATS__PERSON_MASTER', false);
var_dump($personCategory);
$categories = $categoryInfo->batchRead([
    'C__CATG__MODEL' => true,
    'C__CATG__FORMFACTOR' => true,
    'C__CATS__PERSON_MASTER' => false
]);
var_dump($categories);

Read Information About i-doit Itself

use bheisig\idoitapi\API;
use bheisig\idoitapi\Idoit;

$api = new API([/* … */]);

$idoit = new Idoit($api);
$version = $idoit->readVersion();
$constants = $idoit->readConstants();

var_dump($constants);

Re-connect to Server

Sometimes you need a fresh connection. You may explicitly disconnect from the i-doit server and re-connect to it:

use bheisig\idoitapi\API;

$api = new API([/* … */]);

// Do your stuff…
$api->disconnect();
$api->isConnected(); // Returns false
$api->connect();
$api->isConnected(); // Returns true

Debugging API Calls

For debugging purposes it is great to fetch some details about your API calls. These methods may help you:

use bheisig\idoitapi\API;

$api = new API([/* … */]);

// Just a simple API call:
$request = new Idoit($api);
$request->readVersion();

// Debugging methods:
var_dump($api->countRequests());
var_dump($api->getLastInfo());
var_dump($api->getLastRequestContent());
var_dump($api->getLastRequestHeaders());
var_dump($api->getLastResponseHeaders());

Contribute

Please, report any issues to our issue tracker. Pull requests are very welcomed.

Copyright & License

Licensed under the GNU Affero GPL version 3 or later (AGPLv3+). This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law.

Files

README.md

Latest commit

History