Zu Content springen
  • Es gibt keine Vorschläge, da das Suchfeld leer ist.

Server-to-Server-OAuth-App für die Zoom-Schnittstelle erstellen

Zoom-Lizenzierung prüfen, App im Zoom App Marketplace anlegen, Berechtigungen setzen und Account-ID, Client-ID sowie Client-Secret sichern

Legen Sie in Ihrem Zoom-Konto eine eigene App an, damit KuferSQL später über die Zoom-REST-API Meetings anlegen, aktualisieren und löschen darf.

ℹ️ Voraussetzung: Teil 1 von 4 der Artikelreihe zur Zoom-Schnittstelle. Sie brauchen die Zugangsdaten eines Zoom-Kontos mit PRO-Lizenz oder höher sowie die Berechtigung, im Zoom App Marketplace Apps anzulegen. Die Zoom-Schnittstelle selbst ist ein kostenpflichtiger Zusatzbaustein von KuferSQL und wird mit einem Passwort der Kundenbetreuung freigeschaltet.
⚠️ Achtung: Zoom hat das früher genutzte Verfahren JWT App zum 01.06.2023 eingestellt. Richten Sie die Schnittstelle deshalb ausschließlich mit dem Verfahren Server-To-Server OAuth App ein.

Was ist die Zoom-Schnittstelle?

Die Zoom-Schnittstelle verbindet den Kursstamm von KuferSQL mit Ihrem Zoom-Konto. Aus den Kursdaten heraus lässt sich damit ein Meeting in Zoom erstellen, ein bereits erstelltes Meeting aktualisieren und wieder löschen.

Damit KuferSQL von außen auf Zoom zugreifen darf, gilt:

  • Lizenz: Es wird eine PRO-Lizenz von Zoom oder höher benötigt. Erst ab dieser Lizenzierung steht die für externe Zugriffe benötigte REST-API-Schnittstelle zur Verfügung und die Schnittstelle lässt sich ohne Zeitbegrenzung nutzen.
  • Education-Lizenz: Eine Education-Lizenz zählt zu den Business-Lizenzen und ist damit höher als die PRO-Lizenz einzustufen. Eine Anbindung an die Zoom-Schnittstelle von KuferSQL ist damit möglich; laut schriftlicher Aussage der Zoom-Hotline kann auch diese Version technisch über die Schnittstelle angesteuert werden.
  • Teilnahme: Eine Lizenz ist nur für Veranstalter von Videokonferenzen erforderlich. Für die bloße Teilnahme an einem Zoom-Meeting ist keine Registrierung notwendig.

Schnellanleitung

💡 Schnell-Setup in Zoom
  1. Im Zoom App Marketplace über Develop → Build App eine App vom Typ Server-to-Server OAuth anlegen
  2. App-Namen KuferSQL vergeben und Account ID, Client ID sowie Client secret notieren
  3. Kontaktdaten Ihrer Einrichtung eintragen
  4. Die sechs Berechtigungen aus den Bereichen Meeting und User hinzufügen
  5. App mit Activate your app aktivieren

Schritt 1: App im Zoom App Marketplace anlegen

Öffnen Sie den Zoom App Marketplace unter https://marketplace.zoom.us und melden Sie sich mit Ihren Zoom-Zugangsdaten an. Wählen Sie anschließend über die Auswahl Develop die Funktion Build App.

Zoom App Marketplace mit geöffnetem Menü Develop, in dem der Eintrag Build App rot umrandet ist; darunter der Eintrag Documentation sowie Developer Blog und Community Forum

Zoom App Marketplace – im Menü Develop ist der rot markierte Eintrag Build App der Einstieg

Wählen Sie im darauffolgenden Bildschirm den Typ Server-to-Server OAuth und klicken Sie dort auf die Schaltfläche Create.

Kachel Server-to-Server OAuth mit englischem Beschreibungstext, dem Link Learn more und der rot umrandeten blauen Schaltfläche Create

Auswahl des App-Typs – die Kachel Server-to-Server OAuth wird über Create angelegt

Tragen Sie im Feld App Name den Namen KuferSQL ein und bestätigen Sie mit Create.

Schritt 2: Account-ID, Client-ID und Client-Secret sichern

Die App ist damit erstellt. Im Bildschirm App credentials muss nichts eingetragen werden — Zoom generiert die Werte Account ID, Client ID und Client secret automatisch.

