Qu'est-ce que cette API ?

Cette API est une plateforme complète qui gère les services IT, incidents, changements et actifs au sein d'une organisation. Elle fournit un accès programmatique aux fonctionnalités principales, permettant l'intégration avec des chatbots, workflows automatisés et applications personnalisées.

Aperçu de l'API

• Hôte:your-api-host.com
• Chemin de Base:/api/v1
• Protocole:HTTPS uniquement
• Authentification:Gestion des clés API (clés d'abonnement requises)

Ce que Vous Pouvez Faire Avec Cette API

• Créer et gérer les incidents(tickets de support IT)
• Rechercher et récupérer les articles de base de connaissances
• Accéder aux informations d'actifsdepuis la Base de Données de Gestion de Configuration (CMDB)
• Gérer les demandes de changementet leur cycle de vie
• Récupérer les données de support(utilisateurs, catégories, opérateurs, etc.)

Entités Principales et Leurs Relations

Terminologie Clé

Cycle de Vie Typique d'un Incident

Configuration de l'Authentification

Vous aurez besoin des identifiants de gestion API. Toutes les requêtes nécessitent ces en-têtes :

Content-Type: application/json
  Access-Control-Allow-Origin: *
  Accept-Encoding: gzip, deflate, br

Votre Premier Appel API - Trouver une Personne

Avant de créer des tickets, vous devez trouver les IDs utilisateur :

// Trouver un utilisateur par nom
  const response = await fetch('/api/persons?query=dynamicName=="John Doe"', {
    headers: {
      'Content-Type': 'application/json',
      'Access-Control-Allow-Origin': '*',
      'Accept-Encoding': 'gzip, deflate, br'
    }
  });
  
  const persons = await response.json();
  console.log(persons[0].id); // Utiliser cet ID lors de la création de tickets

Comprendre les Menus Déroulants Dynamiques

Cette plateforme est hautement configurable. Chaque organisation personnalise son instance avec ses propres catégories, groupes d'opérateurs, priorités et types d'appel.

Ce que Cela Signifie pour l'Intégration :

// ❌ INCORRECT - Ces IDs ne fonctionneront pas dans votre environnement
  const ticketData = {
    category: { id: "12345-hardware" },      // Votre org n'a peut-être pas ceci
    operatorGroup: { id: "67890-helpdesk" } // ID différent dans votre instance
  };

// ✅ CORRECT - Toujours récupérer les options actuelles d'abord
  const categories = await getDropdownOptions('/api/categories/parent');
  const operatorGroups = await getDropdownOptions('/api/operatorgroups');
  
  const ticketData = {
    category: { id: categories.find(c => c.name === "Hardware").id },
    operatorGroup: { id: operatorGroups.find(g => g.groupName === "IT Support").id }
  };

Pourquoi Cette Approche est Essentielle :

• Changements de Configuration:Les administrateurs ajoutent/suppriment/renomment régulièrement les catégories
• Différences d'Environnement:Les environnements dev, test et prod ont des IDs différents
• Différences d'Organisation:Chaque instance d'entreprise est configurée différemment
• Échecs d'API:L'utilisation d'IDs invalides entraîne des erreurs 400 Bad Request

Points de Terminaison Essentiels pour Commencer

1. Trouver les Utilisateurs (Requis pour la création de tickets)

2. Obtenir les Options de Menu Déroulant (Requis pour la création de tickets)

3. Créer un Ticket d'Incident

4. Rechercher dans la Base de Connaissances