Uwierzytelnianie
Nomid MDM API wykorzystuje klucze API do uwierzytelniania żądań. Ten przewodnik wyjaśnia, jak uzyskać i używać swojego klucza API.
Przegląd
Klucze API służą do uwierzytelniania wszystkich żądań do Nomid MDM API. Dołącz swój klucz API w nagłówku X-API-Key do każdego żądania.
X-API-Key: nm_acme_a1b2c3d4e5f6g7h8i9j0...Uzyskiwanie klucza API
Klucze API są tworzone i zarządzane za pośrednictwem Portalu Nomid. Wykonaj poniższe kroki, aby utworzyć swój pierwszy klucz API.
Wymagania wstępne
- Konto Nomid MDM z dostępem administratora
- Dostęp do Ustawień Firmy w Portalu Nomid
Zaloguj się do Portalu Nomid
Otwórz przeglądarkę i przejdź do Portalu Nomid. Zaloguj się przy użyciu swoich danych administratora.
portal.nomid.techPrzejdź do Integracji
Po zalogowaniu przejdź do sekcji Ustawienia Firmy i wybierz zakładkę Integracje.
Kliknij Utwórz klucz API
Kliknij przycisk "Utwórz klucz API" znajdujący się w prawym górnym rogu strony Integracje.
Wprowadź nazwę
W wyświetlonym oknie dialogowym wprowadź opisową nazwę dla swojego klucza API. Pomoże Ci to zidentyfikować klucz później (np. „Integracja Power BI” lub „Synchronizacja CRM”).
Skopiuj swój klucz
Po kliknięciu „Utwórz” Twój klucz API zostanie wyświetlony. Kliknij przycisk kopiowania, aby skopiować go do schowka. Klucz zostanie pokazany tylko raz!
Ważne: Zapisz swój klucz
Twój klucz API zostanie wyświetlony tylko raz w momencie jego utworzenia. Skopiuj go natychmiast i przechowuj bezpiecznie (np. w menedżerze haseł lub zmiennej środowiskowej). Jeśli zgubisz klucz, będziesz musiał utworzyć nowy.
Format klucza API
Klucze API mają następujący format:
nm_- Wszystkie klucze zaczynają się od „nm_”{company}- Prefiks specyficzny dla firmy w celu identyfikacji{random}- 32 losowe znaki dla bezpieczeństwa
Używanie Twojego klucza API
Dołącz klucz API w nagłówku X-API-Key przy każdym żądaniu:
curl -X GET "https://api.nomid.tech/emm/api/v1/assets" \
-H "X-API-Key: nm_acme_a1b2c3d4e5f6..."Uprawnienia
Klucze API można skonfigurować z określonymi uprawnieniami:
| Permission | Description |
|---|---|
| DEVICES_READ | Odczytaj informacje o urządzeniu |
| POLICIES_READ | Odczytaj informacje o zasadach |
| EXPORT_READ | Eksportuj dane |
Najlepsze praktyki w zakresie bezpieczeństwa
Nigdy nie ujawniaj kluczy API w kodzie po stronie klienta ani w publicznych repozytoriach
Regularnie rotuj klucze i unieważniaj nieużywane klucze
Przechowuj klucze w zmiennych środowiskowych, nie w kodzie
Użyj minimalnych uprawnień niezbędnych do twojej integracji
Unieważnianie kluczy API
Jeśli podejrzewasz, że Twój klucz API został naruszony lub nie jest już potrzebny, możesz go natychmiast unieważnić na stronie Ustawienia Firmy > Integracje w Portalu Nomid. Unieważnionych kluczy nie można przywrócić.