Collection Api Requests

• How to begin

The first step is to retrieve the current API endpoint via this url :

https://rvolutiontoolsapi.azurewebsites.net/Swagger/GetApiEndPoint

/!\ This value usually changes only when a new major version of R_video is released.

I recommend you to only ask one time at the start of your app. /!\ 

Then you can use this endpoint for each of these requests.
All the requests below are GET requests and need as mandatory parameter your ApiKey.
Here an example with the Auth request :

https://rvolution-server-1-8.westeurope.cloudapp.azure.com/api/1.2/Auth?ApiKey=yourApikey&Email=api@rvideo.com&Password=123456

You can make some tests on the swagger page : Swagger page.

Don't forget to enter the Apikey provided before testing

• Auth

This is the first request to use in order to retrieve the AuthKey and the Collection id used in almost all others requests.
You need to provide the email and the password of the collection.
For your tests, you can use these credentials :

/!\ In you app, you will need to provide a way for the user to enter its own R_video credentials. /!\ 

• Menu

It will give you the content of the collection.

1 - How to ask the "main" menus :

First, fill the authkey and the collection id with the values given by the Auth request. They must be written as Guid.
Then specify the name of the menu : Movies, TVShows, CustomVideos or All. The case is important.
Select Menu as a Type.
The boolean IsParentalControlActive is set to false by default.

2 - How to ask the content of a group :

Depending of the context, the menu request can return item with the type CustomGroup, TVShow or TVShowSeason.
To get the content of these items, use the menu request with these parameters :

1 - Change the type to "Item". 

2 - Don't use the "ByName" field and fill "ById" with the id of the item retrieved in the result of the previous menu.

Here is an example with the Ant-man saga :

• Media

It will give you the details of a specific media (Movie, TVShowEpisode, Custom)

You need to give the Id of the item. Here is an example with the Daredevil movie :

• GetAnimatedBackground

If you have the property "AnimatedBackgroundId" in the result of an Item or Menu, you can download it.

The byte must be saved as mp4 file.

Here is an example with the Eternals movie

• GetSoundtrack

If you have the property "PersonalSoundtrackId" in the result of an Item or Menu, you can download it.

The byte must be saved as ogg file.

Else if you have the property "DefaultSoundtrackId" in the result of an Item or Menu, you can download it.

The better is to use the personal one if available.

Here is an example with the New mutants movie :

Get the personal Soundtracktrack :

Get the default Soundtrack :

• Picture

There are two type of picture : poster and the background.

The hash of the posters are often into the property "Icon" or "Poster". The hash of the backgrounds, into the "Background" property.

The byte must be saved as jpg file.

Here is an example with the background of Iron Man - Saga :