Authentification
L'API Nomid MDM utilise des clés d'API pour authentifier les requêtes. Ce guide explique comment obtenir et utiliser votre clé d'API.
Aperçu
Les clés d'API sont utilisées pour authentifier toutes les requêtes adressées à l'API Nomid MDM. Incluez votre clé d'API dans l'en-tête X-API-Key avec chaque requête.
X-API-Key: nm_acme_a1b2c3d4e5f6... Obtenir votre clé d'API
Les clés d'API sont créées et gérées via le portail Nomid. Suivez ces étapes pour créer votre première clé d'API.
Prérequis
- Un compte Nomid MDM avec accès administrateur
- Accès aux Paramètres de l'entreprise dans le portail Nomid
- 1
Connectez-vous au portail Nomid
Ouvrez votre navigateur et accédez au portail Nomid. Connectez-vous avec vos identifiants administrateur.
- 2
Accéder aux Intégrations
Une fois connecté, accédez à la section Paramètres de l'entreprise et sélectionnez l'onglet Intégrations.
- 3
Cliquez sur Créer une clé API
Cliquez sur le bouton "Créer une clé API" situé dans le coin supérieur droit de la page Intégrations.
- 4
Entrez un nom
Dans la fenêtre modale qui apparaît, entrez un nom descriptif pour votre clé API. Cela vous aidera à identifier la clé plus tard (par exemple, "Intégration Power BI" ou "Synchronisation CRM").
- 5
Copiez votre clé
Après avoir cliqué sur Créer, votre clé API s'affichera. Cliquez sur le bouton Copier pour la copier dans votre presse-papiers. La clé ne sera affichée qu'une seule fois !
Format de la clé API
Les clés API suivent ce format :
nm_{company}_{random_32_chars} - Toutes les clés commencent par 'nm_
- Préfixe spécifique à l'entreprise pour l'identification
- 32 caractères aléatoires pour la sécurité
Utilisation de votre clé d'API
Incluez la clé d'API dans l'en-tête X-API-Key à chaque requête :
curl -X GET "https://api.nomid.tech/emm/api/v1/assets" \
-H "X-API-Key: nm_acme_a1b2c3d4e5f6..." Permissions de la clé d'API
Chaque clé dispose des autorisations que vous choisissez lors de sa création. Un point de terminaison renvoie une erreur 403 si la clé ne possède pas l'autorisation nécessaire. Le serveur MCP renvoie quant à lui une erreur d'outil.
| Permission | Description |
|---|---|
| DEVICES_READ | Lister et lire les appareils, le résumé de la flotte et l'historique des commandes. Requis par les points de terminaison GET /assets, l'API BI et les outils de lecture d'appareils MCP. GET /device-user-logins nécessite DEVICES_READ, comme les autres lectures d'appareils. |
| POLICIES_READ | Lister et lire les stratégies. Requis par GET /policies, GET /policies/POLICY_ID et les outils de stratégie MCP. |
| DEVICES_COMMAND | Envoyer une commande à un appareil : verrouillage, mode perdu, message, rapport d'état, mise à jour de la localisation, synchronisation des stratégies, redémarrage, arrêt, lancement d'application, effacement des données d'application et modification de stratégie (qui requiert également POLICIES_READ). Optionnel et jamais implicite par une autre autorisation. Doit être combiné avec DEVICES_READ. Requis par les points de terminaison standard de commande POST et les outils de commande MCP. Le signalement des connexions et déconnexions d'utilisateurs d'appareils (POST /device-user-logins et POST /device-user-logins/logout) nécessite DEVICES_COMMAND, l'autorisation qui envoie des commandes aux appareils ; une clé ne l'obtient qu'avec DEVICES_READ. Les sessions d'utilisateurs d'appareils n'ont pas d'autorisation propre. API Sessions d'utilisateurs d'appareils |
| DEVICES_COMMAND_DESTRUCTIVE | Exécuter des commandes destructives sur un appareil : effacer, réinitialiser ou changer le verrouillage de l'écran, renoncer à la propriété et désinstaller des applications. Elles s'exécutent immédiatement, sans étape d'approbation dans le portail. Option d'adhésion (opt-in), séparée de DEVICES_COMMAND, et qui doit être combinée avec DEVICES_READ. L'entreprise doit également activer les commandes destructives sous l'accès agent IA dans le portail. Requis par les points de terminaison de commande destructive et les outils de commande destructive MCP. |
| PROVISIONING | Créer des codes QR d'approvisionnement pour les stratégies de l'entreprise. Chaque code QR contient un nouveau jeton d'inscription qui expire après 24 heures. Optionnel (opt-in), et doit être combiné avec POLICIES_READ. Seul un utilisateur du portail autorisé à approvisionner des appareils et ayant accès à toutes les stratégies peut créer une clé avec cette autorisation. Requis par POST /policies/POLICY_ID/provisioning-qr-codes et l'outil MCP create_provisioning_qr_code. API de codes QR d'approvisionnement |
| EXPORT_READ | Autorisation obsolète. Aucun point de terminaison ou outil ne la vérifie, et les nouvelles clés ne peuvent plus être créées avec celle-ci. |
| POLICIES_WRITE | Une clé API disposant de la permission POLICIES_WRITE (Modifications de stratégie), combinée avec POLICIES_READ. Seul un utilisateur du portail autorisé à modifier des stratégies peut créer une clé avec POLICIES_WRITE. Requis par les points de terminaison POST et les outils de modification de stratégie MCP. API de modifications de stratégie |
| LIBRARY_MANAGE | LIBRARY_MANAGE est une autorisation sensible, à l'échelle de l'entreprise, pour les envois d'APK et la gestion des applications. Elle n'autorise ni l'affectation de stratégies, ni les commandes d'appareil, ni le provisionnement, ni les opérations sur le compte. API d'envoi d'APK · API des applications de la bibliothèque |
Où envoyer la clé
L'API REST accepte la clé uniquement dans l'en-tête X-API-Key. Le point de terminaison MCP accepte soit X-API-Key, soit Authorization: Bearer suivi de la clé.
Limites de débit et en-têtes
Les points de terminaison REST de lecture n'appliquent pas de limite par clé dans l'application Nomid, mais concevez tout de même votre client de façon à temporiser en cas de code 429. Le point de terminaison MCP autorise 60 requêtes par minute et par clé. Les commandes d'appareils, les modifications de stratégie (chaque appel de proposition et d'application) et les codes QR d'approvisionnement partagent une limite d'écriture de 10 requêtes par minute et par clé, REST et MCP combinés. Une connexion Sign in with Nomid possède les mêmes limites MCP et d'écriture, décomptées par connexion.
Une réponse HTTP 429 inclut un en-tête Retry-After indiquant le nombre de secondes à attendre. Lorsqu'une commande MCP, une modification de stratégie ou un appel d'outil d'approvisionnement dépasse la limite d'écriture, le texte d'erreur de l'outil indique plutôt ce nombre de secondes. L'API ne définit pas les en-têtes X-RateLimit-Limit, X-RateLimit-Remaining ou X-RateLimit-Reset.
Meilleures pratiques de sécurité
- N'exposez jamais les clés d'API dans le code côté client ou dans les dépôts publics
- Faites pivoter les clés régulièrement et révoquez les clés inutilisées
- Stockez les clés dans des variables d'environnement, pas dans le code
- Utilisez les permissions minimales nécessaires pour votre intégration
Erreurs d'authentification
L'API renvoie des codes d'erreur spécifiques pour les problèmes d'authentification :
| Code d'état | Description |
|---|---|
| 401 | Clé d'API manquante ou invalide |
| 403 | La clé d'API n'a pas les permissions requises |
| 429 | Limite de débit dépassée |