Aplikacja klawisze API

Klucze API umożliwiają integrację z klientem zewnętrznym opartą na komunikacji przychodzącej między komputerami. Klucze interfejsu API mogą być używane przez interfejsy API usług OSLC i REST, a także mogą być używane jako część struktury integracji Zarządzanie .

W przypadku integracji z maszyną maszyna zewnętrzna współdziała z danymi Manage w systemie Manage bez użycia przeglądarki. Klucze API są rodzimą formą uwierzytelniania, która nie wymaga zewnętrznego repozytorium do przechowywania haseł.

Domyślnie wszystkie klucze API są przechowywane w postaci zaszyfrowanej. Tym ustawieniem steruje właściwość mxe.secureapikey.

Dodawanie kluczy API dla interfejsów API REST

Gdy klucz API jest przypisany do klienta zewnętrznego, klient zewnętrzny może uzyskiwać dostęp do danych w systemie Zarządzanie i wchodzić w interakcje z nimi, korzystając z klucza API jako parametru zapytania apikey lub nagłówka żądania apikey w wywołaniach interfejsu API REST. Wywołania API REST korzystające z klucza API nie tworzą trwałego połączenia z serwerem, a klucz API musi być zawarty we wszystkich żądaniach API REST wysyłanych przez klienta zewnętrznego.

Aby użyć klucza interfejsu API, wybierz z menu opcję Integracja > Aplikacja Klawisze API .

Korzystanie z kluczy interfejsu API utworzonych zewnętrznie

Za pomocą kluczy interfejsu API utworzonych zewnętrznie można użyć jako klucza interfejsu API w produkcie Maximo® Manage.Utwórz ten typ klucza API, używając interfejsu API REST produktu MXAPIAPIKEY i udostępniając wygenerowany klucz API za pomocą właściwości json "apikey", jak to pokazano w następującym kodzie:

POST /oslc/os/mxapiapikey
{
 "apikey":"<outside generated apikey>",
 "expiration":-1
}

Uprawnienia dostępu

Administrator systemu musi zsynchronizować użytkowników Manage dla zewnętrznych klientów przed utworzeniem kluczy interfejsu API dla tych klientów. Uprawnienia powiązane z kluczem API zależą od uprawnień powiązanego użytkownika. Klucze interfejsu API można tworzyć i konfigurować z poziomu aplikacji Klucze interfejsu API w obszarze Integracja.

Można również określić uprawnienia, które umożliwią tylko zalogowanym użytkownikom tworzenie kluczy API. Aby umożliwić tworzenie kluczy API wyłącznie zalogowanemu użytkownikowi, przejdź do aplikacji Właściwości systemu i poprzez filtrowanie odszukaj właściwość mxe.apikeyforloggedinuser. W polu Wartość globalna podaj wartość 1 i zapisz rekord. Wybierz opcję Odświeżanie na żywo, aby wartość od razu zaczęła obowiązywać.

Aby wyłączyć dostęp do systemu Manage dla klienta zewnętrznego, można usunąć powiązany z nim klucz API, ale klient zewnętrzny może nadal uzyskiwać dostęp do systemu Zarządzanie przy użyciu innego skonfigurowanego systemu uwierzytelniania. Jeśli klucz API zostanie ujawniony osobom potencjalnie niepowołanym, usuń klucz i utwórz nowy klucz dla tego samego użytkownika.