Was ist diese API?

Diese API ist eine umfassende Plattform, die IT-Services, Vorfälle, Änderungen und Assets innerhalb einer Organisation verwaltet. Sie bietet programmatischen Zugang zu Kernfunktionalitäten und ermöglicht die Integration mit Chatbots, automatisierten Workflows und benutzerdefinierten Anwendungen.

API Überblick

• Host:your-api-host.com
• Basis Pfad:/api/v1
• Protokoll:Nur HTTPS
• Authentifizierung:API Key Management (Abonnementschlüssel erforderlich)

Was Sie mit dieser API tun können

• Vorfälle erstellen und verwalten(IT-Support-Tickets)
• Wissensdatenbank-Artikel suchen und abrufen
• Asset-Informationen zugreifenaus der Configuration Management Database (CMDB)
• Änderungsanfragen verwaltenund deren Lebenszyklus
• Unterstützende Daten abrufen(Benutzer, Kategorien, Operatoren, etc.)

Kernentitäten und ihre Beziehungen

Wichtige Terminologie

Typischer Vorfall-Lebenszyklus

Authentifizierung Einrichten

Sie benötigen API Management Anmeldedaten. Alle Anfragen erfordern diese Header:

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

Ihr erster API-Aufruf - Eine Person finden

Vor dem Erstellen von Tickets müssen Sie Benutzer-IDs finden:

// Einen Benutzer nach Namen suchen
  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); // Diese ID beim Erstellen von Tickets verwenden

Dynamische Dropdowns Verstehen

Diese Plattform ist hochgradig konfigurierbar. Jede Organisation passt ihre Instanz mit eigenen Kategorien, Operator-Gruppen, Prioritäten und Anruftypen an.

Was das für die Integration bedeutet:

// ❌ FALSCH - Diese IDs funktionieren nicht in Ihrer Umgebung
  const ticketData = {
    category: { id: "12345-hardware" },      // Ihre Org hat das vielleicht nicht
    operatorGroup: { id: "67890-helpdesk" } // Andere ID in Ihrer Instanz
  };

// ✅ RICHTIG - Aktuelle Optionen immer zuerst abrufen
  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 }
  };

Warum dieser Ansatz wesentlich ist:

• Konfigurationsänderungen:Administratoren fügen regelmäßig Kategorien hinzu/entfernen/umbenennen
• Umgebungsunterschiede:Dev-, Test- und Prod-Umgebungen haben unterschiedliche IDs
• Organisationsunterschiede:Jede Unternehmensinstanz ist anders konfiguriert
• API-Fehler:Die Verwendung ungültiger IDs führt zu 400 Bad Request Fehlern

Wesentliche Endpoints für den Einstieg

1. Benutzer finden (Erforderlich für Ticket-Erstellung)

2. Dropdown-Optionen abrufen (Erforderlich für Ticket-Erstellung)

3. Vorfall-Ticket erstellen

4. Wissensdatenbank durchsuchen