API (JSON-RPC)#

i-doit permet l'accès externe à la documentation informatique via une interface de programmation d'application (API). Avec l'API, les données peuvent être lues, créées, mises à jour et supprimées. Ainsi, l'API offre des fonctions similaires à l'interface utilisateur Web mais le bénéfice supplémentaire est que vous pouvez les automatiser sans aucun problème.

Contexte technique#

L'API d'i-doit fournit des fonctionnalités typiques de CRUD. Avec cela, les fichiers peuvent être

• Créés
• Réad
• Updatés et
• Détruits.

Pour cela, un client (par exemple, sous forme de script) envoie une demande au serveur (i-doit) afin d'exécuter une méthode sur le serveur. Cette approche est appelée Appel de Procédure à Distance (RPC). Le résultat de la méthode est renvoyé au client en tant que réponse. Dans cette communication, l'API d'i-doit est basée sur le protocole JSON-RPC, version 2.0. HTTP est utilisé comme protocole supérieur et le JavaScript Object Notation (JSON) est utilisé comme format d'échange. Une demande est envoyée au serveur au format JSON via HTTP POST. La réponse est également faite au format JSON.

Les requêtes API peuvent se faire de manière asynchrone sans perdre la relation entre les demandes et les réponses. Le langage de programmation utilisé peut être choisi librement.

Téléchargement#

Dans le portail client, vous pouvez télécharger l'API pour la version pro en tant qu'extension gratuitement. Les utilisateurs de la version open peuvent également le télécharger gratuitement via i-doit.org. L'installation est conforme aux mêmes principes que les autres extensions i-doit.

Configuration#

L'API est configurée via l'interface Web d'i-doit et peut être trouvée à Administration → Interfaces / données externes → API JSON-RPC.

Veuillez noter que la journalisation des requêtes API créera un fichier dans le chemin d'installation d'i-doit à log/ pour chaque requête. Cela peut entraîner une augmentation des besoins en espace mémoire si l'API est utilisée de manière intensive.

Accès#

Vous pouvez accéder à l'API d'i-doit en activant une URL spéciale. Ajoutez src/jsonrpc.php à l'URL de base :

1

 https://demo.i-doit.com/src/jsonrpc.php

Authentification et Autorisation#

Vous avez besoin d'une clé API pour que les requêtes soient traitées par l'API. De plus, vous pouvez activer la fonction qu'un compte utilisateur dédié soit activé pour la connexion. Les autorisations pour ce compte peuvent être définies comme d'habitude. Sinon, toutes les autorisations sont disponibles via l'API. Un autre avantage est le fait qu'un utilisateur dédié peut être défini par système/script tiers ; cela facilite le suivi du flux de données.

Il peut être utile d'utiliser la méthode API idoit.login pour une seule authentification si de nombreuses requêtes (signifiant des milliers) sont envoyées depuis un client. Sinon, il est possible que trop de sessions soient créées dans un laps de temps très court mais ne sont pas terminées. Cela pourrait entraîner le fait qu'i-doit cesse de fonctionner jusqu'à ce que les sessions aient été terminées.

Exemple#

Avec un exemple simple, nous créons un nouvel objet du type Serveur avec le titre d'objet "Mon petit serveur" via l'API.

Demande au serveur :

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
    "jsonrpc": "2.0",
    "method": "cmdb.object.create",
    "params": {
        "type": "C__OBJTYPE__SERVER",
        "title": "My little server",
        "apikey": "c1ia5q"
    },
    "id": 1
}

Via cURL, vous pouvez envoyer cette demande à des fins de test :

1
2
3
4

curl \
--data '{"jsonrpc":"2.0","method":"cmdb.object.create","params":{"type":"C__OBJTYPE__SERVER","title":"My little server","apikey":"c1ia5q"},"id":1}' \
--header "Content-Type: application/json" \
https://demo.i-doit.com/src/jsonrpc.php

Réponse du serveur :

1
2
3
4
5
6
7
8
9

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "id": "3351",
        "message": "Object was successfully created",
        "success": true
    },
}

Catégories dans la documentation informatique#

Une liste utile de toutes les catégories et attributs utilisés dans i-doit est fournie par une URL spéciale :

Par exemple, cette liste vous montre quel nom est utilisé pour accéder aux catégories et attributs et quels types de données sont attendus par ces attributs.
Pour les catégories personnalisées ou attributs, vous trouverez les clés techniques dans la catégorie personnalisée respective. Il est possible de renommer les clés techniques.

Clients et Bibliothèques#

Il existe de nombreux projets et produits utilisant l'API par i-doit. Nous aimerions vous présenter quelques clients et bibliothèques :

Documentation pour Téléchargement#

Vous pouvez télécharger un documentation maintenue par les développeurs~ en tant que fichier PDF. (obsolète)

Depuis la version 1.8.1, l'API est publiée en tant qu'extension. Les préversions étaient groupées avec i-doit.

FAQ#

Messages d'Erreur#

Releases#