Créer un compte API dans Apple Business
Aperçu
Grâce à l’API Apple Business, vous pouvez modifier les affectations de gestion des appareils, consulter les informations sur les appareils, automatiser les flux de travail d’affectation des appareils, intégrer les données d’inventaire des appareils dans des plateformes tierces ou créer des tableaux de bord personnalisés — des tâches qui nécessiteraient autrement une navigation manuelle sur un portail Web. L’API prend en charge OAuth 2, donc 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 Business. Seuls les utilisateurs ayant le rôle Administrateur d’organisation peuvent créer un compte API.
Remarque : Vous pouvez avoir jusqu’à 50 comptes 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 | Nom de l’autorisation | Description |
|---|---|---|
Appareils | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | Obtenez la liste des appareils d’une organisation qui sont inscrits au moyen de l’inscription automatisée d’appareils. |
Appareils | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | 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 | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | Obtenez la liste des services de gestion d’appareils d’une organisation. |
Services de gestion d’appareils | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | Obtenez la liste des numéros de série des appareils attribués à un service de gestion d’appareils. |
Services de gestion d’appareils | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | Obtenez les renseignements sur l’identifiant du service de gestion d’appareils attribué à un appareil. |
Services de gestion d’appareils | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | Obtenez les renseignements sur le service de gestion d’appareils attribué à un appareil. |
Services de gestion d’appareils | Consulter les services de gestion des appareils, gérer l’attribution de la plateforme par défaut et ajouter des appareils avec Apple Configurator. | 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 des appareils à des services de gestion d’appareils. | Attribuez ou désattribuez des appareils à un service de gestion d’appareils. |
Services de gestion des utilisateurs | Obtenir la liste des utilisateurs d’une organisation. | |
Services de gestion des utilisateurs | Obtenir des renseignements sur un utilisateur spécifique au sein d’une organisation. | |
Services de gestion des groupes d’utilisateurs | Obtenir la liste des groupes d’utilisateurs d’une organisation. | |
Services de gestion des groupes d’utilisateurs | Obtenir des renseignements sur un groupe d’utilisateurs spécifique au sein d’une organisation. | |
Services de gestion des groupes d’utilisateurs | Obtenir la liste des utilisateurs affectés à un groupe d’utilisateurs au sein d’une organisation. | |
Schémas | Consulter les Schémas. | Obtenez la liste des schémas d’une organisation. |
Schémas | Gérer les Schémas. | Élaborer un schéma au sein d’une organisation. |
Schémas | Gérer les Schémas. | Obtenez de l’information sur un schéma au sein d’une organisation. |
Schémas | Gérer les Schémas. | Mettre à jour un schéma au sein d’une organisation. |
Schémas | Gérer les Schémas. | Supprimer un modèle dans une organisation. |
Schémas | Gérer les Schémas. | Obtenir ou modifier les membres d’un type donné au sein d’un schéma dans une organisation. |
Configurations | Afficher les configurations d’appareils. | Obtenir la liste des configurations d’une organisation. |
Configurations | Afficher les configurations d’appareils. | Obtenez les détails d’une configuration au sein d’une organisation. |
Configurations | Créer, modifier et supprimer des configurations d’appareils. | Créez une configuration dans une organisation (de type CUSTOM_SETTING). |
Configurations | Créer, modifier et supprimer des configurations d’appareils. | Mettre à jour une configuration dans une organisation (de type CUSTOM_SETTING). |
Configurations | Créer, modifier et supprimer des configurations d’appareils. | Supprimer une configuration dans une organisation. |
Paquets | Consulter et gérer les appareils qui utilisent la gestion d’appareils intégrée. | Récupérez les paquets au sein d’une organisation. |
Apps | Consulter les apps. | Obtenez les apps sous licence au sein d’une organisation. |
Événements d’audit | Accéder aux événements d’audit via l’API admin. | Récupérer la liste des événements d’audit d’une organisation, filtrée selon différents critères. Un événement d’audit représente une activité au sein de l’organisation, par exemple l’ajout ou la suppression d’un appareil. |
Générer une clé privée
Pour maintenir une connexion sécurisée avec Apple Business, 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 Business, connectez-vous avec un utilisateur ayant le rôle d’Administrateur d’organisation.
Dans votre navigateur, choisissez Paramètres > API.
Sélectionnez Ajouter un compte API, entrez le nom de l’utilisateur ou de l’utilisatrice et sélectionnez son rôle, puis sélectionnez Suivant.
Choisissez l’une des options suivantes :
Sélectionnez Générer et télécharger pour générer et télécharger 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.
Modifier un compte API existant migré depuis Apple Business Manager ou Apple Business Essentials
Si votre organisation a migré d’Apple Business Manager ou d’Apple Business Essentials vers Apple Business et que vous disposiez de comptes API existants, ces comptes ont désormais un rôle par défaut. Vous pouvez consulter et modifier les informations de n’importe quel compte API.
Dans Apple Business, connectez-vous avec un utilisateur ayant le rôle d’Administrateur d’organisation.
Dans votre navigateur, choisissez Paramètres > API.
Sélectionnez Modifier à côté d’un compte API existant.
Effectuez l’une des actions suivantes, le cas échéant :
Modifier le nom du compte
Changer le rôle
Le rôle personnalisé est Gestionnaire d’API d’appareil. Pour modifier les autorisations du rôle, consultez Introduction aux rôles et aux autorisations.
Copier l’identifiant client dans votre presse-papiers.
Copier l’identifiant de la clé dans votre presse-papiers.
Révoquer la clé privée.
Sélectionnez Enregistrer.
Consultez la documentation Apple Developer pour savoir comment gérer la connexion.