CIPAT – Cockpit ITSM Public API Toolkit

CIPAT est une boîte à outils pour l'API publique de Cockpit ITSM. Elle sert à suivre l'évolution de l'API d'une version à l'autre, à explorer ses endpoints, à les tester sur un portail réel et à générer le code client pour les appeler depuis ses propres programmes.

CIPAT existe en deux versions qui donnent exactement les mêmes résultats :

• Version Web : https://ledman.tech/CIPAT

• Exécutable Windows : cipat.exe
• Sources (Lazarus / Free Pascal) : github.com/ledmanCH/CIPAT

Le portail Cockpit ITSM publie la description de son API publique au format OpenAPI 3 (fichier JSON), une par version de Cockpit ITSM: 2025.06.7, 2025.11.2, 2026.08.4…

On la récupère sur https://support.cockpit-itsm.com/apidocs/: choisir JSON en haut de la page, puis Export → Original.

Chaque version du fichier décrit l'ensemble des endpoints (chemins, méthodes, paramètres, corps de requête, réponses) et des schémas de données. CIPAT travaille uniquement à partir de ces fichiers.

On choisit une ancienne et une nouvelle version, et CIPAT liste ce qui a vraiment changé :

• endpoints, paramètres, schémas et propriétés ajoutés, supprimés ou modifiés ;
• pour chaque modification, l'ancienne et la nouvelle valeur.

Les changements sans intérêt sont écartés : l'URL du serveur, les operationId générés, et au choix :

• le numéro de version (info.version) ;
• les textes (descriptions, résumés) ;
• la casse des noms de schémas et des références $ref.

Le résultat s'exporte en Markdown, pour l'archiver ou le partager.

Les endpoints d'une version sont présentés dans un arbre regroupé par thème (tag de l'API), avec un filtre sur le chemin, la méthode, le thème ou la description. On peut masquer les endpoints dépréciés et ceux que les générateurs ne savent pas traiter.

Pour chaque endpoint, l'onglet Detail montre:

• la description et les paramètres (chemin, requête, obligatoires ou non, types) ;
• un exemple de corps de requête, construit à partir des schémas ;
• un exemple de réponse.

L'onglet Test appelle un endpoint sur un portail Cockpit ITSM:

• connexion avec le tenant (SaaS ou sur site), le ClientId et le ClientSecret ;
• paramètres et corps de requête préremplis, modifiables avant l'envoi ;
• pour les listes paginées, récupération automatique de toutes les pages ;
• affichage du statut HTTP, de la durée et de la réponse.

On coche les endpoints voulus dans l'arbre, et CIPAT génère le code pour les appeler, avec des types de données correspondant aux schémas de l'API.

Sept langages sont disponibles :

Le fichier généré contient une méthode par endpoint sélectionné. Le fichier “core” contient tout ce qui est commun: authentification, appels HTTP, gestion des erreurs, pagination.

Quelques points pratiques:

• les noms de méthodes suivent les conventions de chaque langage (ListEndUsers, listEndUsers, list_end_users, ListEndUsersAsync, Find-CockpitEndUsers) et peuvent être renommés ;
• la liste des endpoints sélectionnés est écrite en tête du fichier généré : on peut la relire plus tard pour régénérer le même fichier avec une nouvelle version de l'API ;
• si un endpoint a disparu dans la nouvelle version, il est signalé et ignoré.

• Gestion des specs: les fichiers JSON sont envoyés depuis le navigateur (plusieurs à la fois ou par glisser-déposer) et stockés dans la base. Seuls les fichiers de l'API publique de Cockpit ITSM sont acceptés. Au moins deux versions sont toujours conservées.
• Sécurité des tests: le ClientId et le ClientSecret sont saisis à chaque test et ne sont jamais enregistrés; seuls les portails *.cockpit-itsm.com peuvent être appelés.
• Génération: le code s'affiche dans la page, se copie, ou se télécharge en zip avec son fichier “core”.
• Interface: thème clair ou sombre, aux couleurs Navy & Azure.

Don't forget to read the END-USER LICENSE AGREEMENT.