How to Obtain APIs

To obtain API credentials, visit the Zoom App Marketplace at https://marketplace.zoom.us/ and sign in with your Zoom account. If you don't have a Zoom account, you can create one using this link.

eRoom requires Server-to-Server OAuth and Meeting SDK APIs to connect with Zoom and use its functionalities.

To make the Zoom Credentials work, the SSL should be activated on your domain.

Server-to-Server App Credentials

  1. On the Zoom App Marketplace page, click Develop and select Build App from the dropdown menu.

  1. In the popup window, choose Server-to-Server OAuth App and click on the Create button:

  1. Give a name to your App and click on Create:

  1. After completing this step, the system will automatically create API credentials, available in the App Credentials section.

  1. After selecting Continue, you will be taken to the Information page. On this page, you are required to enter essential details for your app, including your email and a description. Please ensure you accurately complete the following fields in the Information section:

  • Company Name

  • Developer Contact Name

  • Developer Contact Email

  1. You can skip the next step Feature.

  1. Next, to ensure the plugin functions correctly, navigate to the Scopes tab and select Add Scopes.

Required Scopes

Permission issue error notices may appear while creating the meetings or webinars when any of the listed Scopes are not enabled.

You can use the searchbar of the scopes menu to fasten the process:

Below you can see all required scopes:

Account

  • View account info

    • View an account's settings (account:read:account_setting:admin)

    • View an account's settings (account:read:account_setting:master)

    • View an account's settings (account:read:settings:admin)

  • View and manage account info

    • Update an account's settings (account:update:settings:admin)

  • View and manage sub accounts

    • Update an account's options (account:update:options:admin)

    • Update an account's owner (account:update:owner:master)

    • Update an account's settings (account:update:settings:master)

Meeting

  • View all user meeting summaries

    • View a meeting's summary (meeting:read:summary:admin)

  • View all user meetings

    • View a meeting's chat message (meeting:read:chat_message:admin)

    • View a meeting's invitation (meeting:read:invitation:admin)

    • View a user's meetings (meeting:read:list_meetings:admin)

    • View a user's upcoming meetings (meeting:read:list_upcoming_meetings:admin)

    • View a meeting (meeting:read:meeting:admin)

  • View and manage all user meetings

    • Delete a meeting (meeting:delete:meeting:admin)

    • Update a meeting (meeting:update:meeting:admin)

    • Update a meeting's status (meeting:update:status:admin)

    • Create invite links for a meeting (meeting:write:invite_links:admin)

    • Create a meeting for a user (meeting:write:meeting:admin)

  • View live streaming meeting token information

    • View a meeting live streaming join token (meeting:read:live_streaming_token:admin)

  • View local archiving meeting token information

    • View a meeting local archiving join token (meeting:read:local_archiving_token:admin)

User

  • View all user information

    • Verify a user's email (user:read:email:admin)

    • View a user's assistants (user:read:list_assistants:admin)

    • View a user's permissions (user:read:list_permissions:admin)

    • View users (user:read:list_users:admin)

    • View a user's settings (user:read:settings:admin)

    • View a user's token (user:read:token:admin)

    • View a user (user:read:user:admin)

  • View user's zak token

    • View a user's Zoom Access Key (user:read:zak:admin)

  • View users information and manage users

    • Delete a user (user:delete:user:admin)

    • Update a user (user:update:user:admin)

    • Create a user (user:write:user:admin)

Zoom Events

  • Manage event speaker information

    • Remove an event's speaker (zoom_events:delete:speaker:admin)

    • Update an event's speaker (zoom_events:update:speaker:admin)

    • Add a speaker to an event (zoom_events:write:speaker:admin)

  • View all events information

    • View an event (zoom_events:read:event:admin)

    • View events (zoom_events:read:list_events:admin)

  • View event's Access Link

    • View zoom event access links (zoom_events:read:list_access_links:admin)

Webinar

  • View all user Webinars

    • View a webinar's participant (webinar:read:participant:admin)

    • View a webinar (webinar:read:webinar:admin)

  • View and manage all user Webinars

    • Delete a webinar (webinar:delete:webinar:admin)

    • Update a webinar's status (webinar:update:status:admin)

    • Update a webinar (webinar:update:webinar:admin)

    • Create invite links for a webinars (webinar:write:invite_links:admin)

    • Create a webinar for a user (webinar:write:webinar:admin)

  • View and manage sub account's user webinars

    • Delete a webinar (webinar:delete:webinar:master)

    • View a webinar (webinar:read:webinar:master)

    • Update a webinar (webinar:update:webinar:master)

    • Create invite links for a webinars (webinar:write:invite_links:master)

    • Create a webinar for a user (webinar:write:webinar:master)

Once you've added all the necessary Scopes, click on the Done button.

To learn more about scopes and expand the functionality of the app, read Zoom's doc about OATH Scopes.

Click Continue to go to the final step.

  1. Finally, activate the Server-to-Server App:

  1. Copy the Account ID, Client ID, and Client Secret and paste them into the respective fields on the Zoom Settings page in your dashboard and save the settings:

Meeting SDK Credentials

Zoom Meeting SDK offers video-conferencing features that mirror the meeting experience in the Zoom Client. Meeting SDK is required to make Join In Browser work.

  1. Go to the Zoom App Marketplace at https://marketplace.zoom.us/.

  1. On the Zoom App Marketplace page, click Develop and select Build App from the dropdown menu

  1. In the popup window, choose General App:

  1. On the opened page, name the App according to your needs:

  1. In the Basic Information page choose Admin-managed as the app management type and Save it:

  1. Indicate your site URL (including https part) to OAuth Redirect URL field on the same - Basic Information page (e.g: https://yourwebsite.com):

  1. Jump to the Embed tab and enable Meeting SDK:

  1. Move to the Scopes page and click on Add Scopes:

  1. Add the following scope and click on Done:

  • User > View user's zak token (user:read:zak:admin)

  1. Copy the App Credentials and paste them to the designated area in eRoom settings and save the changes:

Good job, you have done it succesfully!

Last updated