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

This article covers:

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

Prerequisites 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
• Enhanced Room Connector enabled for the account 

Server 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

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:
   • 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.
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:
    • 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.
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:
   • 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.
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.