Zurück

Erstelle API-Schlüssel für die Factorial IT API

Ein Factorial IT API-Schlüssel authentifiziert die Aufrufe, die du an die Factorial IT API, eine REST-API, tätigst. Erstelle einen, wenn du eine Integration oder ein Skript möchtest, um deine Daten über die API zu lesen oder zu ändern.


 

Funktion/Feature

Überblick

Schlüssel authentifizieren Anfragen an die Factorial IT API (REST). Es gibt zwei Arten, jede mit ihrem eigenen Umfang:

  • Unternehmens-API-Schlüssel. Beschränkt auf ein Unternehmen. Er öffnet jeden Endpunkt, der auf unternehmensbezogene Ressourcen zugreift: Geräte, Mitarbeiter/innen, Zubehör, Tickets, SaaS und mehr.
  • Arbeitsbereich-API-Schlüssel. Deckt deinen gesamten Arbeitsbereich ab. Er öffnet die Endpunkte auf Arbeitsbereichsebene, zum Beispiel das Auflisten und Anzeigen der Unternehmen in deinem Arbeitsbereich.

Die meisten Endpunkte benötigen einen Unternehmens-API-Schlüssel. Nur die Arbeitsbereich-Endpunkte (unter /workspace/) benötigen einen Arbeitsbereich-API-Schlüssel. Die API-Referenz zeigt ein Badge an jedem Endpunkt mit dem Typ, den sie erwartet.

 

So verwendest du: Erstelle einen Unternehmens-API-Schlüssel

  1. Gehe zu Einstellungen > Entwickler.
  2. Klicke auf Schlüssel erstellen.
  3. Gib einen Schlüsselnamen von 4 oder mehr Zeichen ein, zum Beispiel "Meine Integration".
  4. Setze die Zugriffsberechtigung auf Nur lesen oder Lesen/Schreiben.
  5. Wenn du möchtest, setze ein Ablaufdatum (Tage). Lass es leer für einen Schlüssel, der nie abläuft.
  6. Klicke auf Schlüssel erstellen, dann auf Geheimnis kopieren. Das Geheimnis wird nur einmal angezeigt.

Bewahre den Schlüssel an einem sicheren Ort auf. Jeder, der ihn hat, kann über die API auf deine Daten zugreifen.

 

Verwende den Schlüssel

Schicke den Schlüssel im Authorization-Header jeder Anfrage:

curl https://api.getFactorial IT.com/v1/devices \
  -H "Authorization: Bearer YOUR_API_KEY"

 

Widerrufe einen Schlüssel

  1. Gehe zu Einstellungen > Entwickler und finde den Schlüssel unter Factorial IT API-Schlüssel.
  2. Öffne das ⋯-Menü in seiner Zeile und klicke auf Widerrufen.
  3. Bestätige.

Der Schlüssel funktioniert sofort nicht mehr und kann nicht zurückgebracht werden. Widerrufene Schlüssel bleiben in der Liste, sodass du sie nachverfolgen kannst. Um einen dauerhaft zu entfernen, öffne sein ⋯-Menü und klicke auf Löschen.

 

API-Protokolle anzeigen

Nachdem dein Unternehmen seine erste Anfrage gesendet hat, erscheint eine API-Protokolle anzeigen-Karte im Entwickler-Tab. Klicke darauf, um die API-Protokolle zu öffnen. Die Seite listet die letzten 50 REST- und MCP-Anfragen für dein Unternehmen auf. Die Akteur-Spalte zeigt den Schlüssel, den MCP-Client oder die Mitarbeiter/in hinter jeder Anfrage an.


 

Tipps und bewährte Praktiken

  • Wähle Nur lesen, es sei denn, die Integration muss schreiben. Gib jedem Schlüssel die niedrigste Zugriffsberechtigung, die funktioniert.
  • Setze ein Ablaufdatum für temporäre Integrationen. Ein Schlüssel, der nie abläuft, bleibt ein Risiko, bis jemand ihn widerruft.
  • Kopiere das Geheimnis sofort. Es wird nicht wieder angezeigt.
  • Verwende einen Schlüssel pro Integration. Ein klarer Name sagt dir, was nicht mehr funktioniert, wenn du ihn widerrufst.
  • Überprüfe die API-Protokolle. Die Akteur-Spalte zeigt, wer die API aufruft.

 

Fehlerbehebung und FAQ

Fehlerbehebung

  • Ein Arbeitsbereich-Endpunkt lehnt deinen Schlüssel ab. Endpunkte unter /workspace/ benötigen einen Arbeitsbereich-API-Schlüssel, nicht einen Unternehmens-API-Schlüssel.
  • Ein Unternehmens-Endpunkt lehnt deinen Schlüssel ab. Die meisten Endpunkte benötigen einen Unternehmens-API-Schlüssel. Überprüfe das Badge am Endpunkt in der API-Referenz.
  • Eine Schreibanfrage schlägt fehl. Der Schlüssel könnte Nur lesen sein. Erstelle einen Schlüssel mit Lesen/Schreiben Zugriff.
  • Eine Integration funktioniert nicht mehr. Der Schlüssel könnte widerrufen worden sein oder sein Ablaufdatum erreicht haben. Erstelle einen neuen Schlüssel.
  • Du siehst die API-Protokolle anzeigen-Karte nicht. Sie erscheint nur, wenn dein Unternehmen mindestens eine Anfrage gestellt hat.

 

FAQ

  1. Kann ich das Geheimnis nach der Erstellung des Schlüssels wieder sehen?
    Nein. Es wird nur einmal angezeigt. Wenn du es verlierst, erstelle einen neuen Schlüssel.
     
  2. Kann ich einen widerrufenen Schlüssel wiederherstellen?
    Nein. Er funktioniert sofort nicht mehr und kann nicht wiederhergestellt werden.
     
  3. Warum sind widerrufene Schlüssel weiterhin aufgeführt?
    Zur Nachverfolgbarkeit. Verwende Löschen im ⋯-Menü, um einen dauerhaft zu entfernen.
     
  4. Wie viele Anfragen zeigen die API-Protokolle an?
    Die 50 aktuellsten REST- und MCP-Anfragen für dein Unternehmen.

War dieser Artikel hilfreich?

Give feedback about this article

Können Sie nicht finden, wonach Sie suchen?

Unser Kundenserviceteam steht Ihnen zur Verfügung.

Kontakt

Knowledge Base Software powered by Helpjuice