Skapa ett API-konto i Apple School Manager
Med API:erna för Apple School Manager och Apple Business Manager kan du redigera enheternas hanteringstilldelningar och visa enhetsinformation. Du kan också använda en enhets slutpunkt för att göra det möjligt för appar att skapa anpassade rapporter eller exportera enhetsdata.
Översikt
Med API:et för Apple School Manager och Apple Business Manager kan du redigera enheternas hanteringstilldelningar och visa enhetsinformation. Du kan också använda en enhets slutpunkt för att göra det möjligt för appar att skapa anpassade rapporter eller exportera enhetsdata. API:et har stöd för OAuth 2. Med OAuth 2 autentiserar appar med en uppsättning autentiseringsuppgifter i utbyte mot en åtkomsttoken för att skicka autentiserade förfrågningar till API:et.
Innan du använder dessa API:er måste du skapa ett API-konto i Apple School Manager. Endast användare med rollen Administratör och Platsansvarig kan skapa ett API-konto.
Dataåtkomst
När API-kontot är korrekt konfigurerat kan det kontot göra det möjligt för en app att komma åt följande information:
Kategori | Funktion | Beskrivning |
|---|---|---|
Enheter | Hämta organisationsenheter | Hämta en lista över enheter i en organisation som registreras med automatiserad enhetsregistrering. |
Enheter | Hämta enhetsinformation | Hämta information om en enhet i en organisation, såsom enhetens modell, beställningsnummer och artikelnummer. |
Enhetshanteringstjänster | Hämta enhetshanteringstjänster | Hämta en lista över enhetshanteringstjänster i en organisation. |
Enhetshanteringstjänster | Hämta enhetens serienummer för en enhetshanteringstjänst | Hämta en lista över enhetsserienummer som tilldelats till en enhetshanteringstjänst. |
Enhetshanteringstjänster | Hämta tjänst-ID för den tilldelade enhetshanteringstjänsten för en enhet | Hämta information om tjänst-ID för den tilldelade enhetshanteringstjänsten för en enhet. |
Enhetshanteringstjänster | Hämta tjänsteinformation för den tilldelade enhetshanteringstjänsten för en enhet | Hämta tjänsteinformation för den tilldelade enhetshanteringstjänsten för en enhet. |
Enhetshanteringstjänster | Hämta information om enhetsaktivitet | Hämta information om en aktivitet på en organisationsenhet som en enhetshanteringsåtgärd skapar, såsom tilldelning eller borttagning av tilldelning. |
Enhetshanteringstjänster | Tilldela eller ta bort tilldelningar för enheter till en enhetshanteringstjänst | Tilldela eller ta bort tilldelningar för enheter till en enhetshanteringstjänst. |
Generera en privat nyckel
För att upprätthålla en säker anslutning till Apple School Manager behöver du generera en privat nyckel. Filnamnet för nyckeln slutar på .pem och du genererar den endast en gång.
Skapa ett API-konto och hämta den privata nyckeln
Logga in i Apple School Manager
med ett konto som har rollen Administratör eller Platsansvarig.Välj ditt namn längst ned i sidofältet, välj Inställningar
och välj sedan API.Välj Kom igång, ange ett namn för kontot och välj sedan Skapa.
Gör något av följande:
Välj Generera privat nyckel för att generera nyckeln.
Filen hämtas automatiskt till hämtningsplatsen i dina webbläsarinställningar, och om det inte finns någon sådan plats frågar systemet var filen ska sparas.
Välj Senare för att generera den privata nyckeln senare.
Välj Hantera för att visa informationen som du behöver för att skapa anslutningen.
Läs Apples utvecklardokumentation om hur du skapar anslutningen.