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:
- 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.
- In Red Hat® OpenShift®, select Project.
- Select the Red Hat OpenShift project, for example,
mas-dev-monitor
. - Click Workload and then click Secrets.
- Open the
monitor-api
secret file. - Copy the value for
as_apikey
andas_apitoken
- 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:
- Generate the IoT API key and token. You can generate multiple API
keys, such as one per user.
- In the IoT tool, from the main menu, click Apps.
- Click Generate API Key.
- Specify a description and expiration and click Next.
- Select either the Device Application role or Standard Application role.
- 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.
- Authorize the APIs.
- From the API documentation, click Authorize.
- In the Available authorizations dialog, specify the following information:
- In the Username field, specify the API key that you generated.
- In the Password field, specify the token that you generated.
- Click Authorize.
- Close the Available authorizations dialog. Do not click Logout.
- 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.
IBM Db2® Warehouse
For more information, see Available APIs.