Plugin: Zoom: Update configuration instructions #4537

3 years ago · 362cf5a080
parent 7d48eca7d4
commit 362cf5a080
3 changed files with 110 additions and 82 deletions
--- a/plugin/zoom/README.md
+++ b/plugin/zoom/README.md
@ -8,33 +8,43 @@ conference and student to join it.
 ## Configuration

 The Zoom API uses JSON Web Tokens (JWT) to authenticate account-level access. JWT apps provide an API Key and Secret
-required to authenticate with JWT. To get them, create a JWT App:
+required to authenticate with JWT. To get them, create a JWT App or a Server-to-Sever OAuth app:

-1. Log into your [Zoom profile page]()
+> From June 1, 2023, Zoom recommend that you create a Server-to-Server OAuth application to replace the funcionality of
+> a JWT app in your account.
+
+1. Log into your [Zoom profile page](https://zoom.us/profile)
 2. Click on Advanced / Application Marketplace
-3. Click on [Develop / build App](https://marketplace.zoom.us/develop/create)
-4. Choose JWT / Create
+3. Click on [Develop / Build App](https://marketplace.zoom.us/develop/create)
+4. Choose JWT or Server-to-Serve OAuth and then Create
 5. Information: Fill in fields about your "App" (application and company names, contact name and email address)
 6. Click on Continue
-7. App Credentials: Copy your API Key and Secret to these fields below
-8. Click on Continue
+7. App Credentials
+   1. For a JWT application: Copy your API Key and Secret to the plugin configuration
+   2. For a Server-to-Server OAuth application: Copy your *Account ID*, *Client ID* anf *Client secret* to the plugin
+      configuration
+8. Click on Continue 
 9. Feature: enable Event Subscriptions to add a new one with endpoint
-   URL https://your.chamilo.url/plugin/zoom/endpoint.php and add these event types:
-
-     - Start Meeting
-     - End Meeting
-     - Participant/Host joined meeting
-     - Participant/Host left meeting
-     - Start Webinar
-     - End Webinar
-     - Participant/Host joined webinar
-     - Participant/Host left webinar
-     - All Recordings have completed
-     - Recording transcript files have completed
-
-    Then click on Done then on Save and copy your Verification Token to the field below.
+   URL `https://your.chamilo.url/plugin/zoom/endpoint.php` (validate the endpoint to allow to activate the app) and add
+   these event types:
+
+      - Start Meeting
+      - End Meeting
+      - Participant/Host joined meeting
+      - Participant/Host left meeting
+      - Start Webinar
+      - End Webinar
+      - Participant/Host joined webinar
+      - Participant/Host left webinar
+      - All Recordings have completed
+      - Recording transcript files have completed
+
+   Then click on Done then on Save and copy your *Verification Token* if you have a JWT application or the *Secret
+   Token* if you have an Server-to-Server OAuth application to the plugin configuration
 10. click on Continue
-
+11. Scopes (only for Server-to-Server OAuth application): Click on Add Scopes and select *meeting:write:admin*,
+    *webinar:write:admin*, *recording:write:admin*. Then click on Done.
+    
 ## Changelog

 **v0.5**
--- a/plugin/zoom/lang/english.php
+++ b/plugin/zoom/lang/english.php
@ -34,37 +34,46 @@ Once enabled, it will show as an additional course tool in all courses' homepage
 teachers will be able to <strong>launch</strong> a conference and student to <strong>join</strong> it.
 <br/>
 This plugin requires a Zoom account to manage meetings.
-The Zoom API uses JSON Web Tokens (JWT) to authenticate account-level access.
-<br/>
-JWT apps provide an <strong>API <em>Key</em> and <em>Secret</em></strong> required to authenticate with JWT.
-
-To get them, create a <em>JWT App</em> :
-<br/>1. log into <a href=\"https://zoom.us/profile\">your Zoom profile page</a>
-<br/>2. click on <em>Advanced / Application Marketplace</em>
-<br/>3. click on <em><a href=\"https://marketplace.zoom.us/develop/create\">Develop / build App</a></em>
-<br/>4. choose <em>JWT / Create</em>
-<br/>5. Information: fill in fields about your \"App\"
-(application and company names, contact name and email address)
-<br/>6. Click on <em>Continue</em>
-<br/>7. App Credentials: <strong>copy your API Key and Secret to these fields below</strong>
-<br/>8. click on <em>Continue</em>
-<br/>9. Feature:
-enable <em>Event Subscriptions</em> to add a new one with endpoint URL
-<code>https://your.chamilo.url/plugin/zoom/endpoint.php</code>
-and add these event types:
-<br/>- Start Meeting
-<br/>- End Meeting
-<br/>- Participant/Host joined meeting
-<br/>- Participant/Host left meeting
-<br/>- Start Webinar
-<br/>- End Webinar
-<br/>- Participant/Host joined webinar
-<br/>- Participant/Host left webinar
-<br/>- All Recordings have completed
-<br/>- Recording transcript files have completed
-<br/>then click on <em>Done</em> then on <em>Save</em>
-and <strong>copy your Verification Token to the field below</strong>.
-<br/>10. click on <em>Continue</em>
+<p>The Zoom API uses JSON Web Tokens (JWT) to authenticate account-level access. To get them, create a JWT App or a Server-to-Sever OAuth app:</p>
+<blockquote>
+  <p>From June 1, 2023, Zoom recommend that you create a Server-to-Server OAuth application to replace the funcionality of
+  a JWT app in your account.</p>
+</blockquote>
+<ol>
+<li>Log into your <a href=\"https://zoom.us/profile\">Zoom profile page</a></li>
+<li>Click on Advanced / Application Marketplace</li>
+<li>Click on <a href=\"https://marketplace.zoom.us/develop/create\">Develop / Build App</a></li>
+<li>Choose JWT or Server-to-Serve OAuth and then Create</li>
+<li>Information: Fill in fields about your \"App\" (application and company names, contact name and email address)</li>
+<li>Click on Continue</li>
+<li>App Credentials
+<ol>
+<li>For a JWT application: Copy your API Key and Secret to the plugin configuration</li>
+<li>For a Server-to-Server OAuth application: Copy your <em>Account ID</em>, <em>Client ID</em> and <em>Client secret</em> to the plugin
+configuration</li>
+</ol></li>
+<li>Click on Continue</li>
+<li><p>Feature: enable <em>Event Subscriptions</em> to add a new one with endpoint URL
+<code>https://your.chamilo.url/plugin/zoom/endpoint.php</code> (validate the endpoint to allow to activate the app) and add
+these event types:</p>
+<ul>
+<li>Start Meeting</li>
+<li>End Meeting</li>
+<li>Participant/Host joined meeting</li>
+<li>Participant/Host left meeting</li>
+<li>Start Webinar</li>
+<li>End Webinar</li>
+<li>Participant/Host joined webinar</li>
+<li>Participant/Host left webinar</li>
+<li>All Recordings have completed</li>
+<li>Recording transcript files have completed</li>
+</ul>
+<p>Then click on Done then on Save and copy your <em>Verification Token</em> if you have a JWT application or the <em>Secret
+Token</em> if you have an Server-to-Server OAuth application to the plugin configuration</p></li>
+<li>click on Continue</li>
+<li>Scopes (only for Server-to-Server OAuth application): Click on <em>Add Scopes</em> and select <em>meeting:write:admin</em>,
+<em>webinar:write:admin</em>, <em>recording:write:admin</em>. Then click on Done.</li>
+</ol>
 <br/>
 <strong>Attention</strong>:
 <br/>Zoom is <em>NOT</em> free software and specific rules apply to personal data protection.
--- a/plugin/zoom/lang/spanish.php
+++ b/plugin/zoom/lang/spanish.php
@ -22,37 +22,46 @@ Una vez activada, aparecerá en las páginas principales de todos los cursos. Lo
 <strong>iniciar</strong> una conferencia y los alumnos <strong>juntarse</strong> a ella.
 <br/>
 Este plugin requiere una cuenta Zoom para gestionar las conferencias.
-El API de Zoom utiliza los <em>JSON Web Tokens (JWT)</em> para autorizar el acceso a una cuenta.
-<strong>Una <em>clave</em> y un <em>código secreto</em> de API son necesarios</strong> para identificarse con JWT.
-Para obtenerlos, crea una <em>app JWT</em> :
-<br/>1. logéase en <a href=\"https://zoom.us/profile\">Su perfil Zoom</a>
-<br/>2. de clic en <em>Avanzado / Marketplace de aplicaciones</em>
-<br/>3. de clic en <em><a href=\"https://marketplace.zoom.us/develop/create\">Develop / build App</a></em>
-<br/>4. escoja <em>JWT / Create</em>
-<br/>5. Information: ingrese algunas informaciones sobre vuestra \"App\"
+<p>El API de Zoom utiliza los <em>JSON Web Tokens (JWT)</em> para autorizar el acceso a una cuenta.
+Para obtenerlos, crea una <em>app JWT</em> o una aplicación Server-to-Server OAuth:</p>
+<blockquote>
+  <p>Desde el 1 de junio de 2023, Zoom recomienda que usted cree una aplicación Server-to-Server OAuth para reemplazar
+  la funcionalidad de una aplicación JWT en tu cuenta.</p>
+</blockquote>
+<ol>
+<li>logéase en <a href=\"https://zoom.us/profile\">Su perfil Zoom</a></li>
+<li>de clic en <em>Avanzado / Marketplace de aplicaciones</em></li>
+<li>de clic en <em><a href=\"https://marketplace.zoom.us/develop/create\">Develop / build App</a></em></li>
+<li>escoja <em>JWT o Sever-to-Server OAuth y luego Create</em></li>
+<li>Information: ingrese algunas informaciones sobre vuestra \"App\"
 (nombres de la aplicación, de la empresa, nombre y dirección de correo de contacto)
-<br/>6. de clic en <em>Continue</em>
-<br/>7. App Credentials:
-muestra la clave (API Key) y el código secreto (API Secret) por ingresar aquí.
-<strong>copiez la clé (API Key) et le code secret (API Secret) dans les champs ci-dessous.</strong>
-<br/>8. de clic en <em>Continue</em>
-<br/>9. Feature :
-activez <em>Event Subscriptions</em> para agregar uno con su endpoint URL
-<code>https://your.chamilo.url/plugin/zoom/endpoint.php</code>
-y agrega este tipo de eventos:
-<br/>- Start Meeting
-<br/>- End Meeting
-<br/>- Participant/Host joined meeting
-<br/>- Participant/Host left meeting
-<br/>- Start Webinar
-<br/>- End Webinar
-<br/>- Participant/Host joined webinar
-<br/>- Participant/Host left webinar
-<br/>- All Recordings have completed
-<br/>- Recording transcript files have completed
-<br/>de clic en <em>Done</em> y luego en <em>Save</em>
-y <strong>copie su Verification Token en el campo a continuación</strong>.
-<br/>10. de clic en <em>Continue</em>
+<li>de clic en <em>Continue</em></li>
+<li>App Credentials:
+<ol>
+<li>Para una aplicación JWT: copia la clave (API Key) y el código secreto (API Secret) por ingresar aquí.</li>
+<li>Para una aplicación Server-to-Server OAuth: Copia los valores de <em>Account ID</em>, <em>Client ID</em> y <em>Client secret</em> para ingresar aquí</li>
+</ol>
+<li>de clic en <em>Continue</em></li>
+<li><p>Feature : activez <em>Event Subscriptions</em> para agregar uno con su endpoint URL
+<code>https://your.chamilo.url/plugin/zoom/endpoint.php</code> (valida el endpoint para permitir activar la aplicación)
+y agrega este tipo de eventos:</p>
+<ul>
+<li>Start Meeting</li>
+<li>End Meeting</li>
+<li>Participant/Host joined meeting</li>
+<li>Participant/Host left meeting</li>
+<li>Start Webinar</li>
+<li>End Webinar</li>
+<li>Participant/Host joined webinar</li>
+<li>Participant/Host left webinar</li>
+<li>All Recordings have completed</li>
+<li>Recording transcript files have completed</li>
+</ul>
+<p>Luego de clic en <em>Done</em> y luego en <em>Save</em> y copie su <em>Verification Token</em> si tiene una aplicación JWT o el <em>Secret token</em> si tiene una aplicación Server-to-Server OAuth para ingresar aquí</li>
+<li>de clic en <em>Continue</em></li>
+<li>Scopes (solo para una aplicación Server-to-Server OAuth): click en <em>Add Scopes</em> y seleccione <em>meeting:write:admin</em>,
+<em>webinar:write:admin</em>, <em>recording:write:admin</em>. Luego, haga click en Done.</li>
+</ol>
 <br/>
 <strong>Atención</strong> :
 <br/>Zoom <em>NO ES</em> un software libre, y reglas específicas de protección de datos se aplican a este.