Αναφορά API
Πλήρης τεκμηρίωση αναφοράς για το Nomid MDM External API. Βρείτε λεπτομερείς πληροφορίες σχετικά με τα τελικά σημεία, τις παραμέτρους και τις μορφές απόκρισης.
Βασική διεύθυνση URL
https://api.nomid.tech/emm/api/v1 Ενότητες Τεκμηρίωσης
Έλεγχος Ταυτότητας
Μάθετε πώς να ελέγχετε την ταυτότητα των αιτημάτων σας API χρησιμοποιώντας κλειδιά API.
Περιουσιακά Στοιχεία
Σημεία πρόσβασης για καταχώριση, φιλτράρισμα και ανάκτηση πληροφοριών περιουσιακών στοιχείων.
Πολιτικές
Σημεία πρόσβασης για πρόσβαση σε δεδομένα πολιτικών και αναθέσεις συσκευών.
Σφάλματα
Κατανόηση αποκρίσεων σφαλμάτων και κωδικών κατάστασης.
Ενσωμάτωση BI
Εξαγωγές επίπεδων δεδομένων για εργαλεία Business Intelligence.
API εντολών συσκευής
Στείλτε μια εντολή σε μία συσκευή κάθε φορά με μια κλήση REST, από κλείδωμα, επανεκκίνηση και μηνύματα έως καταστροφικές εντολές όπως η εκκαθάριση (wipe).
API αλλαγών πολιτικής
Αλλάξτε ρυθμίσεις πολιτικής, εφαρμογές, δίκτυα Wi-Fi και πολλά άλλα, δημιουργήστε μια πολιτική από την αρχή ή ως αντίγραφο, ή επαναφέρετέ την σε προηγούμενη έκδοση, με ένα βήμα ελέγχου πριν εφαρμοστεί οτιδήποτε.
API κωδικών QR προετοιμασίας (provisioning)
Δημιουργήστε έναν κωδικό QR που εγγράφει μια νέα συσκευή Android με μια πολιτική, με το δικό του διακριτικό εγγραφής έγκυρο για 24 ώρες.
API μεταφορτώσεων APK
Δημοσιεύστε υπογεγραμμένες εκδόσεις APK στη βιβλιοθήκη της εταιρείας σας από μια γραμμή CI με ένα κλειδί API που ισχύει για την εταιρεία.
API εφαρμογών βιβλιοθήκης
Διαβάστε και διαχειριστείτε τις εφαρμογές της βιβλιοθήκης της εταιρείας, τις εκδόσεις APK, τα εικονίδια, τις κατηγορίες και τα tracks με ένα κλειδί API που ισχύει για την εταιρεία.
API συνεδριών Device User
Αναφέρετε τις συνδέσεις και αποσυνδέσεις χρηστών τους οποίους συνδέει η δική σας εφαρμογή σε μια διαχειριζόμενη συσκευή και διαβάστε ποιος χρησιμοποίησε ποια συσκευή και πότε.
Όλα τα Endpoints
| Μέθοδος | Endpoint | Περιγραφή |
|---|---|---|
| GET | /assets | Λίστα όλων των στοιχείων με σελιδοποίηση και φιλτράρισμα |
| GET | /assets/count | Λήψη συνολικού αριθμού στοιχείων |
| GET | /assets/{id} | Λήψη λεπτομερειών ενός συγκεκριμένου στοιχείου |
| GET | /policies | Λίστα όλων των πολιτικών |
| GET | /policies/{pathName} | Λήψη λεπτομερειών μιας συγκεκριμένης πολιτικής |
| GET | /assets/summary | Λήψη συγκεντρωτικών αριθμών στόλου: σύνολα, ανάλυση κατάστασης και σύνοψη επιπέδου ασφαλείας |
| GET | /assets/{assetId}/commands | Προβολή των πιο πρόσφατων εντολών που στάλθηκαν σε μια συσκευή |
| POST | /assets/{assetId}/commands/lock | Κλείδωμα της οθόνης της συσκευής αμέσως. Μόνο για συσκευές Android Management. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/lost-mode | Κλείδωμα της συσκευής και εμφάνιση μηνύματος, με προαιρετικά στοιχεία επικοινωνίας, στην οθόνη κλειδώματος. Μόνο για συσκευές Android Management. |
| POST | /assets/{assetId}/commands/found | Τερματισμός λειτουργίας απώλειας (lost mode). Δεν συμβαίνει τίποτα και δεν επιστρέφεται σφάλμα εάν η συσκευή δεν βρισκόταν σε λειτουργία απώλειας. Μόνο για συσκευές Android Management. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/message | Εμφάνιση ειδοποίησης push απλού κειμένου στη συσκευή. |
| POST | /assets/{assetId}/commands/status-report | Αίτημα προς τη συσκευή για αποστολή νέας αναφοράς κατάστασης τώρα. Η αναφορά φτάνει αργότερα: διαβάστε την με GET /assets/ASSET_ID. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/location-update | Αίτημα προς τη συσκευή να αναφέρει την τρέχουσα τοποθεσία της τώρα. Η τοποθεσία φτάνει αργότερα: διαβάστε την με GET /assets/ASSET_ID. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/sync-policy | Αποστολή της τρέχουσας πολιτικής στη συσκευή ξανά. Μόνο για συσκευές που διαχειρίζονται από τον πράκτορα Nomid (AOSP): οι συσκευές Android Management λαμβάνουν τις αλλαγές πολιτικής αυτόματα και απαντούν με 409. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/reboot | Επανεκκίνηση της συσκευής τώρα. Όποιος τη χρησιμοποιεί διακόπτεται και ενδέχεται να χαθεί μη αποθηκευμένη εργασία. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/shutdown | Απενεργοποίηση της συσκευής τώρα. Δεν μπορεί να ενεργοποιηθεί ξανά εξ αποστάσεως. Μόνο για συσκευές που διαχειρίζονται από τον πράκτορα Nomid (AOSP). Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/launch-app | Άνοιγμα μιας εγκατεστημένης εφαρμογής στη συσκευή βάσει ονόματος πακέτου. Μόνο για συσκευές που διαχειρίζονται από τον πράκτορα Nomid (AOSP). |
| POST | /assets/{assetId}/commands/clear-app-data | Διαγραφή όλων των δεδομένων των καθορισμένων εφαρμογών (λογαριασμοί, ρυθμίσεις και αρχεία), σαν να είχαν μόλις εγκατασταθεί. Δεν μπορεί να αναιρεθεί. Μόνο για συσκευές Android Management. |
| POST | /assets/{assetId}/commands/change-policy | Μετακίνηση της συσκευής σε άλλη πολιτική της εταιρείας. Η συσκευή εφαρμόζει τις εφαρμογές, τους περιορισμούς και τις ρυθμίσεις της νέας πολιτικής, και οτιδήποτε περιείχε μόνο η τρέχουσα πολιτική καταργείται. Απαιτείται επίσης το POLICIES_READ. |
| POST | /assets/{assetId}/commands/wipe | Κατάργηση της συσκευής από τη διαχείριση και διαγραφή των διαχειριζόμενων δεδομένων της. Μια εταιρική συσκευή επαναφέρεται στις εργοστασιακές ρυθμίσεις: κάθε εφαρμογή και όλα τα δεδομένα σε αυτήν διαγράφονται. Σε μια προσωπική συσκευή με προφίλ εργασίας, αφαιρούνται μόνο το προφίλ εργασίας και οι εφαρμογές και τα δεδομένα του· οι προσωπικές εφαρμογές και τα δεδομένα παραμένουν. Μη αναστρέψιμο. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/reset-screen-lock | Κατάργηση του κλειδώματος οθόνης της συσκευής (PIN, μοτίβο ή κωδικός πρόσβασης), ώστε να μπορεί να ξεκλειδωθεί χωρίς αυτό. Μόνο για συσκευές Android Management. Χωρίς σώμα αιτήματος. |
| POST | /assets/{assetId}/commands/change-screen-lock-password | Ορισμός νέου κωδικού πρόσβασης κλειδώματος οθόνης. Η συσκευή κλειδώνει και ξεκλειδώνεται μόνο με τον νέο κωδικό πρόσβασης. Μόνο για συσκευές Android Management. |
| POST | /assets/{assetId}/commands/uninstall-apps | Απεγκατάσταση των καθορισμένων εφαρμογών και όλων των δεδομένων τους από τη συσκευή. Μόνο για συσκευές που διαχειρίζεται ο πράκτορας Nomid (AOSP), έκδοση 4.5.20 ή νεότερη: οι συσκευές Android Management απαντούν 409 και ένας παλαιότερος πράκτορας καταγράφει την εντολή ως αποτυχημένη. Η συσκευή την εκτελεί στην επόμενη επικοινωνία της, ακόμη και μέρες αργότερα. Μια εφαρμογή που η πολιτική της συσκευής εξακολουθεί να εγκαθιστά επιστρέφει στον επόμενο συγχρονισμό της πολιτικής· για να μείνει εκτός, αποκλείστε την στην πολιτική. |
| POST | /assets/{assetId}/commands/relinquish-ownership | Αποδέσμευση εταιρικής συσκευής στον χρήστη της. Το προφίλ εργασίας και τα δεδομένα του καταργούνται και η συσκευή παύει να διαχειρίζεται. Μη αναστρέψιμο. Χωρίς σώμα αιτήματος. |
| GET | /policies/{policyId}/settings | Οι επεξεργάσιμες ρυθμίσεις της πολιτικής, καθεμία με την τρέχουσα τιμή της, τις επιτρεπτές τιμές, την ομάδα και το αν επισημαίνεται ως υψηλού αντίκτυπου, κάτι που κάνει την αλλαγή της HIGH από 1 συσκευή. Επιστρέφει επίσης την έκδοση της πολιτικής, το deviceCount, το αν η πολιτική είναι επεξεργάσιμη και τις εφαρμογές της, καθεμία με packageName, name, source, installType και managedByNomid, που είναι true για τις εφαρμογές που δεν μπορούν να αλλάξουν εδώ. |
| GET | /policies/{policyId}/document | Η πλήρης διαμόρφωση της πολιτικής ως JSON στο value ή μόνο το τμήμα στη διαδρομή path, ένας δείκτης JSON όπως /openNetworkConfigurations. Μια εφαρμογή προσδιορίζεται από το όνομα πακέτου της, όπως στο /apps/com.example.app. Τα μυστικά επιστρέφονται ως δείκτης, ένα αντικείμενο με το redacted ορισμένο σε true, όπως συμβαίνει και με κάθε τιμή της διαχειριζόμενης διαμόρφωσης μιας εφαρμογής. Χωρίς το path, οι εφαρμογές συνοψίζονται με τα packageName, name, source, installType και managedConfigurationKeys. Επίσης επιστρέφει policyId, displayName, version, deviceCount, editable και lockedFields, τα πεδία που απορρίπτει το τελικό σημείο επεξεργασίας, το καθένα με την αιτιολογία. Ένα τμήμα μεγαλύτερο από 30000 χαρακτήρες επιστρέφει fieldSizes αντί για value: διαβάστε μια στενότερη διαδρομή. Επιστρέφει 422 όταν το path ονομάζει μια εφαρμογή που δεν διαθέτει η πολιτική. |
| GET | /policies/{policyId}/revisions | Οι αποθηκευμένες αναθεωρήσεις της πολιτικής, με τις νεότερες πρώτα, μαζί με το πότε και από ποιον αποθηκεύτηκε η καθεμία. Το limit είναι προαιρετικό, από 1 έως 100, προεπιλογή 20. |
| GET | /policy-proposals/{proposalId} | Μια πρόταση που πραγματοποιήθηκε από αυτό το κλειδί, με τη λίστα αλλαγών της και την κατάσταση: PENDING, EXECUTING, SUCCEEDED, FAILED, UNCONFIRMED ή EXPIRED. |
| POST | /policies/{policyId}/changes | Πρόταση αλλαγών ρυθμίσεων σε υπάρχουσα πολιτική. Επιστρέφει 201 με την πρόταση. |
| POST | /policies/{policyId}/app-changes | Προτείνετε την προσθήκη εφαρμογών σε μια υπάρχουσα πολιτική, την κατάργησή τους ή την αλλαγή του τρόπου εγκατάστασής τους. Επιστρέφει 201 μαζί με την πρόταση. |
| POST | /policies/{policyId}/edits | Προτείνετε αλλαγές σε οποιοδήποτε επεξεργάσιμο τμήμα μιας υπάρχουσας πολιτικής, ως τροποποιήσεις δείκτη JSON του εγγράφου της. Επιστρέφει 201 μαζί με την πρόταση. |
| POST | /policies/{policyId}/home-screen | Προτείνει αλλαγή στην αρχική οθόνη της πολιτικής: την αρχική οθόνη της ίδιας της συσκευής, τον launcher του Nomid ή το Nomid Kiosk, με το dock του launcher και τις εφαρμογές που εμφανίζει. Επιστρέφει 201 με την πρόταση. |
| POST | /policies/{policyId}/details | Προτείνει αλλαγή στην περιγραφή, τις ετικέτες ή την ομάδα της πολιτικής. Οι συσκευές δεν επηρεάζονται, οπότε δεν έχει ποτέ αντίκτυπο HIGH. Επιστρέφει 201 με την πρόταση. |
| POST | /policies | Προτείνετε μια νέα πολιτική, με προαιρετικές αλλαγές ρυθμίσεων. Με το fromPolicyId αποτελεί αντίγραφο αυτής της πολιτικής και χωρίς αλλαγές ένα ακριβές αντίγραφο. Χωρίς το fromPolicyId ξεκινά από τις προεπιλογές του Nomid. Επιστρέφει 201 μαζί με την πρόταση. |
| POST | /policies/{policyId}/rollbacks | Πρόταση επαναφοράς της πολιτικής σε προηγούμενη αναθεώρηση. Επιστρέφει 201 με την πρόταση. |
| POST | /policy-proposals/{proposalId}/apply | Εφαρμογή εκκρεμούς πρότασης. Επιστρέφει 200 με την πρόταση και το αποτέλεσμά της: policyId, displayName, version και σύνδεσμο πύλης. |
| POST | /policies/{policyId}/provisioning-qr-codes | Δημιουργήστε έναν κωδικό QR προετοιμασίας για μια πολιτική, με ένα νέο διακριτικό εγγραφής |
| POST | /library/apps/uploads/check | Ελέγξτε την επιλεξιμότητα, το διπλότυπο περιεχόμενο και μια υπάρχουσα συνεδρία που μπορεί να συνεχιστεί. Ένα διπλότυπο είναι ενημερωτικό. |
| POST | /library/apps/uploads/start | Ξεκινήστε μια μεταφόρτωση και λάβετε sessionId, partSize και expiresAt. |
| POST | /library/apps/uploads/parts/sign | Λάβετε μια βραχύβια διεύθυνση URL PUT απευθείας στο S3 και τα requiredHeaders για ένα τμήμα. |
| GET | /library/apps/uploads/parts/{sessionId} | Εμφανίστε τα τμήματα που έχουν ήδη μεταφορτωθεί και μπορούν να επαναχρησιμοποιηθούν, μαζί με τα ακριβή ETag τους, για την ίδια συνεδρία. |
| POST | /library/apps/uploads/complete | Υποβάλετε την ταξινομημένη λίστα τμημάτων και προαιρετικά κανάλια (tracks) για τη σύνθεση και την επεξεργασία του APK. |
| GET | /library/apps/uploads/status/{sessionId} | Ελέγχετε περιοδικά τη συνεδρία μέχρι το status να γίνει completed ή failed. |
| DELETE | /library/apps/uploads/abort/{sessionId} | Ακυρώστε μια μη ολοκληρωμένη συνεδρία· συνεδρίες σε επεξεργασία ή ολοκληρωμένες δεν μπορούν να ακυρωθούν. |
| GET | /library/apps/{packageName}/versions/{versionCode}/check-report | Διαβάστε την τελευταία αναφορά ελέγχου μεταφόρτωσης μιας έκδοσης. Χρειάζεται το packageName και το versionCode της έκδοσης, καθώς και το περιβάλλον της όταν αυτό δεν είναι κενό. |
| GET | /library/apps | Παραθέτει τις ορατές εφαρμογές ανά σελίδα· το includeHidden μπορεί να συμπεριλάβει τις κρυφές εφαρμογές. |
| GET | /library/apps/{packageName} | Επιστρέφει μία εφαρμογή, ακόμη και όταν είναι κρυφή. |
| GET | /library/apps/{packageName}/versions | Παραθέτει τις εκδόσεις· το includeHidden μπορεί να συμπεριλάβει τις κρυφές εκδόσεις. |
| GET | /library/apps/{packageName}/versions/{versionCode} | Επιστρέφει μία έκδοση, ακόμη και όταν είναι κρυφή. Δώστε το environment της όταν δεν είναι κενό. |
| PATCH | /library/apps/{packageName}/display-name | Ορίζει ένα εμφανιζόμενο όνομα ή το επαναφέρει στο όνομα του APK. |
| PATCH | /library/apps/{packageName}/categories | Αντικαθιστά τις ετικέτες κατηγορίας της εφαρμογής. |
| POST | /library/apps/{packageName}/icon | Μεταφορτώνει ένα εικονίδιο ως multipart form-data μέσω του πεδίου file. |
| DELETE | /library/apps/{packageName}/icon | Αφαιρεί το προσαρμοσμένο εικονίδιο. |
| DELETE | /library/apps/{packageName} | Αποκρύπτει μια υπάρχουσα εφαρμογή· επιστρέφει 204 και δεν τη διαγράφει φυσικά. |
| POST | /library/apps/{packageName}/publish | Επαναφέρει μια εφαρμογή με ιδιοδυναμία (idempotent)· επιστρέφει την εφαρμογή. |
| DELETE | /library/apps/{packageName}/versions/{versionCode} | Αποκρύπτει μια υπάρχουσα έκδοση· επιστρέφει 204. Για την τελευταία δημοσιευμένη έκδοση, η εφαρμογή αποκρύπτεται ενώ η έκδοση αυτή παραμένει δημοσιευμένη ώστε να είναι δυνατή η επαναφορά. Δώστε το environment της όταν δεν είναι κενό. |
| POST | /library/apps/{packageName}/versions/{versionCode}/publish | Επαναφέρει μια έκδοση και, όταν χρειάζεται, την εφαρμογή της. Δώστε το environment της όταν δεν είναι κενό. |
| GET | /library/apps/{packageName}/tracks | Παραθέτει την τελευταία δημοσιευμένη έκδοση για κάθε track μιας δημοσιευμένης εφαρμογής. Σε ίσους κωδικούς έκδοσης υπερισχύει το λεξικογραφικά υψηλότερο environment. |
| PUT | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Αντιστοιχίζει μια δημοσιευμένη έκδοση σε ένα track· επιστρέφει την αντιστοίχιση. Δώστε το environment της όταν δεν είναι κενό. |
| DELETE | /library/apps/{packageName}/versions/{versionCode}/tracks/{trackName} | Αφαιρεί την αντιστοίχιση ενός track· επιστρέφει 204. Δώστε το environment της όταν δεν είναι κενό. |
| GET | /device-user-logins | Προβολή λίστας συνεδριών Device User, με τις νεότερες πρώτα, με προαιρετικά φίλτρα |
| POST | /device-user-logins | Αναφορά ότι ένας χρήστης του οποίου την ταυτότητα επαλήθευσε το σύστημά σας συνδέθηκε σε μια συσκευή· επιστρέφει 201 με τη συνεδρία |
| POST | /device-user-logins/logout | Αναφορά αποσύνδεσης, βάσει loginId ή βάσει συσκευής και χρήστη· επιστρέφει τις σχετικές συνεδρίες |
Τύποι Περιεχομένου
Όλα τα αιτήματα και οι απαντήσεις χρησιμοποιούν μορφή JSON. Ορίστε την κεφαλίδα Content-Type ανάλογα.
Content-Type: application/json