Carto-SI (api)For Developers

Bienvenue chez Carto-SI

Salut 👋 et bienvenue sur Carto-SI !

Carto-SI vous permet de cartographier et synchroniser votre Système d'Information via des APIs REST standardisées :

  • 🚀 Déploiement rapide : Installez Carto-SI en moins de 30 minutes
  • 🔗 APIs intuitives : Push et pull de vos inventaires via quelques requêtes REST
  • ⚡ Synchronisation bidirectionnelle : Vos données sont toujours à jour dans les deux sens
  • 🔌 Écosystème ouvert : Connectez vos outils existants (GLPI, ServiceNow, VMware, K8s, AWS, Azure, GCP...)

🎯 Votre parcours en 4 étapes

1. Installation (30 min)

Installez Carto-SI sur votre environnement :

Prérequis : 8 Go RAM, 5 Go disque, ports 80/443 disponibles

2. Première connexion (5 min)

Une fois installé, accédez à Carto-SI :

Code
 
http://localhost/

Identifiants par défaut :

  • Email : admin@carto-si.com
  • Mot de passe : Consultez le fichier de configuration

🔍 Vérifiez votre installation :

Code(bash)
 
curl http://localhost/api/version

Vous devriez recevoir la version installée en JSON.

3. Générez votre premier token API (5 min)

Pour interagir avec l'API, vous avez besoin d'un token d'authentification :

  1. Connectez-vous à l'interface web
  2. Allez dans Administration > API
  3. Cliquez sur Générer un nouveau token
  4. Notez votre TENANT (ex: default) et votre TOKEN

📖 Guide détaillé : Token d'accès à Carto-SI

4. Votre premier appel API (10 min)

Testez votre configuration avec un appel simple :

Code(bash)
 
# Configuration
export HOST="http://localhost"
export TENANT="default"
export TOKEN="votre_token_ici"

# Récupérer toutes les applications
curl -X GET "${HOST}/api/v2/application/" \
  -H "Authorization: Bearer {\"token\":\"${TOKEN}\",\"myTenant\":{\"id\":\"${TENANT}\"}}" \
  -H "Content-Type: application/json"

✅ Résultat attendu : Une liste JSON de toutes vos applications (peut être vide au début).

📖 Guide complet : Utiliser l'API Carto-SI

🎓 Ressources d'apprentissage

Documentation de base

Cas d'usage courants

  • Importer des données depuis un CMDB existant
  • Synchroniser avec un outil de ticketing
  • Exporter vers un outil de reporting
  • Automatiser la découverte d'infrastructure

💡 Concepts clés à comprendre

Les Fiches

Une fiche est l'unité de base dans Carto-SI. C'est un objet JSON représentant une entité de votre SI :

Code(json)
 
{
  "id": "e7301d29-a28a-9cde-afcb-883abf749d98",
  "label": "Gitlab",
  "icon": "gitlab",
  "owner": "Équipe DevOps"
}

Les Types de fiches

Chaque fiche appartient à un type (application, technical, personal_account, etc.).

Le type détermine :

  • Les champs disponibles
  • Les relations possibles avec d'autres fiches
  • Les règles de validation

📖 Voir : Liste complète des types de fiches

Les Tenants

Un tenant est une base de données isolée dans Carto-SI. Chaque organisation a son propre tenant, garantissant l'isolation des données.

🆘 Besoin d'aide ?

Support technique

Problèmes courants

L'API retourne 401 Unauthorized → Vérifiez que votre token est valide et correctement formaté dans le header Authorization

Impossible de créer une fiche → Assurez-vous que tous les champs obligatoires sont renseignés

Les données ne s'affichent pas dans l'interface → Vérifiez que le cache du navigateur est vidé (Ctrl+F5)

Bon développement avec Carto-SI ! 🎉

Last modified on