Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Übersicht über die RESTful API

Die 100%ige API-Architektur von Juniper Mist unterstützt alle sichtbaren Funktionen im Juniper Mist Portal. Alles, was Sie im Portal tun können, können Sie mithilfe der API in großem Umfang automatisieren. Representational State Transfer (REST) ist eine zustandslose Client-Server-Architektur mit einer einheitlichen Schnittstelle. Da Maschinen keine Verwendung für eine Benutzeroberfläche haben, ermöglichen APIs eine definierte und schnellere Art und Weise, wie Maschinen miteinander kommunizieren können. APIs ermöglichen es Ihnen und anderen Benutzern auch, Ihre eigene Art der Interaktion mit Systemen und Anwendungen zu entwickeln. Sie können sogar benutzerdefinierte Features erstellen.

Die Juniper Mist API steht allen Kunden mit einem Juniper Mist Konto zur Verfügung.

Juniper Mist API-Architektur

Juniper Mist verwendet REST-APIs, die HTTP-Methoden (GET, POST, PUT und DELETE) verwenden, um Daten im JSON-Format (JavaScript Object Notation) zu übertragen.

RESTful-API-Anfragen

Die Verwendung von RESTful-APIs folgt einer ähnlichen Praxis wie die in der Entwicklung verwendete CRUD-Methodik (Create, Read, Update, Delete). Dies sind die vier grundlegenden Aktionen oder Funktionen, die bei der Arbeit mit Daten verwendet werden.

Tabelle 1: Grundlegende CRUD-Aktionen
CRUD HTTP/REST
Erstellen BEREITSTELLEN
Lesen ERHALTEN
Aktualisieren SETZEN
Löschen LÖSCHEN

Zu den REST-Befehlen gehören:

  • POST: Erstellen Sie ein Objekt.

  • GET: Listet Objekte auf.

  • PUT: Aktualisieren eines Objekts.

  • LÖSCHEN: Entfernt ein Objekt.

Um Aktionen für die REST-API ausführen zu können, müssen Sie in jeder Anforderung einige Anforderungen erfüllen, z. B.:

  • Authentifizierung: Sie können ein API-Token, Anmeldedaten von Juniper Mist oder einen externen OAuth2-Anbieter verwenden.

  • HTTP-Header: Dieser Header gibt den Inhalt und den Berechtigungstyp wie folgt an:

    • Bei Juniper Mist ist der Inhaltstyp immer application/json.

    • Die Autorisierung kann ein Token oder ein Cookie (einschließlich CSRF-Token und Sitzungs-ID) sein.

  • API-Endpunkt

  • JSON-Nutzdaten

URL-Format für API-Endpunkte

Die API-Endpunkt-URL besteht aus zwei Teilen:

  • API-Endpunkt – Der Endpunkt für die globale Region, mit der Ihre Juniper Mist-Organisation verknüpft ist. Weitere Informationen finden Sie unter API-Endpunkte und globale Regionen.

  • Funktion: Alles nach dem API-Endpunkt stellt die Funktion dar, die von der API aufgerufen wird.

Beispiel

https://<api-endpoint>/api/v1/sites/:<site-id>/stats/devices/:<device_id>aus.

Hinweis:

Sie würden die Elemente in Klammern durch die tatsächlichen Werte für Ihren API-Endpunkt, Ihre Site-ID und Ihre Geräte-ID ersetzen.

Alles nach <api-endpoint> ist die Funktion. Der Aufruf geht an die globale Cloud und fordert die Statistiken für das angegebene Gerät am angegebenen Standort an.

JSON-Nutzdaten

Unterschiedliche Funktionen erfordern unterschiedliche Elemente in der JSON-Nutzlast. Die erforderlichen Details finden Sie in der API-Dokumentation.

So zeigen Sie die API-Dokumentation an:

  1. Melden Sie sich bei Ihrem Juniper Mist Portal an.

  2. Klicken Sie auf die Schaltfläche "Hilfe " (in der Nähe der oberen rechten Ecke des Bildschirms).

  3. Klicken Sie auf API-Dokumentation.

API-Ratenbegrenzung

Juniper Mist beschränkt API-Aufrufe auf 5.000 pro Stunde. Wenn Sie ein höheres Ratenlimit benötigen, wenden Sie sich bezüglich Ihres Anwendungsfalls an den Juniper Support.

Hinweis:

Um Brute-Force-Angriffe zu verhindern, wird die Login-API (/api/v1/login) nach drei fehlgeschlagenen Anmeldungen ratenbegrenzt.

API-Authentifizierungsoptionen

Die Juniper Mist API ermöglicht drei Optionen zum Anfordern der Authentifizierung:

  • Standardauthentifizierung – Token

  • HTTP-Login – Benutzername und Passwort

    • Ist wie ein Dashboard-Login.

    • Dies kann eine Zwei-Faktor-Authentifizierung sein.

  • OAuth2

    • Das Konto muss mit einem OAuth-Anbieter verknüpft sein.

    • Erfordert Browserzugriff.

Ein einfaches API-Beispiel

Über die Django-API-Schnittstelle können Sie Ihren ersten API-Aufruf durchführen. Nachdem Sie sich bei Mist angemeldet haben, öffnen Sie ein neues Fenster mit demselben Browser und geben Sie die URL https://api.mist.com/api/v1/selfein.

Dies entspricht dem Ausführen dieses API-Aufrufs GET /api/v1/self.

Das oben gezeigte Ergebnis zeigt die Berechtigungen an, die Ihnen für die Organisationen und Websites zugewiesen sind, denen Sie zugeordnet sind.