Deploying the Enhanced API Connector

The Zoom Enhanced API Connector (EAPIC) is optional server software included with the Conference Room Connector subscription. An administrator will deploy EAPIC to configure and manage supported SIP/H.323 devices for use with Zoom meetings. By managing the device with the EAPIC, you can enable features such as:

Requirements for deploying the Enhanced API Connector

Windows server and Docker container system requirements 

Table of Contents

How to deploy the Enhanced API Connector on a Windows-based server

  1. Sign in to the Zoom web portal.
  2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
  3. Click the API Connectors button. 
  4. Click Add API Connector.
    Note: If you are reinstalling an API Connector, next to the API Connector, click Install and proceed to step 8.
  5. Fill out the following fields:
  6. (Optional): Click Save & Create Another to create another API Connector.
  7. Click Finish when done.
  8. On the API Connectors page, next to the newly created Connector, click Install.
  9. Select Windows to download the installer.
  10. Once the installer has been downloaded, run the installer.
  11. At the Customize this installation window, enter the following information:
  12. Complete the installation wizard.
  13. Once completed, refresh the API Connector page, and click on the name of the API Connector to confirm your Enhanced API Connector can connect to Zoom services.

Note: To collect the Enhanced API Connector log file(s), navigate to the folder where you installed the Enhanced API Connector software (default: C:\Program Files\Zoom\EnhancedZoomAPIConnector\) and open the logs folder, where you will find the service's log file(s)

How to deploy the Enhanced API Connector using Docker

  1. Sign in to the Zoom web portal.
  2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
  3. Click the API Connectors tab.
  4. Click Add API Connector.
  5. Fill out the following fields:
  6. Click Finish when done.
  7. Download and unzip the Zoom Room Connector Runner files.
  8. Open and edit the dockerstart.sh file.
  9. Replace {{*}} in the following lines, with your Connector ID and Private Key:
    connectorId={{*}}
    privateKey={{*}}
  10. Save the changes to the file.
  11. Grant executable permissions for the script by running the following commands:
    cd ./zoom-connector-runner
    chmod +x dockerstart.sh
  12. Run the dockerstart.sh script.

How to deploy the Enhanced API Connector using Zoom Node

The Zoom Node API Connector Manager module is an alternative to traditional API Connector deployment with a Windows virtual machine (VM) or standalone Docker container. Learn more about deploying the Enhanced API Connector using Zoom Node.

How to configure the Enhanced API Connector for automatic updates

The enhanced API Connector automatic updates are enabled by default for Enhanced API Connector deployed on Windows Server or Docker. Updates for the Enhanced API Connector module for Zoom Node are managed within the Zoom Node Management section of the Zoom Web portal.

Zoom recommends leaving automatic updates enabled for Enhanced API Connector deployed on Windows Server, Docker, or as a module for Zoom Node. If you disable automatic updates, you must perform manual updates to ensure your Enhanced API Connectors remain above the minimum version specified in the Zoom Software Quarterly Lifecycle Policy, or they will stop functioning. 

Configuring automatic updates for all Enhanced API Connectors

Note: These settings only apply to Enhanced API Connector deployed on Windows Server or Docker. Updates for the Enhanced API Connector module for Zoom Node are managed by Zoom Node, see Managing updates for Zoom Node.

  1. Sign in to the Zoom web portal.
  2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
  3. Click the Settings, then click the Advanced tab.
  4. Under the API Connector section, enable or disable Enable Automatic Update to set the default behavior.
  5. (Optional) To prevent this from being modified for all API Connectors, click the lock icon , and then click Lock to confirm the setting.

  6. Enable or disable Enable Runner Automatic Update to set the default behavior. 
  7. (Optional) To prevent this from being modified for all API Connectors, click the lock icon , and then click Lock to confirm the setting.

Configuring Enhanced API Connector automatic updates for a specific Enhanced API Connector

Note: These settings only apply to Enhanced API Connector deployed on Windows Server or Docker. Updates for the Enhanced API Connector module for Zoom Node are managed by Zoom Node, see Managing updates for Zoom Node.

  1. Sign in to the Zoom web portal.
  2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
  3. Click the API Connectors button.
  4. Next to the desired API Connector, click Edit.
  5. Enable or disable Enable Automatic Update.

How to manually update the Enhanced API Connector

If you disable automatic updates, you must perform manual updates to ensure your Enhanced API Connectors remain above the minimum version specified in the Zoom Software Quarterly Lifecycle Policy, or they will stop functioning. To manually update the Enhanced API Connector, follow the steps in the sections below.

Manually updating the Enhanced API Connector for Windows Server

Zoom recommends completely uninstalling the Enhanced API Connector application using the Windows OS Apps and Features control panel (also known as Add or remove programs), including logs. Then reboot the Windows Server. Next, download the most recent version of the Enhanced API Connector application from Zoom web portal and reinstall it. This series of actions prevents the possibility of an old Enhanced API Connector runner version remaining installed on the Windows Server.

Note: if you modified the runner.conf file of your current installation, record the changes you made before uninstalling the Enhanced API Connector application as the runner.conf file will be removed as part of uninstallation. Reapply the changes after reinstalling, then reboot the server.

Manually updating the Enhanced API Connector for Docker

Manual updates of the Enhanced API Connector Docker container are not possible. Instead, download the most recent version of the Enhanced API Connector application from Zoom web portal and redeploy the connector.

Note: if you modified the runner.conf file of your current installation, record the changes you made before uninstalling the Enhanced API Connector application as the runner.conf file will be removed as part of uninstallation. Reapply the changes after reinstalling, then reboot the server.

Manually updating the Enhanced API Connector for Zoom Node

Manual updates of the Enhanced API Connector module for Zoom Node is not currently possible. Instead, stop the service and delete it from the Zoom Node, then redeploy the service to the Zoom Node.