Créer un compte API dans Apple School Manager
Avec les API d’Apple School Manager et d’Apple Business Manager, vous pouvez modifier les attributions de gestion des appareils et consulter les renseignements les concernant. Vous pouvez également utiliser le point de terminaison d’un appareil pour permettre à des apps de créer des rapports personnalisés ou d’exporter des données sur les appareils.
Aperçu
Avec les API d’Apple School Manager et d’Apple Business Manager, vous pouvez modifier les attributions de gestion des appareils et consulter les renseignements les concernant. Vous pouvez également utiliser le point de terminaison d’un appareil pour permettre à des apps de créer des rapports personnalisés ou d’exporter des données sur les appareils. L’API prend en charge OAuth 2. Avec OAuth 2, les apps s’authentifient à l’aide d’un ensemble d’identifiants en échange d’un jeton d’accès pour effectuer des requêtes authentifiées auprès de l’API.
Avant de pouvoir utiliser ces API, vous devez créer un compte API dans Apple School Manager. Seuls les utilisateurs détenant les rôles d’administrateur et de gestionnaire de site peuvent créer un compte API.
Accès aux données
Lorsque le compte API est bien configuré, il peut autoriser une app à accéder aux renseignements suivants :
Catégorie | Fonctionnalité | Description |
|---|---|---|
Appareils | Obtenir les appareils de l’organisation | Obtenez la liste des appareils d’une organisation qui sont inscrits au moyen de l’inscription automatisée d’appareils. |
Appareils | Obtenir les renseignements sur l’appareil | Obtenez des renseignements sur un appareil d’une organisation, comme le modèle, le numéro de commande et la référence de l’appareil. |
Services de gestion d’appareils | Obtenir les services de gestion d’appareils | Obtenez la liste des services de gestion d’appareils d’une organisation. |
Services de gestion d’appareils | Obtenir les numéros de série des appareils pour un service de gestion d’appareils | Obtenez la liste des numéros de série des appareils attribués à un service de gestion d’appareils. |
Services de gestion d’appareils | Obtenir l’identifiant du service de gestion d’appareils attribué à un appareil | Obtenez les renseignements sur l’identifiant du service de gestion d’appareils attribué à un appareil. |
Services de gestion d’appareils | Obtenir les renseignements sur le service de gestion d’appareils attribué à un appareil | Obtenez les renseignements sur le service de gestion d’appareils attribué à un appareil. |
Services de gestion d’appareils | Obtenir les renseignements sur l’activité des appareils | Obtenez des renseignements sur l’activité d’un appareil de l’organisation découlant d’une action de gestion, comme une attribution ou une désattribution. |
Services de gestion d’appareils | Attribuer ou désattribuer des appareils à un service de gestion d’appareils | Attribuez ou désattribuez des appareils à un service de gestion d’appareils. |
Générer une clé privée
Pour maintenir une connexion sécurisée avec Apple School Manager, vous devez générer une clé privée. Le nom de fichier de la clé se termine par .pem, et vous ne la générez qu’une seule fois.
Créer un compte API et télécharger la clé privée
Dans Apple School Manager
, connectez-vous avec le compte d’un utilisateur ayant un rôle d’administrateur ou de gestionnaire de site.Sélectionnez votre nom au bas de la barre latérale, sélectionnez Réglages
, puis sélectionnez API.Sélectionnez Démarrer, entrez un nom pour le compte, puis sélectionnez Créer.
Effectuez l’une des opérations suivantes :
Sélectionnez Générer la clé privée pour générer la clé.
Le fichier est téléchargé automatiquement à l’emplacement de téléchargement des fichiers défini dans les préférences de votre navigateur. Si aucun emplacement n’est défini, le système vous demande où enregistrer le fichier.
Sélectionnez Plus tard pour générer la clé privée ultérieurement.
Sélectionnez Gérer pour afficher les renseignements dont vous avez besoin pour créer la connexion.
Consultez la documentation pour les développeurs Apple pour savoir comment créer la connexion.