Zoom Connector for Azure Data Factory (SSIS) How to Make Generic API Request

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. ODBC PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Make Generic API Request in SSIS

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

    In the new SSIS project screen you will find the following:

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  3. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

    SSIS Data Flow Task - Drag and Drop

  4. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:

    SSIS API Source (Predefined Templates) - Drag and Drop

  5. Select New Connection to create a new connection:

    API Source - New Connection

  6. Use a preinstalled Zoom Connector from Popular Connector List or press Search Online radio button to download Zoom Connector. Once downloaded simply use it in the configuration:

    Zoom
    Zoom Connector Selection

  7. Now it's time to configure authentication. Firstly, configure authentication settings in Zoom service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

    User OAuth (Granular scopes)

    Zoom authentication

    OAuth App must be created under Admin Console > Channel > API > Settings. [API reference]

    Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):

    1. Go to the Zoom App Marketplace and sign in with your Zoom account.
    2. From the top navigation bar, open the Develop dropdown and select Build App.
    3. In the What kind of app are you creating window, select General App, click the Create button.
    4. Enter a name for your app and select the app type.
      (E.g. Zoom-General App)
    5. Click Create to continue.
    6. In the Redirect URL for OAuth field, enter the following URI and add it to the allow list:
      https://zappysys.com/oauth/
    7. Copy your Client ID and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
    8. From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
      Scope Levels:
      • User-Level: Grants access only to the authenticated user’s data. Suitable for apps where users connect with their own Zoom account.
      • Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
      • Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.

      Recommended Scopes:
      User-Level
      • user:read:settings
      • meeting:read:list_meetings
      • meeting:read:meeting
      • meeting:read:list_registrants
      • meeting:read:past_meeting
      • meeting:read:list_registration_questions
      • webinar:read:list_webinars
      • webinar:read:webinar
      • webinar:read:list_registrants
      Admin-Level
      • user:read:settings:admin
      • user:write:user:admin
      • meeting:read:list_meetings:admin
      • meeting:read:meeting:admin
      • meeting:read:list_registrants:admin
      • meeting:read:past_meeting:admin
      • meeting:read:list_registration_questions:admin
      • user:read:list_users:admin
      • webinar:read:list_webinars:admin
      • webinar:read:webinar:admin
      • webinar:read:list_registrants:admin
      Master-Level
      • user:read:settings:master
      • meeting:read:list_meetings:master
      • meeting:read:meeting:master
      • meeting:read:list_registrants:master
      • user:read:list_users:master
      • webinar:read:list_webinars:master
      • webinar:read:webinar:master
      • webinar:read:list_registrants:master
    9. That’s it! After adding the scopes, click Continue to complete the process.
    10. In the ZappySys API Component/Driver UI, enter your Zoom app Client ID and Client Secret, then click Generate Token to obtain the access tokens.
    11. You’re done!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to User OAuth (Granular scopes) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    Zoom
    User OAuth (Granular scopes) [OAuth]
    https://api.zoom.us/v2
    Required Parameters
    Client Id Fill-in the parameter...
    Client Secret Fill-in the parameter...
    Redirect Url Fill-in the parameter...
    Token Url Fill-in the parameter...
    Authorization Url Fill-in the parameter...
    Optional Parameters
    Retry Mode RetryWhenStatusCodeMatch
    Retry Status Code 429
    Retry Count Max 5
    Retry Multiply Wait Time True
    ZappySys OAuth Connection

    OAuth Authentication

    Zoom authentication

    OAuth App must be created under Admin Console > Channel > API > Settings. [API reference]

    Perform the following steps to get the Zoom OAuth credentials (i.e. Client ID and Client Secret)

    1. Go to Zoom Marketplace Portal and sign in there.
    2. Once you successfully login then select "Build App" option from Develop dropdown from top left on the page.
    3. Click on Create button of OAuth panel section of page.
    4. Enter the name for your application and choose app type (Recommneded "Account-Level App") option for your API
    5. Then proceed with clicking Create button.
    6. In Redirect URL for OAuth enter this https://zappysys.com/oauth/ as Redirect URI and add it to allow lists.
    7. Copy Client ID and Client Secret here and paste it into Connection Manager Required Paramters section in respective place holders
    8. Add appropiate scopes from the Scopes menu option to the right side of page for your API as below :
      • meeting:read;
      • meeting:write;
      • user:read;
      • user:write;
      • user_info:read;
      • meeting:read:admin;
      • chat_channel:read;
      • chat_channel:write;
      • chat_contact:read;
      • chat_message:read;
      • chat_message:write;
      • contact:read;
      • pac:read;
      • pac:write;
      • phone:read;
      • phone:write
      • phone_call_control:read;
      • phone_call_control:write;
      • phone_call_log:read;
      • phone_call_log:write;
      • phone_e911:read;
      • phone_recording:read;
      • phone_recording:write;
      • phone_sms:read;
      • phone_sms:write;
      • phone_voicemail:read;
      • phone_voicemail:write;
      • recording:read;
      • recording:write;
      • tsp:read
      • tsp:write;
      • user:read;
      • user:write;
      • user_info:read;
      • user_zak:read;
      • webinar:read;
      • webinar:write
    9. Click Generate Token button on Connection Manager UI to generate tokens.
    10. That's it!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth Authentication [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    Zoom
    OAuth Authentication [OAuth]
    https://api.zoom.us/v2
    Required Parameters
    ClientId Fill-in the parameter...
    ClientSecret Fill-in the parameter...
    RedirectUrl Fill-in the parameter...
    TokenUrl Fill-in the parameter...
    AuthorizationUrl Fill-in the parameter...
    Optional Parameters
    Scope
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

    Server OAuth (Granular scopes)

    Zoom authentication

    Server-to-Server OAuth authentication method that lets applications access the Zoom API directly without user login or consent, using a Client ID and Secret to generate short-lived tokens. [API reference]

    Follow the steps below to create a Zoom OAuth app and obtain the required credentials (Client ID and Client Secret):

    1. Go to the Zoom App Marketplace and sign in with your Zoom account.
    2. From the top navigation bar, open the Develop dropdown and select Build App.
    3. In the What kind of app are you creating window, select Server to Server OAuth App, click the Create button.
    4. Enter a name for your app and select the app type.
      (E.g. Basic OAuth App)
    5. Click Create to continue.
    6. Copy your Account ID, Client ID, and Client Secret, then paste them into the ZappySys API Component/Driver UI under the required parameters.
    7. In the Information window, enter the company name, developer name, and email address, then click Continue.
    8. From the Scopes window, please add the appropriate Granular scopes. You can search for the scopes listed below and enable them as needed.
      Scope Levels:
      • Admin-Level: Grants access to data across all users in the account, provided the user has admin permissions. Best for organization-wide apps.
      • Master-Level: Grants access at the highest level, typically for apps that need full account control (including sub-accounts). Requires Master Account credentials.

      Recommended Scopes:
      Admin-Level
      • user:read:settings:admin
      • user:write:user:admin
      • meeting:read:list_meetings:admin
      • meeting:read:meeting:admin
      • meeting:read:list_registrants:admin
      • meeting:read:past_meeting:admin
      • meeting:read:list_registration_questions:admin
      • user:read:list_users:admin
      • webinar:read:list_webinars:admin
      • webinar:read:webinar:admin
      • webinar:read:list_registrants:admin
      Master-Level
      • user:read:settings:master
      • meeting:read:list_meetings:master
      • meeting:read:meeting:master
      • meeting:read:list_registrants:master
      • user:read:list_users:master
      • webinar:read:list_webinars:master
      • webinar:read:webinar:master
      • webinar:read:list_registrants:master
    9. That’s it! After adding the scopes, click Continue to complete the process.
    10. In the ZappySys API Component/Driver UI, enter your Zoom app Account ID, Client ID, and Client Secret, then click Test Connection.
    11. You’re done!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to Server OAuth (Granular scopes) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    Zoom
    Server OAuth (Granular scopes) [OAuth]
    https://api.zoom.us/v2
    Required Parameters
    Account Id Fill-in the parameter...
    Client Id Fill-in the parameter...
    Client Secret Fill-in the parameter...
    Token Url Fill-in the parameter...
    UseCustomApp Fill-in the parameter...
    Optional Parameters
    Retry Mode RetryWhenStatusCodeMatch
    Retry Status Code 429
    Retry Count Max 5
    Retry Multiply Wait Time True
    ZappySys OAuth Connection

  8. Select Generic Table (Bulk Read / Write) table from the dropdown and hit Preview Data:

    API Source - Zoom
    Zoom Connector can be used to integrate Zoom REST API in your App / BI Tools. You can read/write data about Meetings, Invite, Users, Accounts and more.
    Zoom
    Generic Table (Bulk Read / Write)
    Required Parameters
    HTTP - Url or File Path Fill-in the parameter...
    HTTP - Request Method Fill-in the parameter...
    Optional Parameters
    HTTP - Request Body
    HTTP - Is MultiPart Body (Pass File data/Mixed Key/value)
    HTTP - Request Format (Content-Type) ApplicationJson
    HTTP - Headers (e.g. hdr1:aaa || hdr2:bbb) Accept: */* || Cache-Control: no-cache
    Parser - Response Format (Default=Json) Default
    Parser - Filter (e.g. $.rows[*] )
    Parser - Encoding
    Parser - CharacterSet
    Download - Enable reading binary data False
    Download - File overwrite mode AlwaysOverwrite
    Download - Save file path
    Download - Enable raw output mode as single row False
    Download - Raw output data RowTemplate {Status:'Downloaded'}
    Download - Request Timeout (Milliseconds)
    General - Enable Custom Search/Replace
    General - SearchFor (e.g. (\d)-(\d)--regex)
    General - ReplaceWith (e.g. $1-***)
    General - File Compression Type
    General - Date Format
    General - Enable Big Number Handling False
    General - Wait time (Ms) - Helps to slow down pagination (Use for throttling) 0
    JSON/XML - ExcludedProperties (e.g. meta,info)
    JSON/XML - Flatten Small Array (Not preferred for more than 10 items)
    JSON/XML - Max Array Items To Flatten 10
    JSON/XML - Array Transform Type
    JSON/XML - Array Transform Column Name Filter
    JSON/XML - Array Transform Row Value Filter
    JSON/XML - Array Transform Enable Custom Columns
    JSON/XML - Enable Pivot Transform
    JSON/XML - Array Transform Custom Columns
    JSON/XML - Pivot Path Replace With
    JSON/XML - Enable Pivot Path Search Replace False
    JSON/XML - Pivot Path Search For
    JSON/XML - Include Pivot Path False
    JSON/XML - Throw Error When No Match for Filter False
    JSON/XML - Parent Column Prefix
    JSON/XML - Include Parent When Child Null False
    Pagination - Mode
    Pagination - Attribute Name (e.g. page)
    Pagination - Increment By (e.g. 100) 1
    Pagination - Expression for Next URL (e.g. $.nextUrl)
    Pagination - Wait time after each request (milliseconds) 0
    Pagination - Max Rows Expr
    Pagination - Max Pages Expr
    Pagination - Max Rows DataPath Expr
    Pagination - Max Pages 0
    Pagination - End Rules
    Pagination - Next URL Suffix
    Pagination - Next URL End Indicator
    Pagination - Stop Indicator Expr
    Pagination - Current Page
    Pagination - End Strategy Type DetectBasedOnRecordCount
    Pagination - Stop based on this Response StatusCode
    Pagination - When EndStrategy Condition Equals True
    Pagination - Max Response Bytes 0
    Pagination - Min Response Bytes 0
    Pagination - Error String Match
    Pagination - Enable Page Token in Body False
    Pagination - Placeholders (e.g. {page})
    Pagination - Has Different NextPage Info False
    Pagination - First Page Body Part
    Pagination - Next Page Body Part
    Csv - Column Delimiter ,
    Csv - Has Header Row True
    Csv - Throw error when column count mismatch False
    Csv - Throw error when no record found False
    Csv - Allow comments (i.e. line starts with # treat as comment and skip line) False
    Csv - Comment Character #
    Csv - Skip rows 0
    Csv - Ignore Blank Lines True
    Csv - Skip Empty Records False
    Csv - Skip Header Comment Rows 0
    Csv - Trim Headers False
    Csv - Trim Fields False
    Csv - Ignore Quotes False
    Csv - Treat Any Blank Value As Null False
    Xml - ElementsToTreatAsArray
    SSIS API Source - Read from table or endpoint

  9. That's it! We are done! Just in a few clicks we configured the call to Zoom using Zoom Connector.

    You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Zoom and load into target
Download Zoom Connector for Azure Data Factory (SSIS) Documentation

More actions supported by Zoom Connector

Learn how to perform other actions directly in Azure Data Factory (SSIS) with these how-to guides:

More integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications