Generate API Key

Prerequisites

Before starting this exercise, ensure you have:

  • Access to Maximo Monitor

Steps

  1. Open Maximo Application Suite and select Monitor Application.
  2. Expand Setup under Monitor and Select API Keys (Monitor) Navigate to API Keys
  3. Click the Generate API Key button
  4. Provide a meaningful name for your API key (e.g., "Monitor Integration Key")
  5. Click Generate key Navigate to API Keys
  6. Download the generated API key and store it securely (e.g., in a password manager or secure vault) Navigate to API Keys
  7. Follow create a DeviceType (Steps to create DeviceType) and devices (Steps to create Device)
  8. Use API Key and Token for device authentication.
  9. Add metric and event on device type (Steps to add metric)

  10. Test Your API Key

    You can test your API key using a simple curl command:
curl -X 'POST' \
  'https://`<messagingURL>`/api/v0002/application/types/`<deviceType>`/devices/`<deviceId>`/events/`<eventName>`' \
  -H 'accept: application/json' \
  -H 'authorization: Basic `YOUR_API_KEY`' \
  -H 'Content-Type: application/json' \
  -d '{`"matricName"`:"12"}'

Replace YOUR_API_KEY with the actual key you created. 11. Once you send data, data should be shown in device recent event and data table. Device Recent Navigate to API Keys Device Data Table Navigate to API Keys

Important

Make a note of the generated authentication token. Lost authentication tokens cannot be recovered. If you lose the token, you must reregister the API to generate a new token.

Next Steps

Now that you have created an API key, you can:

  • Use it to authenticate API requests of Device
  • Integrate with your monitoring systems

Tip

Remember to rotate your API keys regularly as a security best practice.