Magento 2: common integration issues

About this article

This article describes frequently encountered issues when trying to integrate your Magento 2 system with ChannelEngine, and how to solve them. 

Introduction

The ChannelEngine integration adds two extra API endpoints and an extra database table via the Magento 2 API.  In most cases, issues related to the extension installation in ChannelEngine are related to your server (setup). We recommend contacting your webserver administrator if you are experiencing integration issues not listed below.  

Issues installing the extension

For shops in production mode (the default mode if your webshop is currently allowing sales), you may experience the issue in which files are not up-to-date when installing our extension. If this is the case, a notification is displayed. This issue can usually be resolved by running the command bin/magento setup:di:compile via a command prompt. More information can be found in Magento 2's developer documentation. 
Shops running in development mode do not experience this issue, as all caches and temporary files are be disabled.

Issue(s) when trying to activate the extension when using Byte

If Byte (Hypernode) is your host, check that the Magento 2 API endpoints are enabled. These endpoints are disabled by default, preventing ChannelEngine from accessing Magento 2 API and exchanging the necessary authentication tokens. See this article for more information.

Issue(s) when trying to activate the extension (401/403 error)

Be sure to allow access to Channel Engine IP addresses in your firewall or AP allowlist.

Issue(s) when trying to activate the extension when using an Apache + PHP-FPM configured server (authentication header is stripped)

This issue can occur when Apache strips the required authentication header from the request. This is a known issue that Magento 2 will address in a future update but in the meantime, a workaround can be found on Github. This issue can also occur on other types of servers such as Nginx if HTTP basic authentication support is not set up.