Przeskocz do zawartości głównej

Zarządzanie kluczami API

NA TEJ STRONIE

Zarządzanie kluczami API

Klucz interfejsu API jest unikatowym identyfikatorem służącym do uwierzytelniania użytkownika, programisty lub programu wywołującego w interfejsie API. Klucze interfejsu API są często używane do śledzenia i kontrolowania sposobu używania interfejsu API, aby zapobiec jego nadużyciom.

Przegląd kluczy API

Klucze interfejsu API są domyślnie wyłączone w funkcji Management Console. Aby włączyć klucze interfejsu API, przejdź do sekcji Ustawienia. Administrator dzierżawy może odwołać klucze interfejsu API i edytować ustawienia kluczy interfejsu API, ale do generowania i usuwania kluczy interfejsu API wymagana jest rola programisty. Rolę programisty przypisuje użytkownikom administrator dzierżawy. Jeżeli jesteś administratorem dzierżawy, możesz przypisać rolę programisty sobie.

Tabela kluczy interfejsu API zawiera następujące informacje o kluczach interfejsu API: nazwa, identyfikator, właściciel, ostatnia aktualizacja, data utworzenia, data wygaśnięcia i status. Użyj pola wyszukiwania, aby wyszukać w pierwszych trzech polach: Nazwa klucza Identyfikator klucza i Właściciel.

Statusy kluczy interfejsu API

Klucze interfejsu API mogą mieć następujące statusy:

  • Aktywny: klucz interfejsu API jest w użyciu.
  • Wygasły: data wygaśnięcia minęła.
  • Odwołany: klucz interfejsu API został odwołany i nie można go już używać.

Jako administrator możesz przejrzeć działania z kluczami interfejsu API zarejestrowane w sekcji Zdarzenia w funkcji Management Console. W przypadku wykrycia podejrzanych działań, takich jak intensywne korzystanie z niektórych kluczy interfejsu API, możesz odwołać dany klucz interfejsu API. Otwórz szczegółową listę, klikając strzałkę po prawej stronie tabeli i skopiuj identyfikator klucza interfejsu API. Następnie możesz wyszukać identyfikator w sekcji Klucze API, aby znaleźć klucz interfejsu API do odwołania.

Aby odwołać pojedynczy klucz interfejsu API, kliknij przycisk ... po prawej stronie i wybierz polecenie Odwołaj. Odwoływać można klucze tylko ze statusem Aktywny. Aby odwołać wiele kluczy, zaznacz pola wyboru po lewej stronie kluczy do odwołania i kliknij polecenie Odwołaj w prawym górnym rogu. Odwołanie jest nieodwracalne, a odwołanego klucza interfejsu API nie można ponownie aktywować.

Oprócz odwołania istnieje również opcja usuwania. Klucz interfejsu API można usunąć z huba, ale nie w funkcji Management Console.

Włączanie kluczy API w dzierżawie

Ustawienie Włącz klucze API włącza się w funkcji Management Console na stronie Ustawienia. Klucze interfejsu API są domyślnie wyłączone w funkcji Management Console.

Properties for API keys
Property Description
Enable API keys

This switch enables or disables all the API keys in the tenant. Only the tenant admin can enable the API keys.
Change maximum token expiration

By changing the token expiration value, all new tokens will have the new expiration value. Already existing APIs will not be affected by the change, they will have the same expiration value as before.
Change maximum of API keys per user

This setting only affects new API keys. If a new API key makes the total number exceed the maximum number, creation is denied.

Wykonaj następujące czynności:

  1. W funkcji Management Console przejdź do strony Ustawienia.
  2. W sekcji Klucze API włącz przycisk Włącz klucze API.
  3. W razie potrzeby zmień ustawienia Zmień maksymalny termin wygaśnięcia tokenu i Zmień maksymalną liczbę kluczy interfejsu API na użytkownika.

Generowanie klucza interfejsu API z huba

Klucze interfejsu API można generować z huba. Najpierw sprawdź, czy są spełnione następujące dwa wymagania:

  • Ustawienie Włącz klucze API włącza się w funkcji Management Console.
  • Administrator dzierżawy przypisał Ci rolę programisty.

Wykonaj następujące czynności:

  1. Zaloguj się do dzierżawy, na przykład pod adresem https://<tenantname>.com.

  2. Kliknij swój profil w prawym górnym rogu i wybierz pozycję Ustawienia.

  3. Wybierz pozycję Klucze API.

  4. Kliknij pozycję Wygeneruj nowy klucz API.

  5. Wprowadź opis klucza interfejsu API i wybierz, kiedy klucz API ma wygasnąć.

  6. Kliknij przycisk Generuj.

    Zostanie wygenerowany klucz interfejsu API.

  7. Skopiuj klucz interfejsu API i zachowaj go w bezpiecznym miejscu.

Po utworzeniu możesz edytować nazwę klucza interfejsu API. Możesz go również usunąć.