Quelles sont les particularités de l’API TinyMDM ?
Une API ou Application Programming Interface est un ensemble normalisé de méthodes grâce auxquelles un logiciel ou une application tierce peut faire appel à un programme “fournisseur”.
A. A quoi sert une API ?
Un programme possédant une API peut être appelé par un logiciel ou une application tierce pour réaliser des actions précises en fonction des particularités définies par ce logiciel tierce. Par exemple, une entreprise ayant une équipe de développement peut leur demander de créer un programme appelant via une API un autre programme dans le but de réaliser des actions propres au besoin de l’entreprise.
B. Quelques exemples d’utilisation de l’API TinyMDM
L’API TinyMDM peut être utilisée par vos développeurs en interne pour réaliser de multiples actions pouvant faciliter la gestion de vos appareils managés. Les actions peuvent être liées aux utilisateurs, aux appareils, aux politiques de sécurité mais aussi plus spécifiquement au TinyMDM Store, aux contacts ou fichiers partagés, aux réseaux Wi-Fi, aux entités ou encore aux gestionnaires.
Voici quelques exemples :
- Un développeur peut créer un programme qui redémarre périodiquement une partie ou l’ensemble des appareils enrôlés avec TinyMDM.
- Via l’API, on peut récupérer automatiquement les identifiants d’un appareil afin de les afficher dans une autre application
- Une équipe de développement peut mettre en place un outil externe à TinyMDM dans lequel des sites peuvent être ajoutés aux sites autorisés d’une politique de sécurité.
- Il est possible de contacter TinyMDM via notre API pour récupérer des informations sur l’état des appareils (état de conformité, version Android, applications installées…) afin de les afficher dans un outil interne.
C. Comment fonctionne l’API TinyMDM ?
1. Clés API
Pour sécuriser les appels API afin qu’ils ne soient réalisés que par une personne habilitée, TinyMDM utilise deux clés API : une clé publique et une clé secrète, toutes les deux nécessaires pour utiliser l’API. Ces clés sont accessibles depuis l’onglet Mon Compte de la console TinyMDM. Pour les obtenir, vous devez cliquer sur Générer de nouvelles clés API dans le bloc Clés API.
Après la création d’un compte, aucune clé API n’est affichée et il faut cliquer sur Générer de nouvelles clés API pour les afficher :
Attention : la clé secrète n’est affichée qu’une seule fois. Si elle est perdue, il faudra réinitialiser les deux clés. Les anciennes ne seront plus fonctionnelles et tout programme les utilisant devra être modifié.
Des clés d’API différentes de celles de l’administrateur sont disponibles dans l’onglet Mon Compte pour les gestionnaires. Les clés des gestionnaires sont générées de la même façon que les clés de l’administrateur mais leur fonctionnement diffère légèrement.
2. Utilisation
1. En tant qu’administrateur du compte
L’administrateur du compte est une personne pouvant se connecter à la console TinyMDM avec l’email ayant servi à la création du compte (par opposition aux personnes qui se connectent avec un accès gestionnaire). Les clés API de l’administrateur doivent être ajoutées dans les headers de chaque requête API avec les valeurs X-Tinymdm-Apikey-Public et X-Tinymdm-Apikey-Secret pour authentifier la requête.
L’administrateur peut utiliser l’ensemble des appels API uniquement sur son compte.
2. En tant que gestionnaire
Un gestionnaire est une personne dont l’accès à TinyMDM a été créé par l’administrateur. Les clés API du gestionnaire doivent être ajoutées dans les headers de chaque requête API avec les valeurs X-Tinymdm-Manager-Apikey-Public et X-Tinymdm-Manager-Apikey-Secret. De plus, chaque requête réalisée par un gestionnaire doit avoir le header X-Account-Id contenant l’ID du compte sur lequel l’appel API doit être lancé. En effet, un même gestionnaire peut avoir accès à plusieurs comptes.
Pour qu’un gestionnaire puisse utiliser l’API, le droit “Contrôle total du compte grâce à l’API doit lui avoir été donné par l’administrateur depuis l’onglet Gestionnaires et Structure.
Cette permission donne accès à l’ensemble de l’API pour le compte sur lequel elle est donnée. Si le gestionnaire a un accès partiel à la console (il n’a accès qu’aux appareils qui font partie de son entité ou il n’a accès qu’à certains onglets), il ne sera pas limité dans son accès à l’API.
Pour connaître l’ID des comptes sur lesquels un gestionnaire peut faire des appels, il doit utiliser l’appel Get manageable accounts. Seuls les comptes pour lesquels le gestionnaire peut utiliser l’API apparaîtront dans le résultat.
Important : le nombre d’appels API maximum qu’il est possible de réaliser est de 5 par seconde et 30 000 par jour. Ces limites s’appliquent à chaque compte et comprennent à la fois les appels réalisés par l’administrateur et par les gestionnaires.
N’hésitez pas à consulter tous les appels API disponibles. Si vous avez des questions sur le fonctionnement de l’API TinyMDM, n’hésitez pas à joindre notre équipe de support depuis votre console d’administration, onglet Support.