Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
AUF DIESER SEITE
 

RESTful API – Überblick

Machen Sie sich mit Representational State Transfer (REST) vertraut und erfahren Sie, wie Sie RESTful APIs mit Juniper Mist Systems™ verwenden können.

Die 100-prozentige API-Architektur von Juniper Mist Systems unterstützt alle sichtbaren Funktionen des Juniper Mist Systems Portals. 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 Möglichkeit für Maschinen, miteinander zu kommunizieren.

REST-APIs ermöglichen es Ihnen, Ihre eigene Art der Interaktion mit Systemen und Anwendungen zu erstellen. Sie können sogar benutzerdefinierte Funktionen erstellen. Weitere häufige Anwendungsszenarien für REST-APIs sind die Kommunikation und der Datenaustausch zwischen Anwendungen, der Datenaustausch zwischen Anwendungen und Servern, die Kommunikation zwischen Microservices innerhalb einer Anwendung und mehr. REST ist zustandslos und damit ideal für Cloud-basierte Services.

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

Siehe auch die Mist Systems API Reference. Diese enthält zusätzliche Dokumentation für Entwickler sowie die Möglichkeit, API-Aufrufe zu testen.

API-Architektur von Juniper Mist Systems

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

RESTful API-Anforderungen

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 BEITRAG
Lesen GET
Aktualisieren SETZEN
Löschen LÖSCHEN

URL-Format des API-Endpunkts

Die API-Endgerät-URL besteht aus zwei Teilen:

  • API-Host (oder Endpunkt): Das Endgerät für die globale Region, mit der Ihre Juniper Mist Systems-Organisation verknüpft ist. Diese Endpunkte sind unter API-Endpunkte und globale Regionen aufgeführt.

  • Funktion: Alles nach dem API-Endgerät stellt die Funktion dar, die die API aufruft.

Beispiel

https://{api-host}/api/v1/sites/{site_id}/stats/devices/{device_id}.

https://{api-host}/api/v1/sites/13b0ee00-121a-456e-84e0-ead3008bc2f2/stats/devices/00000000-0000-0000-1000-d420b08532eb

Hinweis:

Ersetzen Sie bei der Wiederverwendung von Codeblöcken Platzhalterwerte durch tatsächliche Werte, z. B. API-Token, Organisations-ID, Standort-ID, AP-Name usw.

Alles nach {api-host} ist die Funktion. Der Anruf geht an die globale Cloud und fordert die Statistiken für das angegebene Gerät am angegebenen Standort an.

Im nächsten Abschnitt wird die Struktur eines API-Aufrufs genauer betrachtet.

Struktur der API-Aufrufe

Die folgende Abbildung zeigt ein Beispiel für einen API-Aufruf und die verschiedenen Komponenten, aus denen er besteht.

Tabelle 2: API-Aufruf-Komponenten

API-Aufruf-Komponente

Beschreibung

HTTP-Methode

  • POST: Erzeugt ein Objekt: POST überschreibt alle vorhandenen Werte mit den in der Nutzlast enthaltenen. Werte, die nicht in der POST-Nutzlast angegeben sind, werden auf ihre ursprünglichen Werte zurückgesetzt.

  • GET – Objekte auflisten: GET gibt den Wert einer Ressource oder einer Liste von Ressourcen zurück, je nachdem, ob ein Bezeichner angegeben ist.

    • GET /api/v1/orgs/:org_id

      Gibt Informationen über die Organisation basierend auf der angegebenen :org_id zurück.

    • GET /api/v1/orgs/:org_id/site

      Gibt eine Liste der Websites zurück, die zu :org_id gehören.

    • GET /api/v1/sites/:site_id

      Gibt Informationen über die durch :site_id angegebene Site zurück.

  • PUT – Aktualisiert ein Objekt. – PUT ändert alle angegebenen Werte in der Nutzlast. Bei der Aktualisierung mit einem PUT behalten einfache Werte (Zeichenfolgen oder Zahlen), die nicht in der Payload angegeben sind, ihre vorhandenen Werte. Wenn der Wert eine Datenstruktur wie ein Array oder ein Objekt enthält, ersetzen die in der Nutzlast enthaltenen Werte diese Struktur in ihrer Gesamtheit. Beachten Sie dies, um unerwünschte Änderungen an vorhandenen Werten zu vermeiden.

  • DELETE: Entfernen Sie ein Objekt.—DELETE entfernt eine Ressource.

Host (oder API-Endpunkt)

Bestimmt die zu verwendende Juniper Mist Cloud (Global 01, EMEA 01 usw.). Das Endgerät für die globale Region, mit der Ihre Juniper Mist Systems Organisation verknüpft ist. Siehe API-Endpunkte und globale Regionen.

Ausführung

Die zu verwendende API-Version (derzeit verwenden alle APIs v1).

Geltungsbereich

Gibt die Ebene an, auf der die Anforderung ausgeführt wird. Beispiele hierfür sind msp, org, site, self, register, installer, const usw.

Bereichs-ID

Identifiziert den zu verwendenden Bereich.

Objekt

Der Typ des zu verwendenden Objekts (Gerät, WLAN usw.).

Objekt-ID

Identifiziert das anzufordernde Objekt.

