Glossary
This page defines the terms of this guide.
Parties and accounts
| Term |
Definition |
Code name |
| MEGOGO |
The video service that supplies the content and the API. |
— |
| partner |
A company that shows MEGOGO content in its application and bills its users. |
— |
| partner application |
An application of the partner (web, mobile, Smart TV, set-top box) that shows MEGOGO content. In the pages: "your application". |
— |
| user |
A person who watches MEGOGO content in the partner application. |
— |
| partner ID |
The text ID that MEGOGO gives to the partner, for example testprod_ua. |
partnerId, partner_key |
| partner number |
The number of the partner account. The same value as partner_id in /configuration and in the URL of the partner feed. |
partner_id (configuration) |
| test partner ID |
A partner ID on production for tests, for example testprod_ua. |
partnerId |
| user identifier |
The ID of the user in the partner system: any string up to 255 characters, for example a contract number, a login or a hash. Use the same value in all requests for the user. |
identifier, userId, isdn |
| MEGOGO user ID |
The internal ID of the user in MEGOGO. |
uid, user_id |
Credentials and security
| Term |
Definition |
Code name |
| key pair |
A public key and a private key. MEGOGO gives one key pair for each platform. In the pages: "key". |
— |
| public key |
The part of the key pair that is at the end of each signature. |
public_key |
| private key |
The secret part of the key pair. Keep it on your server. |
private_key |
| salt |
A secret value that you use to calculate the authorization token. Keep it on your server. |
salt |
| signature |
The value that proves that the request comes from the partner. |
sign |
| authorization token |
The MD5 hash of the user identifier, the partner ID and the salt. |
token |
| access token |
The value that MEGOGO gives after the user authorization. It is valid for about 6 hours. |
access_token |
| remember-me token |
A long-term token (about 5 years) that you send to /auth/refresh to get a new access token. |
remember_me_token, rememberme_token |
| IP list |
The IP addresses of the partner servers that can send the Billing API requests that manage services. |
— |
Content
| Term |
Definition |
Code name |
| object |
One item of the catalog with an ID: a film, a series or a 4K version. The same ID is in the XML feed and in the Content API. |
object, id |
| video |
An object or an episode that has a stream: a film, an episode or a trailer. |
video_id |
| film |
A video that is not a series. |
item_type: video |
| series |
An object that contains seasons. |
item_type: series, is_series |
| season |
A part of a series that contains episodes. |
season, season_list |
| episode |
One video in a season. |
seria, item_type: episode |
| trailer |
A short free video that shows a part of a film or a series. |
trailer_id, trailer |
| 4K version |
A separate object with the 4K (UHD) quality of a film. Its title usually ends with "UHD" or "UHD HDR". |
quality value="UHD", is_uhd |
| category |
A main group of videos, for example Movies or Series. |
category_id |
| genre |
A group of videos by subject, for example Comedy. |
genre |
| collection |
A list of videos that MEGOGO editors make. MEGOGO makes collections for some partners on request. |
collection |
| XML feed |
The daily XML file with all objects that the partner can show. In the pages also "your feed". |
all_mgg.xml |
| region feed |
The XML feed of a region without the partner number. Do not use it, except for Poland. |
{region}/all_mgg.xml |
| contract ID |
The ID of the rights contract of an object. |
contract_id |
| page token |
The next_page value from a list response. Send it as page to get the next page. |
next_page, page |
Monetization
| Term |
Definition |
Code name |
| delivery rule |
How a user can get a video: SVOD, AdVOD, FVOD, TVOD or DTO. |
delivery_rules, vod_type |
| partner subscription |
The set of videos that a partner sells as a subscription: SVOD, AdVOD and FVOD videos. The partner controls the access of its users. |
— |
| SVOD |
Access with a subscription. |
svod |
| AdVOD |
A video that is free in MEGOGO applications. In a partner application, it is part of the partner subscription. The Content API gives the stream without a user. |
advod |
| FVOD |
The same as AdVOD for a partner application. |
fvod |
| TVOD |
Rent: the purchase of one video for a limited period. |
tvod |
| rent period |
The period of a TVOD purchase. It starts at the first /stream response with src. |
period, dateFinish |
| DTO |
The purchase of one video without a time limit. Show it as "forever". |
dto |
| service |
A product that MEGOGO records for a user: a subscription or a single purchase. MEGOGO gives the service IDs. |
serviceId |
| tariff |
One price, period and quality of a service. |
tariff_id |
| offer |
A TVOD or DTO service of a video in purchase_info, with one or more tariffs. |
purchase_info.tvod, purchase_info.dto |
| subscription |
An SVOD service of a user. |
subscription |
| automatic renewal |
A renewal mode: MEGOGO renews the subscription each period until the partner sends unsubscribe. |
— |
| renewal by the partner |
A renewal mode: the partner renews the subscription with subscribe. Each request adds one period. |
— |
Playback
| Term |
Definition |
Code name |
| stream URL |
The URL of the manifest that the player uses. |
src |
| manifest |
The HLS (.m3u8), DASH (.mpd) or MSS (Manifest) file that lists the variants of the stream. |
— |
| stream settings |
The settings of a key: the protocol, the DRM system and 4K. MEGOGO sets them. |
stream_type, drm_type |
| quality |
The video resolution that the user sees, for example "High (720)". One item of bitrates is one quality. |
bitrates, bitrate |
| audio track |
One audio language or version of the video, for example "Ukrainian with audio description". |
audio_tracks |
| forced subtitles |
Subtitles that the user cannot switch off with a specified audio track. |
require_subtitles, is_disableable: false, preselect |
| DRM |
A system that encrypts the stream: Widevine, PlayReady or FairPlay. |
drm_type, protection |
| license server |
The DRM server that gives the license to the player. |
license_server |
| restriction |
The reason why a user cannot watch a video. |
restrictions |
| geo |
The country that MEGOGO finds for the request. |
geo |