Wat is deze API?

Deze API is een uitgebreid platform dat IT-services, incidenten, wijzigingen en assets binnen een organisatie beheert. Het biedt programmatische toegang tot kernfunctionaliteit, waardoor integratie met chatbots, geautomatiseerde workflows en aangepaste applicaties mogelijk wordt.

API Overzicht

• Host:your-api-host.com
• Basis Pad:/api/v1
• Protocol:Alleen HTTPS
• Authenticatie:API Key Management (abonnementssleutels vereist)

Wat Je Kunt Doen Met Deze API

• Incidenten creëren en beheren(IT-ondersteuningstickets)
• Kennisbank artikelen zoeken en ophalen
• Asset informatie toegangvanuit de Configuration Management Database (CMDB)
• Wijzigingsverzoeken beherenen hun levenscyclus
• Ondersteunende data ophalen(gebruikers, categorieën, operators, etc.)

Kernentiteiten en Hun Relaties

Belangrijke Terminologie

Typische Incident Levenscyclus

Authenticatie Instelling

Je hebt API Management inloggegevens nodig. Alle verzoeken vereisen deze headers:

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

Je Eerste API Aanroep - Een Persoon Vinden

Voordat je tickets aanmaakt, moet je gebruikers-IDs vinden:

// Zoek een gebruiker op naam
  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); // Gebruik deze ID bij het maken van tickets

Dynamische Dropdowns Begrijpen

Dit platform is zeer configureerbaar. Elke organisatie past hun instantie aan met hun eigen categorieën, operator groepen, prioriteiten en oproeptypes.

Wat Dit Betekent Voor Integratie:

// ❌ FOUT - Deze IDs werken niet in jouw omgeving
  const ticketData = {
    category: { id: "12345-hardware" },      // Jouw org heeft dit misschien niet
    operatorGroup: { id: "67890-helpdesk" } // Ander ID in jouw instantie
  };

// ✅ CORRECT - Haal altijd huidige opties op eerst
  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 }
  };

Waarom Deze Aanpak Essentieel Is:

• Configuratie Wijzigingen:Beheerders voegen regelmatig categorieën toe/verwijderen/hernoemen
• Omgeving Verschillen:Dev, test en prod omgevingen hebben verschillende IDs
• Organisatie Verschillen:Elke bedrijfsinstelling is anders geconfigureerd
• API Fouten:Het gebruik van ongeldige IDs resulteert in 400 Bad Request fouten

Essentiële Endpoints om Mee te Beginnen

1. Gebruikers Vinden (Vereist voor ticket creatie)

2. Dropdown Opties Ophalen (Vereist voor ticket creatie)

3. Incident Ticket Aanmaken

4. Kennisbank Doorzoeken