APIs

You can use several APIs to configure Maximo® Monitor and the IoT tool, for example, to create and delete devices and to diagnose device connection issues.

Maximo Monitor

To access the Maximo Monitor API documentation, in Maximo Monitor, click the Help (?) icon and then click API. You can use v2 APIs for device types that were created in Maximo Monitor 8.8 or later.

To run the API calls directly from the documentation, complete the following steps:

  1. Generate the Maximo Monitor API key and token. For Maximo Application Suite Dedicated, contact your administrator. Otherwise, complete the following steps:

    In Maximo Monitor 8.10 and 8.11, you can run the Maximo Monitor APIs by using the IoT tool API key or the Maximo Monitor API key. By using the IoT tool API keys, you can create multiple API keys, such as one per user.

    Maximo Application Suite Customer-managed
    1. In Red Hat® OpenShift®, select Project.
    2. Select the Red Hat OpenShift project, for example, mas-dev-monitor.
    3. Click Workload and then click Secrets.
    4. Open the monitor-api secret file.
    5. Copy the value for as_apikey and as_apitoken
  2. In the API documentation, for an API, click Try it out.

In all POST, PUT, or DELETE calls, use the tenantid and mam_user_email headers. For the mam_user_email header, use the email address that is associated with your user profile. If you do not use the headers, a 403 Forbidden unauthorized error occurs.

In all GET calls, use the tenantid header and, optionally, the mam_user_email header. If you do not use the tenantid header, a 403 Forbidden unauthorized error occurs.

When you access the APIs from an API application, such as Postman, you must use the host URL in your API call. In Maximo Application Suite Dedicated, the host URL for Maximo Monitor API endpoints is provided in your welcome letter. In a customer-managed environment, the host URL is https://workspaceId.api.monitor.domain.com. During product installation, your application suite administrators sets the workspaceId, which is also known as the tenant ID.

The IoT tool

To access the IoT tool API documentation, in the IoT tool, click the Help (?) icon and then click API. Click View APIs to open the API documentation.

To run the API calls directly from the documentation, complete the following steps:

  1. Generate the IoT API key and token. You can generate multiple API keys, such as one per user.
    1. In the IoT tool, from the main menu, click Apps.
    2. Click Generate API Key.
    3. Specify a description and expiration and click Next.
    4. Select either the Device Application role or Standard Application role.
    5. Click Generate Key. Record the API key and token. Authentication tokens are not recoverable. To generate a new token, you need to register the API key again.
  2. Authorize the APIs.
    1. From the API documentation, click Authorize.
    2. In the Available authorizations dialog, specify the following information:
      1. In the Username field, specify the API key that you generated.
      2. In the Password field, specify the token that you generated.
    3. Click Authorize.
    4. Close the Available authorizations dialog. Do not click Logout.
  3. In the API documentation, for an API, click Try it out.

Your organization ID must be included in the hostname for all HTTP API calls.

IoT tool APIs include messaging APIs that you can use to send events from devices and application APIs that you can use to manage tasks, such as device management, action management, and risk management. For more information, see Messaging APIs and Application APIs.

Maximo Application Suite Customer-managed

IBM Db2® Warehouse

For more information, see Available APIs.