codeq/zoom-api

Gets upcoming Zoom meetings and Zoom recordings via Eel Helper

v2.0.0 2023-09-21 14:58 UTC

Requires

• php: ^8
• guzzlehttp/guzzle: ^7.4
• neos/neos: ^7.0 || ^8.0 || dev-master

GPL-3.0-or-later

• Roland Schütz

README

CodeQ.ZoomApi

This package gets upcoming meetings and meeting recordings from Zoom. You can use the Eel helper to show these on your website

The development and the public-releases of this package are generously sponsored by Code Q Web Factory.

Installation

CodeQ.ZoomApi is available via packagist run composer require codeq/zoom-api. We use semantic versioning so every breaking change will increase the major-version number.

Usage

Create a Zoom Server-to-Server App for your login and grant the scopes user:read:admin, meeting:read:admin and recording:read:admin:

CodeQ:
  ZoomApi:
    auth:
      accountId: ''
      clientId: ''
      clientSecret: ''

Then use the Eel helper:

CodeQ.ZoomApi.getUpcomingMeetings()
CodeQ.ZoomApi.getRecordings('2021-01-01', 'now')
CodeQ.ZoomApi.getRecordings(Date.create('2021-01-01'), Date.now())

Performance and Caching

Beware, that the package does not cache the requests by default. Thus, using these Eel helpers on heavily frequented pages can lead to rate limit issues with the Zoom API. This package provides a request cache to tackle that issue.

By default, the cache is disabled. To enable the cache, configure the lifetime at your convenience:

CodeQ_ZoomApi_Requests:
  backendOptions:
    defaultLifetime: 600 # e.g. 60 seconds * 10 minutes = 600 seconds

Of course, you can also switch to a different cache backend at your convenience.