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:

Configuration of per-device Conference Room Connector settings such as video and content sharing quality, call connection rate, unmute on entry, and more
Calendaring integration to enable One-Touch Join into Zoom meetings
Quick ad-hoc join of Zoom Meetings by Meeting ID, with a “Join Zoom Meeting” favorite or speed dial
Zoom cloud SIP proxy call control registration, eliminating the need for legacy on-premises call control infrastructure
Integration with Zoom Phone for extension and PSTN dialing (separate license required)
Other device management features

Requirements for deploying the Enhanced API Connector

A Pro, Business, Enterprise, or Education account
Owner, Admin, or “H.323/SIP room connector” Role-based privileges
A Zoom account with a Cloud Room Connector license

Windows server and Docker container system requirements

A server or virtual machine (for installing and running the Zoom API Connector software locally)
8 GB of RAM
20 GB of storage
2-core, 4-core or 6-core, or equivalent vCPU, using an Intel Xeon Silver 4xxx (Skylake) processor, or later generation of processor, with a 2 GHz processor base frequency, or greater:
- A 2-core/-vCPU server can manage up to 300 Cisco/Polycom rooms.
- A 4-core/-vCPU server can manage up to 500 Cisco/Polycom rooms.
- A 6-core/-vCPU server can manage up to 1000 Cisco/Polycom rooms.
- Additional Enhanced API Connectors can be deployed to support larger numbers of endpoints. Learn more about using enhanced API Connectors in high availability.

How to deploy the Enhanced API Connector on a Windows-based server
How to deploy the Enhanced API Connector using Docker
How to deploy the Enhanced API Connector using Zoom Node
How to configure the Enhanced API Connector for automatic updates
- Configuring automatic updates for all Enhanced API Connectors
- Configuring Enhanced API Connector automatic updates for a specific Enhanced API Connector
How to manually update the Enhanced API Connector

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

Sign in to the Zoom web portal.
In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
Click the API Connectors button.
Click Add API Connector.
Note: If you are reinstalling an API Connector, next to the API Connector, click Install and proceed to step 8.
Fill out the following fields:
- API Description: The name/description of the API connector.
- Private Networks: The internal subnet ranges the devices are deployed on and that the Enhanced API Connector will manage.
  Note: If you use RFC1918 private IP addresses on your internal network and will have only one Enhanced API Connector, you may accept the default. If creating more than one API Connector, you can not use overlapping IP ranges.
(Optional): Click Save & Create Another to create another API Connector.
Click Finish when done.
On the API Connectors page, next to the newly created Connector, click Install.
Select Windows to download the installer.
Once the installer has been downloaded, run the installer.
At the Customize this installation window, enter the following information:
- Connector ID: Copy the Connector ID from the API Connector tab, and paste it into the Connector ID field in the installer.
- Private Key: Click the Private Key field on the API Connector page to copy it. Paste it into the Private Key field of the installer.
- (Optional) Use HTTP Proxy: Enable if your network uses an HTTP web proxy for Internet access, then enter the web proxy details.
Complete the installation wizard.
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

Sign in to the Zoom web portal.
In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
Click the API Connectors tab.
Click Add API Connector.
Fill out the following fields:
- API Description: The name/description of the API connector
- Private Networks: The private network ranges of devices, the API connector can provision.
  Note: If creating more then one API Connector, you can not use overlapping IP ranges.
Click Finish when done.
Download and unzip the Zoom Room Connector Runner files.
Open and edit the dockerstart.sh file.
Replace {{*}} in the following lines, with your Connector ID and Private Key:
```
connectorId={{*}}
privateKey={{*}}
```
Save the changes to the file.
Grant executable permissions for the script by running the following commands:
```
cd ./zoom-connector-runner
chmod +x dockerstart.sh
```
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.

Sign in to the Zoom web portal.
In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
Click the Settings, then click the Advanced tab.
Under the API Connector section, enable or disable Enable Automatic Update to set the default behavior.
(Optional) To prevent this from being modified for all API Connectors, click the lock icon , and then click Lock to confirm the setting.
Enable or disable Enable Runner Automatic Update to set the default behavior.
(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

Sign in to the Zoom web portal.
In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
Click the API Connectors button.
Next to the desired API Connector, click Edit.
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.

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.