To integrate an Epiphan device with the Video Platform, admins need to provide an access token that has a minimum set of permissions enabled. Follow the steps below to learn how to create an API token with these permissions enabled.
Creating the API Token for Your Epiphan Integration
- Log in to the Video Platform as an admin.
- Select the Admin Panel from the Main Menu.
- Select the Platform tab.
- Select the API tab.
- Click Generate for a new API token.
- Once generated, click Settings.
- Ensure the API token has the options listed below checked.
-
Options under User Object Model:
-
Retrieve All Users / Add a User
-
Retrieve / Update / Delete a Single User
-
Retrieve all Groups a User is Enrolled in
-
Retrieve Group Names By User
-
-
Options under Group Object Model:
-
Retrieve / Create a Group for the Organization
-
Update / Delete / Retrieve a Single Group
-
Retrieve Group Details
-
Add Group Members
-
-
Options under Course Object Model:
- Retrieve Course Details
- Retrieve Course Details
-
Options under Device Object Model:
-
Retrieve / Update Devices
-
Register / Delete Device
-
Retrieve All Schedules for a Device
-
Create / Delete / Update Sessions
-
Create / Retrieve Capture Profiles
-
Start / Stop Recording Sessions
-
Update / Delete a Hub Profile
-
Play / Pause Recording Sessions
-
Retrieve Audio / Image and URLs
-
Pause / Resume Live Stream Playback
-
Extend / Stop Third-Party Device Session
- Send Software Capture Status
-
Get / Delete Schedules
-
Update / Delete Third-Party Profiles
-
Return YuJa Profile ID Based on External ID
-
Other
-
-
Options under Media Object Model:
- Upload Video Details
- Generate Link to Upload Recordings
- Start Video Processing for S3 URLs
- Add Multi-Stream Video
-
Options under User Object Model:
- Once the options above have been checked, click Save.
- Click Save again for the API page. You can now copy and use the token for your Epiphan integration with the Video Platform.