Die Samsara-Web-API ermöglicht den Zugriff auf alle Ihre Daten in der Samsara-Cloud über eine HTTPS-basierte RPC-Style-API. Verwenden Sie die API, um auf Folgendes zuzugreifen:
-
In Echtzeit und historische Daten für jeden Zeitraum und jede Abtastfrequenz können angefordert werden
-
Temperatur-, Feuchtigkeits-, Leistungs- und Eingabemoduldaten verfügbar
-
Der Zugriff auf die API ist für alle Kunden aktiviert
-
Die Authentifizierungssicherheit wird durch ein API-Token- und Secret-Key-System bereitgestellt
-
Daten werden sicher im JSON-Format über TLS geliefert
API-Versionen werden regelmäßig veröffentlicht.
Für detaillierte Informationen zur Samsara API siehe das Entwicklerportal unter developers.samsara.com.
Sie können API-Tokens für den sicheren Zugriff auf die API auf der API-Tokens-Einstellungsseite verwalten. Für detaillierte Informationen zu API-Tokens siehe den Authentifizierungsleitfaden.
Um ein API-Token zu erstellen, müssen Sie eine Volladministrator- oder Standard-Admin-Rolle oder eine Benutzerdefinierte Rollen mit den folgenden Berechtigungen zugewiesen haben.
-
Berechtigungen bearbeiten, um API-Tokens zu sehen und zu bearbeiten
-
Berechtigungen bearbeiten, um Benutzer, Rollen, Gruppen zu erstellen, zu bearbeiten und zu löschen
In beiden Fällen muss Ihre Rolle Zugriff auf die Verwaltung der gesamten Organisation haben. Rollen, die Gruppen für einen reduzierten Umfang verwenden (auch bekannt als Gruppen-Level-Admins), sind nicht ausreichend.
Sie können so viele API-Tokens anfordern und löschen, wie erforderlich.
Um ein API-Token einzurichten:
-
Wählen Sie das Symbol Einstellungen (
) am unteren Rand Ihres Samsara-Dashboard um Dashboard-Einstellungen anzuzeigen.
-
Wählen Sie API-Tokens.
-
Klicken Sie auf + API-Token hinzufügen.
-
Definieren Sie die Token-Eigenschaften:
-
Geben Sie einen beschreibenden Namen für Ihr API-Token ein, der den Hauptzweck beschreibt.
-
Wählen Sie die Ebene des Gruppenzugriffs für Ihren Token. Weitere Informationen zu Gruppen finden Sie unter Gruppen.
-
Wählen Sie einen Berechtigungs-Bereich für Ihren API-Token.
Weitere Informationen finden Sie in den folgenden Ressourcen auf dem Samsara Developers Portal:
-
Um Bereiche für API-Tokens festzulegen, siehe API-Authentifizierung.
-
Um API-Tokens für Drittanbieter-Integrationen zu erstellen, siehe Tokens für Drittanbieter-Integrationen.
-
-
-
Speichern Sie Ihre Änderungen.
-
Nachdem Sie den Token erstellt haben, kopieren Sie ihn wie unten gezeigt. Der Token wird nach dem Aktualisieren der Seite unlesbar, daher sollten Sie die Token-Zeichenfolge an einem sicheren Standort aufzeichnen.
Wenn Sie vergessen, einen API-Token zu kopieren oder verlieren, können Sie eine neue Token-Zeichenfolge generieren.
Anmerkung
Wenn eine Integration aktiv einen API-Token verwendet, wird sie unterbrochen, wenn Sie diesen API-Token regenerieren. Dies liegt daran, dass der vorherige Schlüssel gelöscht und durch einen neuen Schlüssel ersetzt wird. Seien Sie vorsichtig, bevor Sie bestätigen.
-
Wählen Sie das Symbol Einstellungen (
-
Wählen Sie API-Tokens.
-
Im Menü „Mehr“ ( ... ) für den API-Token wählen Sie Regenerieren.
-
Klicken Sie auf In die Zwischenablage kopieren, um den neuen Code zu kopieren und aufzuzeichnen.
-
Ersetzen Sie den API-Token überall dort, wo er verwendet wird.
Sie können die API-Token-Version in Ihrer Admin-Konsole aktualisieren. Samsara erhöht die API-Version nur, wenn es eine grundlegende Änderung an der API gibt.
Beispiele für grundlegende Änderungen sind:
-
Hinzufügen eines obligatorischen Anforderungsparameters zu bestehenden API-Methoden
-
Entfernen von Eigenschaften aus bestehenden API-Antworten
Bei nicht grundlegenden Änderungen sind diese in allen Versionen der API zugänglich.
Beispiele für nicht grundlegende Änderungen sind:
-
Hinzufügen neuer API-Ressourcen
-
Hinzufügen neuer optionaler Anforderungsparameter zu bestehenden API-Methoden
-
Hinzufügen neuer Eigenschaften zu bestehenden API-Antworten
-
Ändern der Reihenfolge von Eigenschaften in bestehenden API-Antworten
-
Ändern der Länge oder des Formats von Objekt-IDs oder anderen undurchsichtigen Zeichenfolgen
Sie finden die Version auf der API-Token-Seite im Dashboard:
Das Aktualisieren Ihrer API-Version wirkt sich auf die API-Aufrufe aus, die Sie ohne einen Samsara-Version-Header durchführen: die Parameter, die Sie senden können, und die Struktur der zurückgegebenen Objekte.
Sie können eine neuere Version für einen API-Aufruf testen, indem Sie den Samsara-Version-Header festlegen. Im untenstehenden Beispielcode könnte ein Benutzer mit dem <2018-01-01 Token> eine einmalige Anfrage für die 2019-02-22 Version stellen, indem er einen X-Samsara-Version HTTP-Header mit der gewünschten Datumsstempelversion übergibt:
GET -H "X-Samsara-Version: 2019-02-22" https://api.samsara.com/v1/fleet/list?access_token=<2018-01-01 token>
Nachdem Sie sicher sind, dass Ihr Code die neueste Version verarbeiten kann, klicken Sie im Samsara-Dashboard auf Upgrade. Dies wechselt die Version, die von API-Aufrufen ohne Samsara-Version-Header verwendet wird.
Kommentare
0 Kommentare
Bitte melden Sie sich an, um einen Kommentar zu hinterlassen.