IBM Maximo API Key Setup
BonData connects to Maximo through its REST/OSLC API usingmaxauth (API key) authentication. OAuth is also supported for environments that require it.
Step 1: Confirm Your Maximo Base URL
- Log in to Maximo as an administrator
- Your base URL is the host that serves the Maximo application, for example
https://maximo.yourcompany.com/maximoorhttps://<host>/maximo/oslcfor Maximo Application Suite - Note this URL - BonData appends the REST/OSLC object paths (for example
/os/mxapiasset) to it
Step 2: Enable API Access and Create an API Key
- Go to the Administration work center, or open the Users application
- Ensure the integration user has a security group that grants access to the object structures (OS) you plan to use
- In Maximo Application Suite, open the API Keys management page (or use the
apikeyendpoint) and generate a new API key for the integration user - Copy the generated API key - it is used as the
apikeyheader on every request
For classic Maximo (7.6.x) without API key management, BonData can authenticate using the
maxauth header, which is a Base64-encoded username:password credential. Use a dedicated service account for this.Step 3: Grant Object Structure Access
- Open the Object Structures application
- Confirm the object structures you need are exposed as REST resources (for example
MXAPIASSET,MXAPIWODETAIL,MXAPIITEM) - Make sure the integration user’s security group has read access to each
Step 4: Enter Credentials in BonData
- In BonData, navigate to Integrations and select IBM Maximo
- Enter your Base URL and API Key
- Click Connect
Required Fields
Available Data
Once connected, BonData can sync the following Maximo records:- Assets - Asset master records with hierarchy, status, and location
- Work Orders - Corrective and planned work orders with labor, materials, and status
- Locations - Location hierarchy and operating context for assets
- Items / Inventory - Item master records and storeroom inventory balances
- Purchase Orders - Purchase orders and receipts for materials and services
- Service Requests - Incoming service requests and tickets
- Preventive Maintenance - PM schedules, frequencies, and generated work