So richten Sie die Kandji-API in Postman ein

Konfigurieren Kandji API-Tokens

Um API-Anfragen zu stellen, erstellen Sie einen API-Schlüssel, den Sie bei jeder Interaktion mit der API verwenden.

  1. Im Artikel Kandji API finden Sie Anweisungen zum Erstellen Ihres API-Tokens.

  2. Speichern Sie das neue API-Token an einem sicheren Ort, um es später zu verwenden.

Es ist möglich, andere API-Tools von Drittanbietern zu verwenden, aber wir haben eine Postman Collection zur Verfügung, um alle aktuellen API-Befehle für eine schnelle Einrichtung zu importieren.

Installieren von Postman

Wenn Sie Postman bereits auf Ihrem Gerät installiert haben, überspringen Sie diesen Schritt.

  1. Besuchen Sie die Postman-Website, um die Postman-App herunterzuladen.

  2. Kopieren Sie die Postman.app in den Ordner "Programme".

  3. Starten Sie die Anwendung.

Postman konfigurieren

Wenn Sie Postman zum ersten Mal starten, können Sie ein kostenloses Konto erstellen, sich anmelden oder überspringen und die Anmeldung bei der App vermeiden.

  • Überprüfen Sie die Postman-Einstellungen, um Einstellungen wie das Design anzupassen.

Importieren Kandji API-Sammlung in Postman

Führen Sie die folgenden Schritte aus, um alle verfügbaren Kandji API-Anforderungen einfach in Postman zu importieren.

Wenn neue Kandji -API-Befehle hinzugefügt werden, müssen Sie die Kandji -API erneut importieren, damit diese neuen Befehle in der Sammlung verfügbar sind.

  1. Rufen Sie api-docs.kandji.io auf und klicken Sie oben rechts auf der Seite auf die Schaltfläche In Postman ausführen

  2. Wählen Sie Postman für Mac aus. 

  3. Wählen Sie in der Eingabeaufforderung Möchten Sie dieser Website das Öffnen von "Postman.app" erlauben? die Option Zulassen aus. Hinweis: Diese Eingabeaufforderung kann je nach verwendetem Internetbrowser variieren. 

  4. Wählen Sie den Arbeitsbereich aus, zu dem die Sammlung hinzugefügt werden soll.

  5. Wählen Sie Importieren aus. 

Erstellen von Umgebungsvariablen

Durch das Erstellen von Umgebungsvariablen können Sie Werte wie Ihr API-Token sicherer speichern und dieselben Variablen in verschiedenen Sammlungen in Postman verwenden. Weitere Informationen dazu finden Sie im Artikel Postman's Collections.

  1. Klicken Sie auf Datei.

  2. Klicken Sie auf Neu.

  3. Wählen Sie Umgebung aus.

  4. Fügen Sie der Umgebung die folgenden Variablen hinzu, und legen Sie den Typ auf Secret fest

    • api_token, device_id, ade_token_id

    • Definieren Sie zu diesem Zeitpunkt den Wert für api_token, und definieren Sie die anderen jetzt nur, wenn Sie diese Informationen zur Verfügung haben.

  5. Klicken Sie auf Speichern.

Umgebung festlegen

  1. Wählen Sie die neue Postman-Umgebung gemäß der Anleitung aus.

Definieren Kandji API-Variablen

  1. Klicken Sie im Sammlungsbereich auf Kandji API.

  2. Klicken Sie im mittleren Bereich auf die Registerkarte Variablen.

  3. Definieren Sie den Wert für die API-URL-Variable. So finden Sie Ihre API-URL

    1. Navigieren Sie zu Einstellungen.

    2. Klicken Sie auf die Registerkarte Zugriff.

    3. Gehen Sie zum Abschnitt API-Token.

Ausführen von API-Befehlen

Sie sollten jetzt bereit sein, API-Befehle auszuführen. Weitere Informationen zu bestimmten API-Befehlen finden Sie in unserer API-Dokumentation.