Einen API-Account erstellen in Apple Business Manager
Mit den Apple School und Business Manager-APIs kannst die Verwaltungszuweisungen der Geräte bearbeiten und Geräteinformationen anzeigen. Du kannst auch den Endpunkt eines Geräts verwenden, um Apps zu ermöglichen, benutzerdefinierte Berichte zu erstellen oder Gerätedaten zu exportieren.
Übersicht
Mit der Apple School/Business Manager-API kannst die Verwaltungszuweisungen der Geräte bearbeiten und Geräteinformationen anzeigen. Du kannst auch den Endpunkt eines Geräts verwenden, um Apps zu ermöglichen, benutzerdefinierte Berichte zu erstellen oder Gerätedaten zu exportieren. Die API unterstützt OAuth 2. Mit OAuth 2 authentifizieren sich Apps mit einem Set von Anmeldedaten im Tausch gegen ein Zugriffstoken, um authentifizierte Anfragen an die API zu stellen.
Bevor du diese APIs verwenden kannst, musst du einen API-Account in Apple Business Manager erstellen. Nur Benutzer:innen mit der Funktion „Administrator:in“ können einen API-Account erstellen.
Datenzugriff
Wenn der API-Account korrekt konfiguriert ist, kann er einer App den Zugriff auf die folgenden Informationen erlauben:
Kategorie | Funktion | Beschreibung |
|---|---|---|
Geräte | Geräte der Organisation abrufen | Eine Liste der Geräte in einer Organisation abrufen, die sich mit der automatischen Geräteregistrierung registrieren. |
Geräte | Geräteinformationen abrufen | Informationen über ein Gerät in einer Organisation abrufen, etwa Gerätemodell, Bestellnummer und Teilenummer. |
Geräteverwaltungsdienste | Geräteverwaltungsdienste abrufen | Eine Liste der Geräteverwaltungsdienste in einer Organisation abrufen. |
Geräteverwaltungsdienste | Seriennummern der Geräte für einen Geräteverwaltungsdienst abrufen | Seriennummern der Geräte abrufen, die einem Geräteverwaltungsdienst zugewiesen sind. |
Geräteverwaltungsdienste | Zugewiesene Geräteverwaltungsdienst-ID für ein Gerät abrufen | Die ID des zugewiesenen Geräteverwaltungsdiensts für ein Gerät abrufen. |
Geräteverwaltungsdienste | Zugewiesene Geräteverwaltungsdienst-Informationen für ein Gerät abrufen | Informationen über den zugewiesenen Geräteverwaltungsdienst für ein Gerät abrufen. |
Geräteverwaltungsdienste | Informationen zur Geräteaktivität abrufen | Informationen über die Aktivitäten eines Organisationsgeräts abrufen, die durch einer Geräteverwaltungsaktion generiert werden, etwa durch Zuweisen oder Aufheben der Zuweisung. |
Geräteverwaltungsdienste | Geräte einem Geräteverwaltungsdienst zuweisen oder Zuweisung aufheben | Geräte einem Geräteverwaltungsdienst zuweisen oder Zuweisung aufheben. |
Einen privaten Schlüssel erstellen
Um eine sichere Verbindung zu Apple Business Manager aufrechtzuerhalten, musst du einen privaten Schlüssel erstellen. Der Dateiname des Schlüssels endet auf .pem und du generierst ihn nur ein Mal.
Einen API-Account erstellen und den privaten Schlüssel laden
Melde dich bei Apple Business Manager
mit einem Benutzeraccount an, der die Funktion „Administrator:in“ hat.Wähle deinen Namen am unteren Rand der Seitenleiste aus und wähle „Einstellungen“
und dann „API“ aus.Wähle „Erste Schritte“ aus, gib einen Namen für den Account ein und wähle „Erstellen“ aus.
Führe einen der folgenden Schritte aus:
Wähle „Privaten Schlüssel generieren“, um den Schlüssel zu generieren.
Die Datei wird automatisch an den Speicherort für Datei-Downloads in deinen Browsereinstellungen geladen. Wenn dieser nicht festgelegt ist, fragt das System, wo die Datei gesichert werden soll.
Wähle „Später“ aus, um den privaten Schlüssel später zu erstellen.
Wähle „Verwalten“ aus, um die Informationen anzuzeigen, die du zum Herstellen der Verbindung brauchst.
Wie du die Verbindung herstellst, erfährst du in der Apple Developer-Dokumentation.