De Samsara web-API biedt toegang tot al uw gegevens in de Samsara-cloud via een HTTPS-gebaseerde RPC-stijl API. Gebruik de API om toegang te krijgen tot:
-
Real-time en historische gegevens voor elke tijdsperiode en steekproeffrequentie kunnen worden opgevraagd
-
Temperatuur-, vochtigheids-, stroom- en invoermodulegegevens beschikbaar
-
Toegang tot de API is ingeschakeld voor alle klanten
-
Authenticatiebeveiliging wordt geboden door een API-token en geheime sleutel systeem
-
Gegevens worden veilig geleverd in JSON-formaat via TLS
API-versies worden periodiek uitgebracht.
Voor gedetailleerde informatie over de Samsara API, zie het ontwikkelaarsportaal op developers.samsara.com.
U kunt API-tokens beheren voor veilige toegang tot de API op de API-tokens instellingenpagina. Voor gedetailleerde informatie over API-tokens, zie de Authenticatiehandleiding.
Om een API-token aan te maken, moet u een volledige beheerder of standaardbeheerder rol toegewezen krijgen of een Aangepaste rollen met de volgende rechten.
-
Bewerkrechten om API-tokens te bekijken en te bewerken
-
Bewerkrechten om gebruikers, rollen, labels aan te maken, te bewerken en te verwijderen
In beide gevallen moet uw rol toegang hebben om de gehele organisatie te beheren. Rollen die labels gebruiken voor een beperkte reikwijdte (ook bekend als label-niveau beheerders) zijn niet voldoende.
U kunt zoveel API-tokens aanvragen en verwijderen als nodig is.
Om een API-token in te stellen:
-
Selecteer het pictogram Instellingen (
) onderaan uw Samsara-dashboard om de instellingen van het dashboard te bekijken.
-
Selecteer API-tokens.
-
Klik op + API-token toevoegen.
-
Definieer de token-eigenschappen:
-
Voer een beschrijvende Naam in voor uw API-token die het primaire doel beschrijft.
-
Selecteer het niveau van Labeltoegang voor uw token. Voor meer informatie over labels, zie Labels.
-
Selecteer een MachtigingsBereik voor uw API-token.
Voor meer informatie, zie de volgende bronnen op het Samsara Developers Portal:
-
Om bereiken voor API-tokens in te stellen, zie API-authenticatie.
-
Om API-tokens voor integraties van derden te maken, zie Tokens voor integratie van derden.
-
-
-
Opslaan uw wijzigingen.
-
Nadat u de token heeft aangemaakt, kopieert u deze zoals hieronder weergegeven. De token wordt onleesbaar nadat de pagina is vernieuwd, dus zorg ervoor dat u de tokenreeks op een veilige locatie vastlegt.
Als u vergeet een API-token te kopiëren of verliest, kunt u een nieuwe tokenreeks genereren.
Opmerking
Als er een integratie actief gebruikmaakt van een API-token, zal deze niet meer werken wanneer u dit API-token opnieuw genereert. Dit komt omdat de vorige sleutel wordt verwijderd en vervangen door een nieuwe sleutel. Neem de juiste voorzorgsmaatregelen voordat u bevestigt.
-
Selecteer het pictogram Instellingen (
-
Selecteer API-tokens.
-
In het menu Meer acties ( ... ) voor het API-token, selecteer Opnieuw genereren.
-
Klik op Kopiëren naar klembord om de nieuwe code te kopiëren en vast te leggen.
-
Vervang het API-token overal waar het in gebruik is.
U kunt de API-tokenversie upgraden in uw beheerdersconsole. Samsara verhoogt alleen de API-versie wanneer er een ingrijpende wijziging in de API is.
Voorbeelden van ingrijpende wijzigingen zijn:
-
Het toevoegen van een verplicht aanvraagparameter aan bestaande API-methoden
-
Het verwijderen van eigenschappen uit bestaande API-antwoorden
Voor niet-ingrijpende wijzigingen zijn deze toegankelijk in alle versies van de API.
Voorbeelden van niet-ingrijpende wijzigingen zijn:
-
Het toevoegen van nieuwe API-bronnen
-
Nieuwe optionele aanvraagparameters toevoegen aan bestaande API-methoden
-
Nieuwe eigenschappen toevoegen aan bestaande API-antwoorden
-
De volgorde van eigenschappen in bestaande API-antwoorden wijzigen
-
De lengte of het formaat van object-ID's of andere ondoorzichtige tekenreeksen wijzigen
U kunt de versie vinden op de API-tokenspagina in het dashboard:
Het upgraden van uw API-versie heeft invloed op de API-oproepen die u doet zonder een Samsara-Version header: de parameters die u kunt verzenden en de structuur van geretourneerde objecten.
U kunt een nieuwere versie voor een API-oproep testen door de Samsara-Version header in te stellen. In de onderstaande voorbeeldcode kan een gebruiker met de <2018-01-01 token> een eenmalig verzoek indienen voor de 2019-02-22 versie door een X-Samsara-Version HTTP-header met de gewenste datestempelversie mee te sturen:
GET -H "X-Samsara-Version: 2019-02-22" https://api.samsara.com/v1/fleet/list?access_token=<2018-01-01 token>
Nadat u er zeker van bent dat uw code de nieuwste versie aankan, klikt u op Upgrade in uw Samsara dashboard. Dit schakelt de versie om die wordt gebruikt door API-oproepen zonder Samsara-Version header.
Opmerkingen
0 opmerkingen
U moet u aanmelden om een opmerking te plaatsen.