Bildschirm App credentials der App KuferSQL mit den rot umrandeten Feldbeschriftungen Account ID, Client ID und Client secret, je einer Copy-Schaltfläche, der Schaltfläche Regenerate und der rot umrandeten Schaltfläche Continue

Bildschirm App credentials – die drei rot markierten Werte werden von Zoom automatisch erzeugt; im Screenshot stehen statt der echten Werte Platzhaltertexte

⚠️ Diese drei Werte jetzt sichern: Kopieren Sie Account ID, Client ID und Client secret temporär, z. B. in eine Textdatei. Sie sind essenziell für die Kommunikation zwischen KuferSQL und Zoom und werden im nächsten Artikel in KuferSQL hinterlegt. Bestätigen Sie den Bildschirm danach mit Continue.

Schritt 3: Kontaktdaten der Einrichtung eintragen

Tragen Sie im Bildschirm Information die von Zoom benötigten Felder Company Name, Name und Email address mit den Daten Ihrer Einrichtung ein und bestätigen Sie mit Continue.

Bildschirm Basic information der App KuferSQL mit den Feldern App name und Short description sowie den rot umrandeten Beschriftungen Company Name, Name und Email address unter Developer Contact Information und der rot umrandeten Schaltfläche Continue

Bildschirm Basic information – die drei rot markierten Pflichtfelder tragen die Daten Ihrer Einrichtung; im Screenshot stehen Platzhaltertexte

Der folgende Bildschirm Feature erfordert keine Eintragungen und kann sofort mit Continue bestätigt werden.

Schritt 4: Berechtigungen hinzufügen

Fügen Sie im Bildschirm Scopes die von der Schnittstelle benötigten Berechtigungen mit der Schaltfläche Add Scopes ein. Wählen Sie im Punkt Meeting diese drei Berechtigungen aus:

  • View and manage sub account’s user meetings (meeting:master)
  • View all user meetings (meeting:read:admin)
  • View and manage all user meetings (meeting:write:admin)

Dialog Add scopes mit der linken Bereichsliste, in der Meeting markiert ist, und einem roten Kasten um vier untereinander liegende Zeilen: gesetzte Haken bei View and manage sub account’s user meetings und View all user meetings, danach die nicht gesetzte Berechtigung Get a meeting’s encoded SIP URI und darunter der gesetzte Haken bei View and manage all user meetings

Dialog Add scopes, Bereich Meeting – der rote Kasten umschließt vier Zeilen, gesetzt sind darin aber nur die drei benötigten Haken; die dazwischen liegende Berechtigung Get a meeting’s encoded SIP URI bleibt ungesetzt

Wechseln Sie anschließend in den Punkt User und wählen Sie dort zusätzlich aus:

  • View and manage sub account’s user information (user:master)
  • View all user information (user:read:admin)
  • View users information and manage users (user:write:admin)

Dialog Add scopes mit markiertem Bereich User und rot umrandet den drei gesetzten Haken bei View and manage sub account’s user information, View all user information und View users information and manage users sowie der rot umrandeten Schaltfläche Done

Dialog Add scopes, Bereich User – rechts oben zeigt Zoom 6 Added an; die Auswahl wird mit Done bestätigt

Die sechs Berechtigungen werden danach in einer Liste angezeigt. Bestätigen Sie sie mit Continue.

Schritt 5: App aktivieren

Alle Einstellungen sind getroffen. Aktivieren Sie die App KuferSQL mit der Schaltfläche Activate your app.

Bildschirm Activation der App KuferSQL mit Uhr-Symbol, der Meldung Your app is ready for activation und der rot umrandeten Schaltfläche Activate your app

Bildschirm Activation – die App wird mit Activate your app scharf geschaltet

Zoom bestätigt die Aktivierung anschließend mit der Meldung Your app is activated on the account; an derselben Stelle liegt danach die Schaltfläche Deactivate your app.

Ergebnis

Die App KuferSQL ist in Ihrem Zoom-Konto angelegt, mit den sechs benötigten Berechtigungen versehen und aktiviert. Account-ID, Client-ID und Client-Secret liegen Ihnen vor.

✅ Geschafft: Weiter mit Teil 2 der Reihe — Zoom-Zugang in KuferSQL hinterlegen und Verbindung testen. Dort tragen Sie die drei Werte in die Zentralen Einstellungen ein.

Verwandte Artikel