Magento 2: common integration issues

While Magento 2 is an upgrade in many regards in comparison with Magento 1 and offers its own API to exchange data, there are some common issues you might run into when trying to connect our extension with Magento 2.

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

Common integration issues are:

• Issue when 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 will be displayed. This issue can usually be resolved by running the command "bin/magento setup:di:compile" through a command prompt. More information can be found here: https://devdocs.magento.com/guides/v2.3/comp-mgr/install-extensions.html.
  
  Shops running in development mode will not have this issue, as all caches and temporary files will be disabled.
  
  
• Issue(s) when trying to activate the extension when using Byte
  
  If Byte (Hypernode) is your host, please make sure 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. Please check https://support.hypernode.com/knowledgebase/protecting-the-magento-2-api/ for more information.
  
  
• Issue(s) when trying to activate the extension (401/403 error)
  
  Please make sure to allow access to Channel Engine IP addresses in your firewall or AP allowlist (see https://help.channelengine.com/article/32-channelengine-ip-ranges). 
  
  
• 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 here: https://github.com/magento/magento2/issues/15321#issuecomment-431252599
  
  This issue can also occur on other types of servers such as  Nginx if HTTP basic authentication support is not set up.