Um einen der oben genannten REST-Befehle (POST, GET, PUT, DELETE) für die REST-API auszuführen, müssen Sie in jeder Anforderung einige Anforderungen erfüllen, z. B.:

  • Authentifizierung:

    • Sie können ein API-Token, Anmeldedaten von Juniper Mist Systems (dieser Authentifizierungstyp wird im September 2026 nicht mehr unterstützt) oder einen externen OAuth2-Anbieter verwenden, um anzugeben, wer Sie sind und worauf Sie während des Authentifizierungsprozesses Zugriff haben.

    • Weitere Informationen zu den verschiedenen Authentifizierungsmethoden finden Sie unter Authentifizierung.

      Hinweis:

      Wenn Sie bereits bei manage.mist.com angemeldet sind, können Sie einfach einen neuen Browser-Tab öffnen und zu https://{api-host}/api/v1/self/apitokens gehen und auf die Schaltfläche POST klicken. Dadurch wird automatisch ein neues API-Benutzertoken erstellt. Informationen zu Ihrem Host (API-Endpunkt) finden Sie unter API-Endpunkte und globale Regionen.

      Weitere Informationen zu Token finden Sie unter Erstellen von API-Token .

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

    • Für Juniper Mist Systems ist der Inhaltstyp immer application/json.

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

  • Das Endgerät für die globale Region, mit der Ihre Juniper Mist Systems Organisation verknüpft ist. Siehe API-Endpunkte und globale Regionen.

  • JSON-Nutzlast

Die folgende Tabelle enthält Beispiele für die verschiedenen Teile, aus denen eine RESTful-API-Anforderung besteht.

Tabelle 3: Beispiele für RESTful-API-Anfragen

CRUD-Betrieb

HTTP-Header-Authentifizierung

Endpunkt-URL

Nutzlast (JSON)

GET

API-Token

https://api.mist.com/api/v1/sites/:site_id/wlans

  

LÖSCHEN

CSRF-Token, Sitzungs-ID

https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id

  

BEITRAG

CSRF-Token, Sitzungs-ID

https://api.mist.com/api/v1/orgs/:org_id/inventory

[["<claim_code>"]}

SETZEN

API-Token

https://api.mist.com/api/v1/sites/:site_id/wlans/:wlan_id

{"ssid" : "Neuer Name"}

JSON-Nutzlast

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

Im Folgenden finden Sie ein Beispiel für einen API-Aufruf und die Antwort (JSON-Nutzlast).

API-Aufruf:

Antwort (JSON-Nutzlast):

Begrenzung der API-Geschwindigkeit

Juniper Mist Systems begrenzt API-Aufrufe auf 5.000 pro Stunde. Wenn Sie mehr als 5.000 Anrufe pro Stunde tätigen müssen, erstellen Sie ein Support-Ticket.

Bei großen Bereitstellungen wird empfohlen, API-Aufrufe auf Organisationsebene durchzuführen, um zu vermeiden, dass das API-Aufruflimit schnell erreicht wird.

Hinweis:

Um Brute-Force-Angriffe zu verhindern, ist die Login-API (/api/v1/login) nach drei fehlgeschlagenen Logins ratenbeschränkt.

API-Authentifizierungsoptionen

Die Juniper Mist Systems API bietet drei Optionen für die Anforderung der Authentifizierung:

  • Standardauthentifizierung – Token

    • Sichern Sie es wie ein Passwort.

    • Anweisungen zum Erstellen eines API-Tokens finden Sie unter Erstellen von API-Token.

    Achtung: Um die Sicherheit zu verbessern und den Best Practices der Branche zu entsprechen, wird Mist Systems die Standardauthentifizierung ab September 2026 für alle Anwendungsszenarien – einschließlich Admin-Logins und Skripte – als veraltet einstellen. Bis September 2026 müssen alle Integrationen auf tokenbasierte Authentifizierung umgestellt werden, um unterbrechungsfreien Zugriff und Support zu gewährleisten. Siehe Erstellen von API-Token.

  • HTTP-Anmeldung – Benutzername und Passwort

    • Ist wie eine Dashboard-Anmeldung.

    • Kann eine Zwei-Faktor-Authentifizierung sein.

  • OAuth2

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

    • Erfordert Browserzugriff.

Weitere Informationen zur Authentifizierung finden Sie in der Mist Systems API Reference.

Ein einfaches API-Beispiel

Die Django-API-Schnittstelle ist eine webbasierte Schnittstelle, in der Sie CRUD-Operationen innerhalb der API ausführen können. Siehe Verwenden der Django-Webschnittstelle zum Vornehmen von API-Änderungen.

Über die Django-API-Schnittstelle können Sie Ihren ersten API-Aufruf durchführen. Nachdem Sie sich bei Mist Systems angemeldet haben, öffnen Sie ein neues Fenster mit demselben Browser und geben Sie die URL https://{api-host}/api/v1/selfein. Dies ist die URL für die Global 01-Cloud. Wenn Sie eine andere Cloud verwenden, sieht diese URL anders aus.

Dies entspricht dem Aufruf dieses API-Aufrufs GET /api/v1/self.

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

Zugehörige Dokumentation