- edited by
kewilson
Please note the important upcoming changes to the ChannelOnline XML API, effective September 1, 2026. Please review the details below and take the required actions before the go‑live date. Failure to do so may result in a disruption to your integrated services.
What’s Changing
As part of our ongoing commitment to security, performance, and reliability, the following requirements will be enforced beginning September 1, 2026:
Endpoint Update
Please update all XML requests from xml.channelonline.com to integration.channelonline.com.
All integrations must point to the new endpoint before the September 1, 2026, go‑live date.
Registered User Agents Only
Only approved and registered user agents will be permitted to make API requests. The user agent is now required to be in both the XML and the HTTP header. Requests from unrecognized or unregistered user agents will be blocked.
Authentication
API calls will no longer support the use of the <password> element within the authentication section. This element has been replaced with the <apiKey> element. lease note that both the element and key are case sensitive.
API keys are automatically generated for your company’s exclusive use and are available in the XML Settings section of ChannelOnline: Admin > Import / Export > XML Settings. You may need the access right enabled on your user account to retrieve it. These API keys are available now. If you need to update or regenerate your API key after the initial issuance, please return to the settings page and click the Refresh button.
See the updated authentication example below:
<authentication>
<shortcut>shortcut</shortcut>
<email>[email protected]</email>
<apiKey>XxXxXxXxXxXxXxXxXxXx</apiKey>
<userAgent>xxx</userAgent>
</authentication>
XML Version Support
XML versions earlier than 8.0 will no longer be supported. Please ensure your integration is running version 8.0 or higher. This upgrade improves performance and provides access to additional data elements. The latest XML version can be found here: https://xml.channelonline.com/schema/8.7/schema.zip
Geolocation Restrictions
API calls will be subject to geolocation enforcement. Requests originating from restricted regions will not be processed. Please refer to countries restricted by the U.S. State Department for guidance.
Testing Your Integration
We strongly encourage validating your integration ahead of the go‑live date.
Before you start, make sure you have the access right enabled on your user account to retrieve it. To verify, go to:
Admin > Personnel > Access Rights and view/edit the access right profile assigned to you.
If needed, have the check the box for “Integrations (XML, Quickbooks, ConnectWise, Autotask, Salesforce)” enabled and select Save & Exit in the footer.
Test by using: https://integration.channelonline.com.
This environment reflects the updated requirements and should be used to confirm expected behavior.
For testing purposes, you can use this login echo request with both the <password> and the <apikey> elements.
SAMPLE: Log in to Echo using the API key and password
<?xml version="1.0" encoding="UTF-8"?>
<login_echo_request schemaVersion="8.7">
<authentication>
<shortcut>shortcut</shortcut>
<email>[email protected]</email>
<apiKey>A7mK9qR2xP8vN4tJ6cWd</apiKey>
<password>password</password>
<userAgent>UserAgentSample</userAgent>
</authentication>
<echo something="whatever">Hello world!</echo>
</login_echo_request>
If You Encounter a 403 Error
If you receive a 403 Forbidden response, please contact our support team and provide:
- The IP address used at the time of the request
- The user agent string associated with the request
This information will allow us to verify registration status and resolve any access‑related issues.
Next Steps
We recommend testing your integration as soon as possible to identify and address any issues before September 1, 2026. If you have questions, need to register a user agent, or require assistance upgrading your XML version, please contact the ChannelOnline support team.
How to locate your user agent.
Please provide this information to the support team.
We thank you for your continued partnership.
Please post your questions in the Comments area below.
