Application API
Use the following API endpoint URLs to access the IoT
tool APIs. The API endpoint URL consists of a host URL and a base URL. The base URL for each REST
API is listed with the API docs, and is typically api/v0002/. Several APIs are
available for developing code for devices, gateways, and applications that connect to the IoT tool.
API authentication
The HTTP Application API is protected by HTTP basic authentication. Use the API key generated by the IoT tool.
Example: a-abc123-kodl0vqqrk, where abc123 is the
{orgId} value. The token generated by the IoT tool.
The {orgId} value is your IoT tool organization 6-character organization ID. The
{orgId} value must included in the host name for any HTTP API
call. If you are using Maximo® Application Suite Dedicated, your organization ID is
provided in your Welcome letter. If you are in a customer-managed environment, your organization ID
is your workspace ID. Your application suite administrator configures the workspace ID during the
installation process.
For more information about API keys and tokens for applications, see Using applications. You can look up the default API key and token in the IoT tool.
HTTP API URL
The host URL is as follows:
https://{orgId}.iot.masdomain.com/{base_URL}
Curl example
The following example is an example of an API call to list the devices in your organization:
curl -X GET
"https://{orgId}.iot.masdomain.com/api/v0002/bulk/devices?_limit=25" -u
'{username}:{password}'