Please note that the old SOAP API version (Orbcomm - Cargowatch) is no longer supported. Only the new RESTful API integration (Orbcomm - Platform) is available.
ℹ️ As of February 25, 2025, we've introduced two key updates to ELD integrations. First, we now validate credentials before saving, so you’ll instantly know if they’re incorrect, eliminating confusion. Second, the integration card UI has been revamped for clearer status indicators and a more streamlined deactivation process. These improvements aim to make managing integrations faster and more straightforward.
Part 1: Request Orbcomm Platform Integration Credentials
Reach out to your Orbcomm Customer Success Manager: Request them to submit an API Integration request on your behalf. Ensure you provide all necessary information to facilitate this process.
Coordinate with Orbcomm: The Orbcomm Customer Success Manager will work with you to gather the required details and submit the integration request through their ticketing system.
Receive your credentials: Once Orbcomm completes the setup, they will provide you with the following credentials:
Username
Password
Org Key
Part 2: Enter Credentials in Alvys
Navigate to the Integrations Section
Set Up the Integration:
Expand the ELD section within the integrations list.
Locate the Orbcomm - Platform integration box and click the crayon icon to configure it.
Enter Credentials:
In the pop-up dialog box, input the Orbcomm Platform Username, Password, and Org Key.
Click the Save button to complete the integration setup.
Part 3: Assign Orbcomm Integration to Assets
Navigate to the Assets Page and choose the desired one
Add Orbcomm Integration:
Scroll to the ELD Integrations section and click the blue Add Integration button.
In the Add Integration window, select OrbcommPlatform from the dropdown menu.
Enter Asset Information:
Input the Orbcomm Asset ID in the Integration ID field.
Click Save to link the asset to the integration.
