Documentation Index
Fetch the complete documentation index at: https://docs.serval.com/llms.txt
Use this file to discover all available pages before exploring further.
About IVM
IVM provides industrial vending machines, IT asset vending, and smart locker solutions for automated supply distribution. IVM’s management platform, SmartHub, gives operators real-time visibility into machines, inventory, locations, users, and products. Connecting IVM to Serval lets you query machine status, pull inventory and usage data, and build automation workflows on top of your vending operations.What the IVM integration enables
| Capability | Description |
|---|---|
| Machine management | List and look up vending machines, including connectivity status, health metrics, and configuration |
| Inventory and reporting | Access inventory levels, vend history, usage reports, and item summaries |
| Location and user tracking | View locations where machines are deployed and manage machine users |
| Product catalog | Browse products, categories, planograms, and product assignments |
| Automation workflows | Build workflows to monitor inventory, track machine health, and streamline operations |
IVM configuration
Prerequisites
| Requirement | Details |
|---|---|
| IVM SmartHub account | An active IVM account with API access enabled |
| API URL | Your IVM API endpoint (e.g. https://ivmapi.com) |
| Identity Server URL | Your IVM SmartHub identity server endpoint (e.g. https://smarthubidentity.ivminc.com) |
| Credentials | A username and password authorized for IVM API access |
Note: Contact your IVM account administrator if you do not have API credentials. The credentials must have sufficient permissions to authenticate via the SmartHub identity server and access the API endpoints your workflows require. These are separate from any SSO credentials you may use to sign into the SmartHub portal.
Serval configuration
Enter your connection details
Fill in the following fields:
| Field | Description |
|---|---|
| API URL | Your IVM API endpoint (e.g. https://ivmapi.com). Must be HTTPS. |
| Identity Server URL | Your IVM SmartHub identity server endpoint (e.g. https://smarthubidentity.ivminc.com). Must be HTTPS. |
| Username | Your IVM API username |
| Password | Your IVM API password |
Bundled workflows
Once connected, the following workflows are available under the Inventory Management bundle:| Workflow | Description |
|---|---|
| List IVM Machines | Retrieves a paginated list of vending machines, including machine names, access numbers, and connectivity status |
| Get IVM Machine by ID | Retrieves detailed information about a specific machine by its ID, including location, status, and product configuration |
| List IVM Locations | Retrieves a paginated list of locations where vending machines are deployed |
| List IVM Products | Retrieves a paginated list of products managed in IVM, including product names, types, and categories |
Troubleshooting
Connection fails with authentication error
Connection fails with authentication error
Verify that your Identity Server URL is correct and that your username and password are valid. IVM uses the SmartHub identity server to issue API tokens — if the identity server URL is wrong or your credentials are invalid, the connection will fail. Note that SSO credentials (e.g. Microsoft Entra ID) used for portal login are not the same as API credentials.
API requests return 401 or 403
API requests return 401 or 403
Your credentials may not have sufficient permissions to access the requested endpoints. Contact your IVM administrator to confirm your account has API access enabled.
Connection fails with URL error
Connection fails with URL error
Both the API URL and Identity Server URL must use HTTPS. Double-check that the URLs are correctly formatted and reachable from your network.
Need help? Contact support@serval.com