Onboarding : CanAm API Setup Configuration

This guide outlines the steps required to configure the CanAm API for integration with MAX OPs.

Written By Danielle Segovia (Collaborator)

Updated at December 9th, 2025

Table of Contents

Configuring the API Step 1: Email Whitelisting Step 2: Request API Credentials from CanAm Step 3: Enter Credentials in MAX OPs Configuration Example in MAX OPS Shutting down / Disabling the CanAm API when a customer does not use it any longer or churns

This KBA documents the steps to follow to enable and configure the CanAm API for your customer.

Configuring the API

Step 1: Email Whitelisting

Contact vMOX IT team to **whitelist the customer support email address** used for API credential setup.
Format: `accountsupport+uri@vmox.com`
The `+uri` suffix should reflect the customer-specific identifier.

Step 2: Request API Credentials from CanAm

Reach out to CanAm using the whitelisted email address.
Request **customer-specific API credentials**, including:

Username
Password
API Key
API Secret

Step 3: Enter Credentials in MAX OPs

Navigate to the MAX Ops Configuration section.
Input the following details provided by CanAm:

Username
Password
API Key
API Secret

Save and validate the configuration to ensure successful integration.

Configuration Example in MAX OPS

Shutting down / Disabling the CanAm API when a customer does not use it any longer or churns

Navigate to Customer in Max-Ops
Go to Integration section
In the CanAm API Integration section, remove all values and replace them with a 1

Click SAVE
This will disable the integration