API-nycklar
Du använder API-nycklar för att aktivera en maskin-till-maskin-integration för en extern klient. API-nycklar kan användas av REST APIer och kan också användas som en del av Maximo-integrationsramverk.
I en maskin-till-maskin-integration interagerar en extern dator med Maximo-data i Maximo-systemet utan användning av en webbläsare. API-nycklar är en intern form av autentisering som inte kräver ett externt lager för lösenordslagring. Alla API-nycklar är krypterade vid lagring.
API-nycklar för REST APIer
När en API-nyckel tilldelas till den externa klienten, kan klienten komma åt och interagera med data i Maximo-systemet genom att använda API-nyckeln som frågeparametern apikey eller begäranhuvudet apikey i REST API-anrop. REST API-anrop som använder en API-nyckel skapar inte en beständig serveranslutning och API-nyckeln måste ingå i alla REST API-begäran som den externa klienten gör.
Om du vill ha mer information om användningen av en API-nyckel går du till underfliken API-nycklar och väljer API-dokumentation från menyn Åtgärd. Välj Godkänn för att använda din API-nyckel.
API-nycklar som skapas i externa system
Du kan använda ett externt system för att skapa API-nyckeln och tillhandahålla API-nyckelvärdet till integrationsramverket. Skapa den här typen av API-nyckel genom att använda Mxperuser REST API. Mer information finns i REST API-dokumentationen för att skapa användare.
Åtkomstbehörighet
Som systemadministratör måste du skapa Maximo-användare för de externa klienterna innan API-nycklar skapas för dessa klienter. Behörigheterna som är associerade med API-nyckeln bestäms av behörigheterna för den associerade användaren. Du kan skapa och konfigurera API-nycklar på underfliken API-nycklar på fliken Integration i arbetscentret Administration.
Du kan även ange behörighet som gör att endast den inloggade användaren kan skapa en API-nyckel. Om du vill begränsa skapandet av API-nycklar till den inloggade användaren, går du till applikationen Systemegenskaper och filtrerar för egenskapen mxe.apikeyforloggedinuser. I fältet Generellt värde anger du 1 och sparar posten. Välj Uppdatering i realtid om du vill tillämpa värdet omedelbart.
Om du vill avaktivera åtkomsten till Maximo-systemet för en extern klient, kan du ta bort tillhörande API-nyckel, men den externa klienten kan fortfarande komma åt Maximo-systemet genom att använda ett annat konfigurerat autentiseringssystem. Om en API-nyckel har äventyrats, tar du bort nyckeln och skapar en annan nyckel för den användaren.