Skip to main content

Authorization

zoom_api.png

Zoom

Zoom is a video communications platform that provides video conferencing, webinars, and collaboration tools. The Zoom API allows you to integrate Zoom functionality into your applications, enabling automated meeting management, user administration, and data synchronization.

Follow the instructions below to create a new Zoom credential in Nexla.

Prerequisites​

Before creating a Zoom credential, ensure you have the following:

Zoom Account​

You must have an active Zoom account with administrative privileges. This account provides access to the Zoom platform and its API.

Zoom App Registration​

You need to create a Server-to-Server OAuth application in your Zoom developer account to obtain the required credentials for API access.

Server-to-Server OAuth Credentials​

The Zoom API uses Server-to-Server OAuth for authentication. You will need to obtain Account ID, Client ID, and Client Secret credentials for your application.

  1. Create a Server-to-Server OAuth App: Follow the instructions in the Zoom Developer Documentation to create a Server-to-Server OAuth application in your Zoom developer account.

  2. Configure App Settings: During app creation, ensure you select the appropriate scopes for your use case. Common scopes include:

    • User Management: For managing users and their settings
    • Meeting Management: For creating and managing meetings
    • Webinar Management: For webinar operations
    • Phone Management: For phone system operations

  3. Note your credentials: Once created, you will be provided with an Account ID, Client ID, and Client Secret. Keep these secure, as they are essential for authenticating your API requests.

For complete information about setting up Zoom Server-to-Server OAuth applications and obtaining credentials, refer to the official Zoom Developer Documentation.

Required Scopes​

Ensure your Server-to-Server OAuth application is granted the necessary scopes to access the required Zoom functionality. The specific scopes needed depend on your use case:

  • User Management: user:read, user:write for user administration
  • Meeting Management: meeting:read, meeting:write for meeting operations
  • Webinar Management: webinar:read, webinar:write for webinar operations
  • Phone Management: phone:read, phone:write for phone system operations
  • Reporting: report:read for accessing usage reports

Credential Validation​

The Server-to-Server OAuth application requires a validation URL to test credentials. By default, this is set to https://api.zoom.us/v2/users/me, but you can customize this URL based on your specific needs and approved scopes.

Authentication Method​

Zoom uses Server-to-Server OAuth authentication, which provides secure, automated access to Zoom APIs without requiring user interaction.

Server-to-Server OAuth Configuration​

  1. Zoom App: Account ID: Enter the Account ID of your Server-to-Server OAuth application. This unique identifier is provided when you create your Server-to-Server OAuth app in the Zoom developer portal.

  2. Zoom App: Client ID: Enter the Client ID of your Server-to-Server OAuth application. This identifier is used to authenticate your application with Zoom's OAuth service.

  3. Zoom App: Client Secret: Enter the Client Secret of your Server-to-Server OAuth application. This secret key is used to securely authenticate your application and should be kept confidential.

  4. Credential Validation URL: Enter the URL that should be used for validating the credentials. This endpoint must be part of the scopes you have approved for your Server-to-Server OAuth application. The default value is https://api.zoom.us/v2/users/me, but you can customize this based on your needs.

The Credential Validation URL is used to test your credentials when creating the credential in Nexla. Ensure this endpoint is included in the scopes approved for your Server-to-Server OAuth application.

Security Considerations​

  • Credential Protection: Keep your Client Secret secure and never expose it in client-side code or public repositories.
  • Scope Limitation: Only request the minimum scopes necessary for your application's functionality to follow the principle of least privilege.
  • Token Management: Server-to-Server OAuth tokens are automatically managed by Nexla, eliminating the need for manual token refresh operations.
  • Account Access: Ensure your Zoom account has the necessary permissions to perform the operations your application requires.

API Rate Limits​

The Zoom API enforces rate limiting to ensure optimal performance and fair usage across all users.

  • Rate Limits: Vary by endpoint and account type
  • Exceeding Limits: Requests exceeding limits will receive appropriate HTTP status codes
  • Best Practice: Implement appropriate retry logic and respect rate limits in your application design

For detailed information about Zoom API rate limits and best practices, see the Zoom API Rate Limiting Documentation.

Next Steps​

Once you have created your Zoom credential, you can:

For additional information about Zoom API capabilities and use cases, refer to the Zoom Developer Documentation.