L'API web Samsara permet d'accéder à toutes vos données dans le cloud Samsara en utilisant une API de style RPC basée sur HTTPS. Utilisez l'API pour accéder :
-
Les données en temps réel et historiques pour toute période et fréquence d'échantillonnage peuvent être demandées
-
Données de température, d'humidité, de puissance et de module d'entrée disponibles
-
L'accès à l'API est activé pour tous les clients
-
La sécurité d'authentification est fournie par un système de jeton d'API et de clé secrète
-
Les données sont livrées en toute sécurité au format JSON sur TLS
Les versions de l'API sont publiées périodiquement.
Pour des informations détaillées sur l'API Samsara, consultez le portail des développeurs sur developers.samsara.com.
Vous pouvez gérer les jetons d'API pour un accès sécurisé à l'API sur la page des paramètres Jetons d'API. Pour des informations détaillées sur les jetons d'API, consultez le Guide d'authentification.
Pour créer un jeton d'API, vous devez être attribué un rôle d'administrateur complet ou d'administrateur standard ou un Rôles personnalisés avec les autorisations suivantes.
-
Modifier les autorisations pour voir et modifier les jetons d'API
-
Modifier les autorisations pour créer, modifier et supprimer des utilisateurs, des rôles, des filtres
Dans les deux cas, votre rôle doit avoir accès à la gestion de l'Organisation entière. Les rôles qui utilisent des filtres pour un périmètre réduit (également connus sous le nom d'administrateurs au niveau des filtres) ne sont pas suffisants.
Vous pouvez demander et supprimer autant de jetons d'API que nécessaire.
Pour configurer un jeton d'API :
-
Sélectionnez l'icône Paramètres (
) au bas de votre tableau de bord Samsara pour afficher les paramètres du tableau de bord.
-
Sélectionnez Jetons d'API.
-
Cliquez sur + Ajouter un jeton d'API.
-
Définissez les propriétés du jeton :
-
Entrez un Nom descriptif pour votre jeton d'API qui décrit l'objectif principal.
-
Sélectionnez le niveau d'Accès au Filtre pour votre jeton. Pour plus d'informations sur les filtres, voir Filtres.
-
Sélectionnez une Portée d'autorisation pour votre jeton d'API.
Pour plus d'informations, consultez les ressources suivantes sur le portail des développeurs Samsara :
-
Pour définir les portées des jetons d'API, voir Authentification API.
-
Pour créer des jetons d'API pour des intégrations tierces, voir Jetons d'Intégration Tiers.
-
-
-
Enregistrez vos modifications.
-
Après avoir créé le jeton, copiez-le comme indiqué ci-dessous. Le jeton deviendra illisible après le rafraîchissement de la page, assurez-vous donc d'enregistrer la chaîne du jeton dans un emplacement sécurisé.
Si vous oubliez de copier ou perdez un jeton d'API, vous pouvez générer une nouvelle chaîne de jeton.
Note
Si une intégration utilise activement un jeton d'API, elle sera interrompue lorsque vous régénérez ce jeton d'API. Cela est dû au fait que la clé précédente sera supprimée et remplacée par une nouvelle clé. Prenez les précautions appropriées avant de confirmer.
-
Sélectionnez l'icône Paramètres (
-
Sélectionnez Jetons d'API.
-
Dans le menu plus d'actions ( ... ) pour le jeton d'API, sélectionnez Régénérer.
-
Cliquez sur Copier dans le Presse-papiers pour copier le nouveau code et l'enregistrer.
-
Remplacez le jeton d'API partout où il est utilisé.
Vous pouvez mettre à niveau la version du jeton d'API dans votre console d'admin. Samsara incrémente uniquement la version de l'API lorsqu'il y a un changement majeur dans l'API.
Exemples de changements majeurs incluent :
-
Ajout d'un paramètre de requête obligatoire aux méthodes API existantes
-
Suppression de propriétés des réponses API existantes
Pour les changements non majeurs, ceux-ci seront accessibles dans toutes les versions de l'API.
Exemples de changements non majeurs incluent :
-
Ajout de nouvelles ressources API
-
Ajout de nouveaux paramètres de requête optionnels aux méthodes d'API existantes
-
Ajout de nouvelles propriétés aux réponses d'API existantes
-
Modification de l'ordre des propriétés dans les réponses d'API existantes
-
Modification de la longueur ou du format des identifiants d'objet ou d'autres chaînes opaques
Vous pouvez trouver la version sur la page des jetons d'API dans le tableau de bord Samsara :
La mise à niveau de votre version d'API affectera les requêtes API que vous effectuez sans en-tête Samsara-Version : les paramètres que vous pouvez envoyer et la structure des objets retournés.
Vous pouvez tester une version plus récente pour une requête API en définissant l'en-tête Samsara-Version. Dans le code d'exemple ci-dessous, un utilisateur avec le <2018-01-01 token> pourrait faire une requête ponctuelle pour la version 2019-02-22 en passant un en-tête HTTP X-Samsara-Version avec la version de date souhaitée :
GET -H "X-Samsara-Version: 2019-02-22" https://api.samsara.com/v1/fleet/list?access_token=<2018-01-01 token>
Après avoir vérifié que votre code peut gérer la dernière version, cliquez sur Mettre à niveau dans votre tableau de bord Samsara. Cela change la version utilisée par les requêtes API sans en-tête Samsara-Version.
Commentaires
0 commentaire
Vous devez vous connecter pour laisser un commentaire.