Έλεγχος Ταυτότητας
Το Nomid MDM API χρησιμοποιεί κλειδιά API για τον έλεγχο ταυτότητας των αιτημάτων. Αυτός ο οδηγός εξηγεί πώς να αποκτήσετε και να χρησιμοποιήσετε το κλειδί API σας.
Επισκόπηση
Τα κλειδιά API χρησιμοποιούνται για τον έλεγχο ταυτότητας όλων των αιτημάτων στο Nomid MDM API. Συμπεριλάβετε το κλειδί API σας στην κεφαλίδα X-API-Key με κάθε αίτημα.
X-API-Key: nm_acme_a1b2c3d4e5f6... Λήψη του Κλειδιού API σας
Τα κλειδιά API δημιουργούνται και διαχειρίζονται μέσω της Πύλης Nomid. Ακολουθήστε αυτά τα βήματα για να δημιουργήσετε το πρώτο σας κλειδί API.
Προαπαιτούμενα
- Ένας λογαριασμός Nomid MDM με πρόσβαση διαχειριστή
- Πρόσβαση στις Ρυθμίσεις Εταιρείας στην Πύλη Nomid
- 1
Συνδεθείτε στην Πύλη Nomid
Ανοίξτε το πρόγραμμα περιήγησής σας και μεταβείτε στην Πύλη Nomid. Συνδεθείτε με τα διαπιστευτήριά σας ως διαχειριστής.
- 2
Μεταβείτε στις Ενσωματώσεις
Αφού συνδεθείτε, μεταβείτε στην ενότητα Ρυθμίσεις Εταιρείας και επιλέξτε την καρτέλα Ενσωματώσεις.
- 3
Κάντε κλικ στο Δημιουργία Κλειδιού API
Κάντε κλικ στο κουμπί "Δημιουργία Κλειδιού API" που βρίσκεται στην επάνω δεξιά γωνία της σελίδας Ενσωματώσεις.
- 4
Εισάγετε ένα Όνομα
Στο αναδυόμενο παράθυρο που εμφανίζεται, εισαγάγετε ένα περιγραφικό όνομα για το κλειδί API σας. Αυτό σας βοηθά να αναγνωρίσετε το κλειδί αργότερα (π.χ., "Ενσωμάτωση Power BI" ή "Συγχρονισμός CRM").
- 5
Αντιγράψτε το Κλειδί σας
Μετά το κλικ στο Δημιουργία, το κλειδί API σας θα εμφανιστεί. Κάντε κλικ στο κουμπί Αντιγραφή για να το αντιγράψετε στο πρόχειρο. Το κλειδί θα εμφανιστεί μόνο μία φορά!
Μορφή Κλειδιού API
Τα κλειδιά API ακολουθούν αυτήν τη μορφή:
nm_{company}_{random_32_chars} - Όλα τα κλειδιά ξεκινούν με 'nm_
- Πρόθεμα ειδικό για την εταιρεία για αναγνώριση
- 32 τυχαίοι χαρακτήρες για ασφάλεια
Χρήση του Κλειδιού API σας
Συμπεριλάβετε το κλειδί API στην κεφαλίδα X-API-Key με κάθε αίτημα:
curl -X GET "https://api.nomid.tech/emm/api/v1/assets" \
-H "X-API-Key: nm_acme_a1b2c3d4e5f6..." Δικαιώματα κλειδιού API
Κάθε κλειδί φέρει τα δικαιώματα που επιλέγετε κατά τη δημιουργία του. Ένα τελικό σημείο επιστρέφει 403 εάν το κλειδί δεν διαθέτει το δικαίωμα που χρειάζεται. Ο διακομιστής MCP επιστρέφει σφάλμα εργαλείου αντ' αυτού.
| Δικαίωμα | Περιγραφή |
|---|---|
| DEVICES_READ | Προβολή λίστας και ανάγνωση συσκευών, σύνοψης στόλου και ιστορικού εντολών. Απαιτείται από τα τελικά σημεία GET /assets, το BI API και τα εργαλεία ανάγνωσης συσκευών MCP. Το GET /device-user-logins απαιτεί το DEVICES_READ, όπως και οι υπόλοιπες αναγνώσεις συσκευών. |
| POLICIES_READ | Προβολή λίστας και ανάγνωση πολιτικών. Απαιτείται από τα GET /policies, GET /policies/POLICY_ID και τα εργαλεία πολιτικής MCP. |
| DEVICES_COMMAND | Αποστολή εντολής σε μία συσκευή: lock, lost mode, message, αναφορά κατάστασης, ενημέρωση τοποθεσίας, συγχρονισμός πολιτικής, επανεκκίνηση, απενεργοποίηση, εκκίνηση εφαρμογής, εκκαθάριση δεδομένων εφαρμογής και αλλαγή πολιτικής (η οποία απαιτεί επίσης POLICIES_READ). Προαιρετική επιλογή (opt-in), που δεν υπονοείται ποτέ από άλλο δικαίωμα. Πρέπει να συνδυάζεται με το DEVICES_READ. Απαιτείται από τα τυπικά τελικά σημεία εντολών POST και τα εργαλεία εντολών MCP. Η αναφορά συνδέσεων και αποσυνδέσεων Device User (POST /device-user-logins και POST /device-user-logins/logout) απαιτεί το DEVICES_COMMAND, το δικαίωμα που στέλνει εντολές σε συσκευές· ένα κλειδί το αποκτά μόνο μαζί με το DEVICES_READ. Οι συνεδρίες Device User δεν έχουν δικό τους δικαίωμα. API συνεδριών Device User |
| DEVICES_COMMAND_DESTRUCTIVE | Εκτέλεση καταστροφικών εντολών σε μία συσκευή: πλήρης διαγραφή, επαναφορά ή αλλαγή του κλειδώματος οθόνης, παραχώρηση ιδιοκτησίας και απεγκατάσταση εφαρμογών. Εκτελούνται αμέσως, χωρίς στάδιο έγκρισης στην πύλη. Προαιρετική δυνατότητα (opt-in), ξεχωριστή από το DEVICES_COMMAND, και πρέπει να συνδυάζεται με το DEVICES_READ. Η εταιρεία πρέπει επίσης να ενεργοποιήσει τις καταστροφικές εντολές στην ενότητα πρόσβασης πράκτορα AI στην πύλη. Απαιτείται από τα τελικά σημεία καταστροφικών εντολών και τα εργαλεία καταστροφικών εντολών MCP. |
| PROVISIONING | Δημιουργήστε κωδικούς QR προετοιμασίας (provisioning) για τις πολιτικές της εταιρείας. Κάθε κωδικός QR φέρει ένα νέο διακριτικό εγγραφής (enrollment token) που λήγει μετά από 24 ώρες. Προαιρετική ενεργοποίηση (opt-in), και πρέπει να συνδυάζεται με το POLICIES_READ. Μόνο ένας χρήστης της πύλης που επιτρέπεται να προετοιμάζει συσκευές και έχει πρόσβαση σε όλες τις πολιτικές μπορεί να δημιουργήσει ένα κλειδί με αυτό. Απαιτείται από το POST /policies/POLICY_ID/provisioning-qr-codes και το εργαλείο MCP create_provisioning_qr_code. API κωδικών QR προετοιμασίας (provisioning) |
| EXPORT_READ | Παλαιού τύπου άδεια. Κανένα τελικό σημείο ή εργαλείο δεν την ελέγχει και δεν είναι πλέον δυνατή η δημιουργία νέων κλειδιών με αυτήν. |
| POLICIES_WRITE | Ένα κλειδί API με το δικαίωμα POLICIES_WRITE (Αλλαγές πολιτικής), σε συνδυασμό με το POLICIES_READ. Μόνο ένας χρήστης της πύλης με δικαίωμα επεξεργασίας πολιτικών μπορεί να δημιουργήσει ένα κλειδί με POLICIES_WRITE. Απαιτείται από τα τελικά σημεία POST και τα εργαλεία αλλαγής πολιτικής MCP. API αλλαγών πολιτικής |
| LIBRARY_MANAGE | Το LIBRARY_MANAGE είναι ευαίσθητη άδεια σε επίπεδο εταιρείας για μεταφορτώσεις APK και διαχείριση εφαρμογών. Δεν παρέχει ανάθεση πολιτικών, εντολές συσκευών, παροχή (provisioning) ούτε λειτουργίες λογαριασμού. API μεταφορτώσεων APK · API εφαρμογών βιβλιοθήκης |
Πού να στείλετε το κλειδί
Το REST API δέχεται το κλειδί μόνο στην κεφαλίδα X-API-Key. Το τελικό σημείο MCP δέχεται είτε X-API-Key είτε Authorization: Bearer ακολουθούμενο από το κλειδί.
Όρια ρυθμού και κεφαλίδες
Τα τελικά σημεία ανάγνωσης REST δεν εφαρμόζουν όριο ανά κλειδί στην εφαρμογή Nomid, αλλά δομήστε το πρόγραμμα-πελάτη σας ώστε να υποχωρεί σε σφάλματα 429 έτσι κι αλλιώς. Το τελικό σημείο MCP επιτρέπει 60 αιτήματα ανά λεπτό ανά κλειδί. Οι εντολές συσκευών, οι αλλαγές πολιτικής (κάθε κλήση propose και apply) και οι κωδικοί QR προετοιμασίας μοιράζονται ένα όριο εγγραφής 10 αιτημάτων ανά λεπτό ανά κλειδί, συνδυαστικά σε REST και MCP. Μια σύνδεση Sign in with Nomid έχει τα ίδια όρια MCP και εγγραφής, τα οποία υπολογίζονται ανά σύνδεση.
Μια απόκριση HTTP 429 περιλαμβάνει μια κεφαλίδα Retry-After με τα δευτερόλεπτα αναμονής. Όταν μια εντολή MCP, μια αλλαγή πολιτικής ή μια κλήση εργαλείου προετοιμασίας υπερβαίνει το όριο εγγραφής, το κείμενο σφάλματος του εργαλείου παρέχει τα δευτερόλεπτα αντ' αυτού. Το API δεν ορίζει κεφαλίδες X-RateLimit-Limit, X-RateLimit-Remaining ή X-RateLimit-Reset.
Βέλτιστες πρακτικές ασφαλείας
- Μην εκθέτετε ποτέ κλειδιά API σε κώδικα από την πλευρά του πελάτη ή σε δημόσια αποθετήρια
- Περιστρέψτε τα κλειδιά τακτικά και ανακαλέστε τα αχρησιμοποίητα κλειδιά
- Αποθηκεύστε τα κλειδιά σε μεταβλητές περιβάλλοντος, όχι σε κώδικα
- Χρησιμοποιήστε τις ελάχιστες απαραίτητες άδειες για την ενσωμάτωσή σας
Σφάλματα Επαλήθευσης
Το API επιστρέφει συγκεκριμένους κωδικούς σφάλματος για ζητήματα επαλήθευσης:
| Κωδικός Κατάστασης | Περιγραφή |
|---|---|
| 401 | Λείπει ή είναι άκυρο κλειδί API |
| 403 | Το κλειδί API δεν έχει τις απαιτούμενες άδειες |
| 429 | Υπέρβαση ορίου ρυθμού |