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_a1b2c3d4e5f6...

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
  1. 1

    Zaloguj się do Portalu Nomid

    Otwórz przeglądarkę i przejdź do Portalu Nomid. Zaloguj się przy użyciu swoich danych administratora.

  2. 2

    Przejdź do Integracji

    Po zalogowaniu przejdź do sekcji Ustawienia Firmy i wybierz zakładkę Integracje.

  3. 3

    Kliknij Utwórz klucz API

    Kliknij przycisk "Utwórz klucz API" znajdujący się w prawym górnym rogu strony Integracje.

  4. 4

    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”).

  5. 5

    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!

Format klucza API

Klucze API mają następujący format:

nm_{company}_{random_32_chars}
  • Wszystkie klucze zaczynają się od „nm_”
  • Prefiks specyficzny dla firmy w celu identyfikacji
  • 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..."

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

Błędy uwierzytelniania

API zwraca specyficzne kody błędów dotyczące problemów z uwierzytelnianiem:

Kod statusuOpis
401Brakujący lub nieprawidłowy klucz API
403Klucz API nie ma wymaganych uprawnień
429Przekroczono limit żądań

Wybierz swój czas

Ładowanie...