Management API
The Management API allows you to integrate Vindral into your systems. With the API you can you can mange your channels and channel groups. You can also get lots of information such as:
- Transcoding profiles
- User profile
- Ingest information for a channel
- Status for all channels, including live status, current viewers, current ingress bitrate and current egress bitrate.
- Analytics data such as amount of viewers and sessions, total egress and ingress bytes, viewer device information and much more.
Read the API reference for in-depth information on what you can do with the API or test it with swagger here.
API Keys
To access the API you need an account in the Vindral Portal and then create an API Key. The API Key used for authentication is tied to a user and shares the permissions of that user which is configured in the Vindral Portal. In addition to the user level permissions each API key has a scope of either read-only or read-write.
Create an API Key
- Log in to the Vindral Portal.
- Go to
Your profile. - Click on the
API Keystab. - Click on the
Newbutton. - Enter a name for the API Key and optional notes.
- Select the scope of the API Key.
- Click on the
Createbutton. - Copy the API Key and store it in a safe place, it will not be shown again.
Permissions
Your user can have one of three roles in the Vindral Portal: Administrator, Channel Manager or User. The role determines what permissions you have in the Vindral Portal and what permissions your API Key will have. You can see what role you have in organizations on you user profile page. If your user is a member of multiple organizations the API keys will have the permissions to all organizations.
The tables below specify the set of permissions associated with each role. For API Keys with read-only scope Create/Update/Delete is always forbidden.
Administrator
| Entity | Read | Create | Update | Delete |
|---|---|---|---|---|
| Channel | Yes | Yes | Yes | Yes |
| Channel Group | Yes | Yes | Yes | Yes |
| Transcoding Profiles | Yes | No | No | No |
| Profile | Yes | - | - | - |
| Ingest | Yes | - | - | - |
| Status | Yes | - | - | - |
| Analytics | Yes | - | - | - |
Channel Manager
| Entity | Read | Create | Update | Delete |
|---|---|---|---|---|
| Channel | Yes | Yes | Yes | Yes |
| Channel Group | Yes | Yes | Yes | Yes |
| Transcoding Profiles | Yes | No | No | No |
| Profile | Yes | - | - | - |
| Ingest | Yes | - | - | - |
| Status | Yes | - | - | - |
| Analytics | Yes | - | - | - |
User
| Entity | Read | Create | Update | Delete |
|---|---|---|---|---|
| Channel | Yes | No | No | No |
| Channel Group | Yes | No | No | No |
| Transcoding Profiles | Yes | No | No | No |
| Profile | Yes | - | - | - |
| Ingest | Yes | - | - | - |
| Status | Yes | - | - | - |
| Analytics | Yes | - | - | - |