Skip to content

Commit

Permalink
Improve provider docs: Box & Zoom (#5166)
Browse files Browse the repository at this point in the history
* /docs/box.mdx - make the wording match box.com ui

* /docs/zoom.mdx - add instructions for zoom integration

* Run prettier

* Run "corepack yarn lint" in uppy.io

* /docs/Readme.md - better explanation of where to find the instructions
  • Loading branch information
lakesare authored May 16, 2024
1 parent f626ce7 commit 450d4a1
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 24 deletions.
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Uppy documentation

To build the documentation, see <https://github.com/transloadit/uppy.io>.
See instructions for linting this documentation and seeing this documentation in
the browser in <https://github.com/transloadit/uppy.io>.
3 changes: 1 addition & 2 deletions docs/sources/companion-plugins/box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ You can create a Box App on the

Things to note:

- Choose `Custom App` and select the `Standard OAuth 2.0 (User Authentication)`
app type.
- Choose `Custom App` and select the `User Authentication (OAuth 2.0)` app type.
- You must enable full write access, or you will get
[403 when downloading files](https://support.box.com/hc/en-us/community/posts/360049195613-403-error-while-file-download-API-Call)

Expand Down
71 changes: 50 additions & 21 deletions docs/sources/companion-plugins/zoom.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,11 @@ import UppyCdnExample from '/src/components/UppyCdnExample';

# Zoom

The `@uppy/zoom` plugin lets users import files from their
[Zoom](https://zoom.com) account.
The `@uppy/zoom` plugin lets users import cloud video recordings from their
[Zoom](https://zoom.com) account. Note that
[only licensed](https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0063923)
Zoom accounts can store their recordings in the cloud, so this functionality
will only be available to users with a paid Zoom account.

:::tip

Expand All @@ -21,8 +24,8 @@ The `@uppy/zoom` plugin lets users import files from their

## When should I use this?

When you want to let users import files from their [Zoom](https://zoom.com)
account.
When you want to let users import cloud video recordings from their
[Zoom](https://zoom.com) account.

A [Companion](/docs/companion) instance is required for the Zoom plugin to work.
Companion handles authentication with Zoom, downloads the files, and uploads
Expand Down Expand Up @@ -83,26 +86,52 @@ new Uppy()

### Use in Companion

Configure the Zoom key and secret. With the standalone Companion server, specify
environment variables:
To sign up for API keys, go through the following steps:

```shell
export COMPANION_ZOOM_KEY="Zoom API key"
export COMPANION_ZOOM_SECRET="Zoom API secret"
```
1. Sign up on [Zoom Marketplace](https://marketplace.zoom.us)

When using the Companion Node.js API, configure these options:
2. Go to [https://marketplace.zoom.us](https://marketplace.zoom.us). There will
be a dropdown in the header called “Develop”. From that dropdown, select
“Build app”.

```js
companion.app({
providerOptions: {
zoom: {
key: 'Zoom API key',
secret: 'Zoom API secret',
},
},
});
```
3. In the “Basic Information” tab, Zoom shows your new “Client ID” and “Client
Secret” - copy them.

With the standalone Companion server, specify environment variables:

```shell
export COMPANION_ZOOM_KEY="Zoom API key"
export COMPANION_ZOOM_SECRET="Zoom API secret"
```

When using the Companion Node.js API, configure these options:

```js
companion.app({
providerOptions: {
zoom: {
key: 'Zoom API key',
secret: 'Zoom API secret',
},
},
});
```

4. In the “Basic Information” tab, set “OAuth Redirect URL” input field to:

```
https://$YOUR_COMPANION_HOST_NAME/zoom/redirect
```

If you are using Transloadit hosted Companion:

```
https://api2.transloadit.com/companion/zoom/redirect
```

5. In the “Scopes” tab, add “cloud_recording:read:list_user_recordings” and
“user:read:user” scopes. If Zoom asks for further permissions when you
interact with your Zoom integration - add those too.

## API

Expand Down

0 comments on commit 450d4a1

Please sign in to comment.