Zurück

Erstellen Sie API-Schlüssel für die Factorial IT API

Ein API-Schlüssel für Factorial IT authentifiziert die Aufrufe, die Sie an die Factorial IT API (eine REST-API) senden. Erstellen Sie einen Schlüssel, wenn eine Integration oder ein Skript Ihre Daten über die API lesen oder ändern soll.


 

Funktion

Übersicht

Schlüssel authentifizieren Anfragen an die Factorial IT API (REST). Es gibt zwei Arten, jeweils mit eigenem Geltungsbereich:

  • Unternehmens-API-Schlüssel. Auf ein Unternehmen beschränkt. Er gibt Zugriff auf alle Endpunkte für unternehmensbezogene Ressourcen: Geräte, Mitarbeitende, Zubehör, Tickets, SaaS und mehr.
  • Arbeitsbereich-API-Schlüssel. Gilt für Ihren gesamten Arbeitsbereich. Er gibt Zugriff auf die Endpunkte auf Arbeitsbereichsebene, zum Beispiel zum Auflisten und Anzeigen der Unternehmen in Ihrem Arbeitsbereich.

Die meisten Endpunkte benötigen einen Unternehmens-API-Schlüssel. Nur die Arbeitsbereich-Endpunkte (unter /workspace/) benötigen einen Arbeitsbereich-API-Schlüssel. In der API-Referenz zeigt ein Badge an jedem Endpunkt, welche Art von Schlüssel er erwartet.

 

Einen Unternehmens-API-Schlüssel erstellen

  1. Gehen Sie zu Einstellungen > Entwickler.
  2. Klicken Sie auf Schlüssel erstellen.
  3. Geben Sie einen Schlüsselnamen mit mindestens 4 Zeichen ein, zum Beispiel „Meine Integration“.
  4. Stellen Sie die Zugriffsberechtigung auf Nur lesen oder Lesen/Schreiben.
  5. Legen Sie bei Bedarf ein Ablaufdatum (Tage) fest. Lassen Sie das Feld leer, wenn der Schlüssel nie ablaufen soll.
  6. Klicken Sie auf Schlüssel erstellen und dann auf Geheimnis kopieren. Das Geheimnis wird nur einmal angezeigt.

Bewahren Sie den Schlüssel sicher auf. Wer ihn besitzt, kann über die API auf Ihre Daten zugreifen.

 

Den Schlüssel verwenden

Senden Sie den Schlüssel bei jeder Anfrage im Header Authorization:

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

 

Einen Schlüssel widerrufen

  1. Gehen Sie zu Einstellungen > Entwickler und suchen Sie den Schlüssel unter Factorial IT API-Schlüssel.
  2. Öffnen Sie das Menü ⋯ in seiner Zeile und klicken Sie auf Widerrufen.
  3. Bestätigen Sie.

Der Schlüssel funktioniert sofort nicht mehr und kann nicht wiederhergestellt werden. Widerrufene Schlüssel bleiben zur Nachverfolgung in der Liste. Um einen Schlüssel endgültig zu entfernen, öffnen Sie sein Menü ⋯ und klicken Sie auf Löschen.

 

API-Protokolle ansehen

Nachdem Ihr Unternehmen die erste Anfrage gesendet hat, erscheint auf der Registerkarte Entwickler die Karte API-Protokolle anzeigen. Klicken Sie darauf, um die API-Protokolle zu öffnen. Die Seite listet die letzten 50 REST- und MCP-Anfragen Ihres Unternehmens auf. Die Spalte Akteur zeigt den Schlüssel, den MCP-Client oder die mitarbeitende Person hinter jeder Anfrage.


 

Tipps und Best Practices

  • Wählen Sie Nur lesen, es sei denn, die Integration muss schreiben. Geben Sie jedem Schlüssel die geringste Zugriffsberechtigung, die ausreicht.
  • Legen Sie für vorübergehende Integrationen ein Ablaufdatum fest. Ein Schlüssel ohne Ablaufdatum bleibt ein Risiko, bis ihn jemand widerruft.
  • Kopieren Sie das Geheimnis sofort. Es wird nicht noch einmal angezeigt.
  • Verwenden Sie einen Schlüssel pro Integration. Ein eindeutiger Name zeigt Ihnen, was beim Widerrufen nicht mehr funktioniert.
  • Prüfen Sie die API-Protokolle. Die Spalte Akteur zeigt, wer die API aufruft.
 

 

Fehlerbehebung und FAQ

Fehlerbehebung

  • Ein Arbeitsbereich-Endpunkt lehnt Ihren Schlüssel ab. Endpunkte unter /workspace/ benötigen einen Arbeitsbereich-API-Schlüssel, keinen Unternehmens-API-Schlüssel.
  • Ein Unternehmens-Endpunkt lehnt Ihren Schlüssel ab. Die meisten Endpunkte benötigen einen Unternehmens-API-Schlüssel. Prüfen Sie das Badge am Endpunkt in der API-Referenz.
  • Eine Schreibanfrage schlägt fehl. Der Schlüssel hat möglicherweise nur Nur lesen. Erstellen Sie einen Schlüssel mit Lesen/Schreiben.
  • Eine Integration funktioniert nicht mehr. Der Schlüssel wurde möglicherweise widerrufen oder ist abgelaufen. Erstellen Sie einen neuen Schlüssel.
  • Sie sehen die Karte API-Protokolle anzeigen nicht. Sie erscheint erst, wenn Ihr Unternehmen mindestens eine Anfrage gesendet hat.

 

FAQ

  1. Kann ich das Geheimnis nach dem Erstellen des Schlüssels noch einmal sehen?
    Nein. Es wird nur einmal angezeigt. Wenn Sie es verlieren, erstellen Sie 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 stehen widerrufene Schlüssel noch in der Liste?
    Zur Nachverfolgung. Mit Löschen im Menü ⋯ entfernen Sie einen Schlüssel endgültig.
     
  4. Wie viele Anfragen zeigen die API-Protokolle?
    Die 50 neuesten REST- und MCP-Anfragen Ihres Unternehmens.

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