NomidZarządzanie aplikacjami biblioteki
Odczytuj aplikacje i wydania, edytuj metadane i tracki oraz ukrywaj lub przywracaj opublikowane treści.
Dostęp i zakres
Każda trasa wymaga X-API-Key z uprawnieniem LIBRARY_MANAGE. Zweryfikowany klucz wyznacza firmę; żądania nie mają parametru tenanta ani firmy. Istniejący klucz z LIBRARY_MANAGE może korzystać z tych tras bez dodatkowego przyznawania uprawnień. Uprawnienie wrażliwe jest domyślnie odznaczone; klucze, które go nie mają, nie otrzymują go automatycznie.
LIBRARY_MANAGE to wrażliwe uprawnienie obejmujące całą firmę, dotyczące przesyłania APK i zarządzania aplikacjami. Nie zapewnia przypisywania zasad, poleceń dla urządzeń, aprowizacji ani operacji na koncie.
LIBRARY_MANAGE obejmuje przesyłanie APK i opisane poniżej trasy zarządzania aplikacjami. Publiczne API dla plików, kontaktów i innych zasobów biblioteki nie są jeszcze dostępne. To uprawnienie nie zapewnia przypisywania zasad, poleceń dla urządzeń, aprowizacji ani administrowania kontem.
Edycje nazwy wyświetlanej i ikony korzystają z odroczonych wdrożeń metadanych. Ukrywanie aplikacji korzysta z istniejącego przeglądu usuwania; przywracanie treści i dodawanie tracków korzysta z istniejących ścieżek synchronizacji. Edycje kategorii aktualizują zapisane etykiety. Usunięcie tracku lub ukrycie jednego z kilku opublikowanych wydań nie planuje natychmiastowej synchronizacji urządzeń. Odpowiedź API potwierdza zapis w magazynie, a nie synchronizację ani instalację na urządzeniach.
Prześlij podpisany plik APK, korzystając z osobnego przewodnika po przesyłaniu APK.
Endpointy
https://api.nomid.tech/emm/api/v1
| Metoda | Punkt końcowy | Opis |
|---|---|---|
| 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. |
Żądania i odpowiedzi
GET /library/apps przyjmuje page (domyślnie 0), size (domyślnie 50, maksymalnie 100) i includeHidden (domyślnie false). Odpowiedź zawiera content (AppDto[]), page, size, totalElements i totalPages.
Kolekcja wersji domyślnie używa includeHidden=false i zwraca wydania z polami versionCode, environment, status, displayName, displayVersion, createdAt, sha256, fileSizeBytes, tracks i checkSummary (status i liczby ustaleń z najnowszego raportu kontroli przesłanego pliku; null dla wydań przesłanych, zanim kontrole istniały; zob. przewodnik po przesyłaniu APK). Każdy odczyt, ukrycie, publikacja lub zmiana tracku dotyczące wydania wskazuje dokładnie packageName, versionCode i environment. Pominięcie environment wybiera pusty environment. Zawsze podawaj go dla wydania z niepustym environment, nawet jeśli jego kod wersji jest unikalny.
Endpoint nazwy wyświetlanej przyjmuje ciąg displayName; wartość null lub pusta przywraca nazwę, w przeciwnym razie limit wynosi 100 znaków. Endpoint kategorii wymaga tablicy categories zawierającej co najwyżej 50 niepustych etykiet, każda do 100 znaków. Przesyłanie ikony używa pola multipart file.
Nazwy tracków są przycinane i muszą mieć od 1 do 10 znaków. Przypisania tracków przez PUT i DELETE wymagają opublikowanej aplikacji i opublikowanego wydania. Zawsze podawaj environment wydania, gdy nie jest pusty.
Ikony niestandardowe muszą być w formacie PNG lub JPEG, mieć najwyżej 1 MiB, co najmniej 192 piksele z każdej strony i być kwadratowe z tolerancją 2%. Serwer normalizuje zaakceptowane obrazy do PNG o wymiarach 512 pikseli.
PATCH /library/apps/com.example.app/display-name
Content-Type: application/json
{"displayName":"Field App"}
PATCH /library/apps/com.example.app/categories
Content-Type: application/json
{"categories":["Field tools"]}Widoczność i zachowanie wydań
Usunięcie aplikacji ukrywa ją i zachowuje jej dane. Opublikowanie aplikacji przywraca ją i można to bezpiecznie powtarzać. Endpoint pojedynczej aplikacji pozwala sprawdzić ukrytą aplikację; kolekcja aplikacji wyświetla widoczne aplikacje, chyba że użyto includeHidden=true.
Usunięcie istniejącego wydania ukrywa je, chyba że jest to ostatnie opublikowane wydanie: wtedy aplikacja zostaje ukryta, a to wydanie pozostaje opublikowane, aby można było przywrócić aplikację. Ukryte wydanie można opublikować ponownie; opublikowanie wydania może też przywrócić jego aplikację.
Kolekcja tracków zwraca najnowsze opublikowane wydanie dla każdego tracku opublikowanej aplikacji. Gdy kody wersji są równe, wygrywa leksykograficznie najwyższy environment. Zmiany tracków nie tworzą przypisań zasad.
Błędy
401 oznacza, że klucz nie został podany albo jest nieprawidłowy, wygasł lub został unieważniony. 403 oznacza brak LIBRARY_MANAGE. Sprawdź konfigurację klucza bez wypisywania go.
404 oznacza, że żądanej aplikacji lub wydania nie ma w firmie klucza albo że operacja wymaga opublikowanej aplikacji lub wydania. Edycje nazwy wyświetlanej, kategorii i ikony niestandardowej wymagają opublikowanej aplikacji; przed edycją metadanych przywróć ukrytą aplikację. Operacje na trackach wymagają opublikowanej aplikacji i wydania. Identyfikator z innej firmy nie jest ujawniany.
400 oznacza, że wartość w żądaniu lub zapytaniu jest nieprawidłowa. Popraw ją przed ponowną próbą.