Een API-account aanmaken in Apple School Manager
In Apple School - en Business Manager-API's kun je de apparaatbeheertoewijzingen wijzigen en apparaatgegevens bekijken. Je kunt tevens het eindpunt van een apparaat gebruiken om apps de mogelijkheid te geven aangepaste rapporten te maken of apparaatgegevens te exporteren.
Overzicht
In Apple School -en Business Manager-API kun je de apparaatbeheertoewijzingen wijzigen en apparaatgegevens bekijken. Je kunt tevens het eindpunt van een apparaat gebruiken om apps de mogelijkheid te geven aangepaste rapporten te maken of apparaatgegevens te exporteren. De API ondersteunt OAuth 2. Met OAuth 2 verifiëren apps zich met een set inloggegevens in ruil voor een toegangstoken om geverifieerde verzoeken aan de API te doen.
Voordat je deze API's kunt gebruiken, moet je een API-account aanmaken in Apple School Manager. Alleen gebruikers met de rol van beheerder en systeembeheerder kunnen een API-account aanmaken.
Gegevenstoegang
Wanneer de API-account correct is geconfigureerd, kan die account een app toegang geven tot de volgende informatie:
Categorie | Functies | Beschrijving |
|---|---|---|
Apparaten | Organisatie-apparaten ophalen | Haal een lijst apparaten in een organisatie op die worden aangemeld via geautomatiseerde apparaataanmelding. |
Apparaten | Apparaatgegevens ophalen | Haal gegevens op over een apparaat in een organisatie, zoals het apparaatmodel, bestelnummer en onderdeelnummer. |
Apparaatbeheerdiensten | Diensten voor apparaatbeheer ophalen | Haal een lijst op met apparaatbeheerdiensten in een organisatie. |
Apparaatbeheerdiensten | De apparaatserienummers voor een apparaatbeheerdienst ophalen | Haal een lijst op met serienummers van apparaten die zijn toegewezen aan een apparaatdienst. |
Apparaatbeheerdiensten | De toegewezen apparaatbeheerdienst-ID voor een apparaat ophalen | Haal de gegevens op over de toegewezen apparaatbeheerdienst-ID voor een apparaat. |
Apparaatbeheerdiensten | De gegevens over de toegewezen apparaatbeheerdienst voor een apparaat ophalen | Haal de gegevens op over de toegewezen apparaatbeheerdienst voor een apparaat. |
Apparaatbeheerdiensten | Gegevens over apparaatactiviteit ophalen | Haal gegevens op voor de activiteit van een organisatie-apparaat die door een apparaatbeheeractie wordt uitgevoerd, zoals toewijzen of toewijzing opheffen. |
Apparaatbeheerdiensten | Een apparaat toewijzen aan een apparaatbeheerdienst | Wijs apparaten toe aan een apparaatbeheerdienst of hef de toewijzing ervan op. |
Een privésleutel genereren
Om een veilige verbinding met Apple School–Manager te onderhouden, moet je een privésleutel genereren. De bestandsnaam van de sleutel eindigt op .pem, en je genereert deze slechts één keer.
Een API-account aanmaken en de privésleutel downloaden
Log in bij Apple School Manager
als een gebruiker die de rol van beheerder of systeembeheerder heeft.Selecteer je naam onder in de navigatiekolom, selecteer 'Voorkeuren'
en selecteer 'API'.Selecteer 'Aan de slag, voer een naam in voor het account en selecteer Maak aan'.
Voer een van de volgende handelingen uit:
Selecteer 'Genereer privésleutel' om de sleutel te genereren.
Het bestand wordt automatisch gedownload naar de locatie die in de voorkeuren van je browser zijn ingesteld. Als er geen locatie is, vraagt het systeem je waar je het bestand wilt bewaren.
Selecteer 'Later' om de privésleutel later te genereren.
Selecteer 'Beheer' om de informatie te bekijken die je nodig hebt om de verbinding te maken.
Raadpleeg de Apple Developer-documentatie over het maken van de verbinding.