Thema
In diesem Artikel wird erläutert, wo Sie die öffentliche Anwendungsprogrammierschnittstelle (API) von NinjaOne finden und wie Sie sie nutzen können.
Umgebung
- NinjaOne-Dokumentation
- Öffentliche API von NinjaOne
Beschreibung
Auf der Seite „Öffentliche API“ von NinjaOne können Sie alle in NinjaOne verfügbaren Anfragen und deren Funktionen einsehen, Beispielabfragen erstellen sowie Antworten anzeigen oder kopieren.
Wählen Sie ein Thema aus, um mehr zu erfahren:
- Wo Sie die API-Ressourcen finden
- Entdecken Sie die API
- So testen oder senden Sie eine API-Anfrage
- Weitere Ressourcen
Wo Sie die API-Ressourcen finden
Eine vollständige Liste aller API-Abfragen finden Sie in der Dokumentation zur öffentlichen API von NinjaOne, auf die Sie über das Menü „Hilfe“ in der oberen rechten Ecke von NinjaOne zugreifen können. Der Link befindet sich am unteren Rand des Menüs.
Die öffentliche NinjaOne-API bietet zusätzliche Ressourcen zur Syntax des Gerätefilters und zu Webhooks. Klicken Sie auf die in der API-Dokumentation angegebenen Links, um mehr zu erfahren:
- Syntax für Gerätefilter: Erläutert die Syntaxanforderungen für die URL-kodierte Zeichenfolge des Parameters „Device filter “.
- Webhooks: Beschreibt, wie Sie eine Webhook-Integration konfigurieren.
Entdecken Sie die API
NinjaOne stellt eine öffentliche API zur Verfügung, über die Sie einen umfassenden Index der Vorlagen für die API-Entitäten einsehen können. Zu den verfügbaren Operationen gehören die Anforderungsmethoden POST, GET, PATCH, DELETE und PUT.
Autorisierung
Die öffentliche NinjaOne-API verwendet OAuth 2.0 zur Authentifizierung von Anfragen. OAuth 2.0 ermöglicht es Anwendungen, Zugriff auf NinjaOne-Ressourcen zu erhalten, die über die API bereitgestellt werden.
Klicken Sie auf „Autorisierung“, um die Dokumentation zu den Autorisierungsanforderungen der öffentlichen NinjaOne-API einzusehen.
Informationen zur Konfiguration dieser Einstellungen finden Sie in der NinjaOne-Dokumentation: Autorisierung der öffentlichen API 2.0.
- Wählen Sie Ihre Abfrage aus dem Seitenleistenmenü aus, um die Details anzuzeigen.
- Geben Sie Ihre Autorisierung je nach bevorzugter Autorisierungsmethode entweder in das Feld „Token“ oder „sessionKey“ ein.
- Geben Sie bei Bedarf die Parameter ein.
- Klicken Sie auf „API-Anfrage senden“.
- Zeigen Sie die Antwort an.
So finden Sie Abfragekennungen
Bei bestimmten API-Abfragen müssen Sie möglicherweise eine Kennung eingeben, z. B. eine Organisations- oder Geräte-ID. In den meisten Fällen können Sie diese Daten mithilfe der Kernsystem-Entitäten und -Ressourcen ermitteln. Die folgenden Schritte zeigen ein Beispiel für das Abrufen einer Organisations-ID, damit Sie eine Liste von Standorten über die öffentliche NinjaOne-API abrufen können.
- Erweitern Sie die Abfrage „/v2/organizations“ und klicken Sie auf „Ausprobieren“. Klicken Sie anschließend auf „Ausführen“.
- Kopieren Sie den Wert für „id“.
- Navigieren Sie zur Abfrage /v2/organization/{id}/locations.
- Klicken Sie auf „Ausprobieren“ und fügen Sie den kopierten Wert in das Feld „id“ ein.
- Klicken Sie auf „Ausführen“ und sehen Sie sich die Antwort an.
Weitere Ressourcen
Weitere Informationen zur NinjaOne-API finden Sie in den folgenden Ressourcen.