Dokumentacja API
Kompletna dokumentacja referencyjna dla zewnętrznego API Nomid MDM. Znajdź szczegółowe informacje o punktach końcowych, parametrach i formatach odpowiedzi.
Adres bazowy URL
https://api.nomid.tech/emm/api/v1 Sekcje dokumentacji
Uwierzytelnianie
Dowiedz się, jak uwierzytelniać swoje żądania API za pomocą kluczy API.
Zasoby
Punkty końcowe do listowania, filtrowania i pobierania informacji o zasobach.
Zasady
Punkty końcowe do uzyskiwania dostępu do danych zasad i przypisanych urządzeń.
Błędy
Zrozumienie odpowiedzi o błędach i kodów statusu.
Integracja BI
Spłaszczone eksporty danych dla narzędzi Business Intelligence.
API poleceń urządzeń
Wysyłaj polecenia do jednego urządzenia naraz za pomocą wywołania REST – od blokady, ponownego uruchomienia i wiadomości po polecenia destrukcyjne, takie jak wyczyszczenie danych.
API zmian zasad
Zmieniaj ustawienia zasad, aplikacje, sieci Wi-Fi i nie tylko, twórz zasady od podstaw lub jako kopie bądź przywracaj ich wcześniejsze wersje, korzystając z etapu weryfikacji przed zastosowaniem jakichkolwiek zmian.
API kodów QR do aprowizacji
Utwórz kod QR, który rejestruje nowe urządzenie z systemem Android z daną zasadą, z własnym tokenem rejestracji ważnym przez 24 godz.
API przesyłania APK
Publikuj podpisane wydania APK w bibliotece firmy z potoku CI, używając klucza API przypisanego do firmy.
API aplikacji biblioteki
Odczytuj aplikacje biblioteki firmy, wydania APK, ikony, kategorie i tracki oraz zarządzaj nimi za pomocą klucza API przypisanego do firmy.
API sesji użytkowników urządzeń
Zgłaszaj logowania i wylogowania użytkowników, których Twoja własna aplikacja loguje na zarządzanym urządzeniu, oraz odczytuj, kto i kiedy korzystał z danego urządzenia.
Wszystkie punkty końcowe
| Metoda | Punkt końcowy | Opis |
|---|---|---|
| GET | /assets | Wyświetl wszystkie zasoby z paginacją i filtrowaniem |
| GET | /assets/count | Uzyskaj łączną liczbę zasobów |
| GET | /assets/{id} | Uzyskaj szczegóły konkretnego zasobu |
| GET | /policies | Wyświetl wszystkie zasady |
| GET | /policies/{pathName} | Uzyskaj szczegóły konkretnej zasady |
| GET | /assets/summary | Pobierz zagregowane dane floty: łączne sumy, zestawienie według stanu oraz podsumowanie stanu bezpieczeństwa |
| GET | /assets/{assetId}/commands | Wyświetl listę ostatnich poleceń wysłanych do urządzenia |
| POST | /assets/{assetId}/commands/lock | Natychmiast zablokuj ekran urządzenia. Tylko urządzenia Android Management. Brak treści żądania. |
| POST | /assets/{assetId}/commands/lost-mode | Zablokuj urządzenie i wyświetl komunikat, z opcjonalnymi danymi kontaktowymi, na jego ekranie blokady. Tylko urządzenia Android Management. |
| POST | /assets/{assetId}/commands/found | Zakończ tryb utracony. Jeśli urządzenie nie było w trybie utraconym, nic się nie dzieje i żaden błąd nie jest zwracany. Tylko urządzenia Android Management. Brak treści żądania. |
| POST | /assets/{assetId}/commands/message | Wyświetl powiadomienie push w postaci zwykłego tekstu na urządzeniu. |
| POST | /assets/{assetId}/commands/status-report | Zażądaj od urządzenia natychmiastowego wysłania nowego raportu o stanie. Raport nadejdzie później: odczytaj go za pomocą GET /assets/ASSET_ID. Brak treści żądania. |
| POST | /assets/{assetId}/commands/location-update | Zażądaj od urządzenia natychmiastowego zgłoszenia bieżącej lokalizacji. Lokalizacja nadejdzie później: odczytaj ją za pomocą GET /assets/ASSET_ID. Brak treści żądania. |
| POST | /assets/{assetId}/commands/sync-policy | Wyślij urządzeniu ponownie jego bieżące zasady. Tylko urządzenia zarządzane przez agenta Nomid (AOSP): urządzenia Android Management otrzymują zmiany zasad automatycznie i zwracają kod 409. Brak treści żądania. |
| POST | /assets/{assetId}/commands/reboot | Uruchom ponownie urządzenie teraz. Praca osoby, która go używa, zostanie przerwana, a niezapisane dane mogą zostać utracone. Brak treści żądania. |
| POST | /assets/{assetId}/commands/shutdown | Wyłącz urządzenie teraz. Nie można go włączyć ponownie zdalnie. Tylko urządzenia zarządzane przez agenta Nomid (AOSP). Brak treści żądania. |
| POST | /assets/{assetId}/commands/launch-app | Otwórz zainstalowaną aplikację na urządzeniu według nazwy pakietu. Tylko urządzenia zarządzane przez agenta Nomid (AOSP). |
| POST | /assets/{assetId}/commands/clear-app-data | Usuń wszystkie dane podanych aplikacji (konta, ustawienia i pliki), tak jakby dopiero zostały zainstalowane. Działania nie można cofnąć. Tylko urządzenia Android Management. |
| POST | /assets/{assetId}/commands/change-policy | Przenieś urządzenie do innych zasad firmy. Urządzenie zastosuje aplikacje, ograniczenia i ustawienia nowych zasad, a wszystko, co znajdowało się wyłącznie w bieżących zasadach, zostanie usunięte. Wymaga również uprawnienia POLICIES_READ. |
| POST | /assets/{assetId}/commands/wipe | Usuń urządzenie z zarządzania i wyczyść jego zarządzane dane. Urządzenie firmowe zostanie przywrócone do ustawień fabrycznych: wszystkie aplikacje i dane na nim zostaną usunięte. Na urządzeniu prywatnym z profilem służbowym usuwany jest tylko profil służbowy oraz jego aplikacje i dane; prywatne aplikacje i dane pozostają nienaruszone. Działanie nieodwracalne. Brak treści żądania. |
| POST | /assets/{assetId}/commands/reset-screen-lock | Usuń blokadę ekranu urządzenia (PIN, wzór lub hasło), aby można je było odblokować bez niej. Tylko urządzenia Android Management. Brak treści żądania. |
| POST | /assets/{assetId}/commands/change-screen-lock-password | Ustaw nowe hasło blokady ekranu. Urządzenie zablokuje się i tylko nowe hasło je odblokuje. Tylko urządzenia Android Management. |
| POST | /assets/{assetId}/commands/uninstall-apps | Odinstaluj podane aplikacje i wszystkie ich dane z urządzenia. Tylko urządzenia zarządzane przez agenta Nomid (AOSP) w wersji 4.5.20 lub nowszej: urządzenia Android Management odpowiadają kodem 409, a starszy agent zapisuje polecenie jako nieudane. Urządzenie wykonuje je przy następnym połączeniu z serwerem, nawet po kilku dniach. Aplikacja, którą zasady urządzenia nadal instalują, wraca po następnej synchronizacji zasad, więc aby jej nie było na urządzeniu, zablokuj ją w zasadach. |
| POST | /assets/{assetId}/commands/relinquish-ownership | Przekaż urządzenie firmowe jego użytkownikowi. Profil służbowy i jego dane zostaną usunięte, a urządzenie przestanie być zarządzane. Działanie nieodwracalne. Brak treści żądania. |
| GET | /policies/{policyId}/settings | Edytowalne ustawienia zasad, każde z bieżącą wartością, dozwolonymi wartościami, grupą oraz informacją, czy jest oznaczone jako ustawienie o dużym wpływie, co sprawia, że jego zmiana ma status HIGH już od 1 urządzenia. Zwraca też wersję zasad, deviceCount, informację, czy zasady są edytowalne, oraz ich aplikacje, każdą z polami packageName, name, source, installType i managedByNomid, które ma wartość true dla aplikacji, których nie można tu zmienić. |
| GET | /policies/{policyId}/document | Pełna konfiguracja zasady w formacie JSON w polu value lub tylko jej część pod wskazaną path (wskaźnik JSON Pointer, np. /openNetworkConfigurations). Do aplikacji odwołuje się za pomocą nazwy pakietu, np. /apps/com.example.app. Dane poufne są zwracane jako znacznik (obiekt z właściwością redacted ustawioną na true), podobnie jak każda wartość konfiguracji zarządzanej aplikacji. Bez podania path zwracane jest podsumowanie aplikacji zawierające packageName, name, source, installType oraz managedConfigurationKeys. Zwraca również policyId, displayName, version, deviceCount, editable oraz lockedFields – pola odrzucane przez punkt końcowy edycji, każde z podaniem przyczyny. Fragment dłuższy niż 30000 znaków zwraca fieldSizes zamiast value: należy odczytać bardziej szczegółową ścieżkę. Zwraca 422, gdy path wskazuje aplikację, której nie ma w zasadzie. |
| GET | /policies/{policyId}/revisions | Zapisane wersje zasady, od najnowszej, wraz z informacją, kiedy i przez kogo każda z nich została zapisana. Parametr limit jest opcjonalny, od 1 do 100, domyślnie 20. |
| GET | /policy-proposals/{proposalId} | Propozycja utworzona przez ten klucz, z listą zmian i statusem: PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED lub EXPIRED. |
| POST | /policies/{policyId}/changes | Zaproponuj zmiany ustawień w istniejącej zasadzie. Zwraca kod 201 wraz z propozycją. |
| POST | /policies/{policyId}/app-changes | Zaproponuj dodanie aplikacji do istniejącej zasady, ich usunięcie lub zmianę sposobu instalacji. Zwraca kod 201 wraz z propozycją. |
| POST | /policies/{policyId}/edits | Zaproponuj zmiany w dowolnej edytowalnej części istniejącej zasady w postaci modyfikacji jej dokumentu za pomocą wskaźników JSON Pointer. Zwraca kod 201 wraz z propozycją. |
| POST | /policies/{policyId}/home-screen | Proponuje zmianę ekranu głównego w zasadach: własny ekran główny urządzenia, launcher Nomid lub Nomid Kiosk, wraz z dockiem launchera i wyświetlanymi aplikacjami. Zwraca kod 201 z propozycją. |
| POST | /policies/{policyId}/details | Proponuje zmianę opisu, tagów lub grupy zasady. Nie ma to wpływu na urządzenia, więc nigdy nie jest to wpływ HIGH. Zwraca kod 201 z propozycją. |
| POST | /policies | Zaproponuj nową zasadę z opcjonalnymi zmianami ustawień. Z parametrem fromPolicyId stanowi ona kopię tej zasady, a bez zmian – jej duplikat. Bez parametru fromPolicyId bazuje na wartościach domyślnych Nomid. Zwraca kod 201 wraz z propozycją. |
| POST | /policies/{policyId}/rollbacks | Zaproponuj przywrócenie zasady do wcześniejszej wersji. Zwraca kod 201 wraz z propozycją. |
| POST | /policy-proposals/{proposalId}/apply | Zastosuj oczekującą propozycję. Zwraca kod 200 wraz z propozycją i jej wynikiem: policyId, displayName, version oraz łączem do portalu. |
| POST | /policies/{policyId}/provisioning-qr-codes | Utwórz kod QR do aprowizacji dla zasady z nowym tokenem rejestracji |
| POST | /library/apps/uploads/check | Sprawdź kwalifikowalność, duplikaty zawartości i istniejącą sesję możliwą do wznowienia. Duplikat ma charakter informacyjny. |
| POST | /library/apps/uploads/start | Rozpocznij przesyłanie i odbierz sessionId, partSize oraz expiresAt. |
| POST | /library/apps/uploads/parts/sign | Pobierz krótkotrwały bezpośredni adres URL PUT do S3 oraz requiredHeaders dla jednej części. |
| GET | /library/apps/uploads/parts/{sessionId} | Wyświetl przesłane części nadające się do ponownego użycia wraz z ich dokładnymi wartościami ETag dla tej samej sesji. |
| POST | /library/apps/uploads/complete | Prześlij uporządkowaną listę części i opcjonalne tracks, aby złożyć i przetworzyć APK. |
| GET | /library/apps/uploads/status/{sessionId} | Odpytuj sesję, aż status przyjmie wartość completed lub failed. |
| DELETE | /library/apps/uploads/abort/{sessionId} | Przerwij niezakończoną sesję; sesji w trakcie przetwarzania (processing) lub ukończonych (completed) nie można przerwać. |
| GET | /library/apps/{packageName}/versions/{versionCode}/check-report | Odczytaj najnowszy raport kontroli przesyłania dla jednego wydania. Wymaga packageName i versionCode wydania oraz jego środowiska, gdy nie jest puste. |
| GET | /library/apps | Wyświetla widoczne aplikacje stronami; includeHidden może uwzględnić ukryte aplikacje. |
| GET | /library/apps/{packageName} | Pobiera jedną aplikację, także gdy jest ukryta. |
| GET | /library/apps/{packageName}/versions | Wyświetla wydania; includeHidden może uwzględnić ukryte wydania. |
| GET | /library/apps/{packageName}/versions/{versionCode} | Pobiera jedno wydanie, także gdy jest ukryte. Podaj jego environment, gdy nie jest pusty. |
| PATCH | /library/apps/{packageName}/display-name | Ustawia nazwę wyświetlaną lub przywraca nazwę z pliku APK. |
| PATCH | /library/apps/{packageName}/categories | Zastępuje etykiety kategorii aplikacji. |
| POST | /library/apps/{packageName}/icon | Przesyła ikonę jako multipart form-data w polu file. |
| DELETE | /library/apps/{packageName}/icon | Usuwa ikonę niestandardową. |
| DELETE | /library/apps/{packageName} | Ukrywa istniejącą aplikację; zwraca 204 i nie usuwa jej fizycznie. |
| POST | /library/apps/{packageName}/publish | Przywraca aplikację w sposób idempotentny; zwraca aplikację. |
| DELETE | /library/apps/{packageName}/versions/{versionCode} | Ukrywa istniejące wydanie; zwraca 204. W przypadku ostatniego opublikowanego wydania aplikacja zostaje ukryta, a to wydanie pozostaje opublikowane, aby umożliwić przywrócenie. Podaj jego environment, gdy nie jest pusty. |
| POST | /library/apps/{packageName}/versions/{versionCode}/publish | Przywraca wydanie i, w razie potrzeby, jego aplikację. Podaj jego environment, gdy nie jest pusty. |
| GET | /library/apps/{packageName}/tracks | Wyświetla najnowsze opublikowane wydanie dla każdego tracku opublikowanej aplikacji. Przy równych kodach wersji wygrywa leksykograficznie najwyższy environment. |
| PUT | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Przypisuje opublikowane wydanie do tracku; zwraca przypisanie. Podaj jego environment, gdy nie jest pusty. |
| DELETE | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Usuwa przypisanie tracku; zwraca 204. Podaj jego environment, gdy nie jest pusty. |
| GET | /device-user-logins | Wyświetl sesje użytkowników urządzeń, od najnowszych, z opcjonalnymi filtrami |
| POST | /device-user-logins | Zgłoś, że użytkownik uwierzytelniony przez Twój system zalogował się na urządzeniu; zwraca kod 201 wraz z sesją |
| POST | /device-user-logins/logout | Zgłoś wylogowanie według loginId lub według urządzenia i użytkownika; zwraca powiązane sesje |
Typy zawartości
Wszystkie żądania i odpowiedzi używają formatu JSON. Ustaw odpowiednio nagłówek Content-Type.
Content-Type: application/json