Using the Media Editor API, you can call the Viqeo Editor (Viqeo Studio) from third-party products and applications. So your users can work with Viqeo Editor directly from your user interface without going to the Viqeo personal account. After video is published your application will receive a ready-to-use code that will create customised player with created video. With different presets which can be used during Viqeo Editor launch, you can activate various scenarios — from simple video upload, to screen and camera recordings or interactive forms and surveys.

Basic concepts

Media platform is an entity that identifies and groups child entities created using a documented API
The owner of the media platform is a pre-created user in Video, on whose behalf interaction with the created elements (projects, stories) takes place
A project is an entity that unites the created stories into a single group, and allows you to create or assign additional users who will have access to the project.
The story is a created video (sequence of slides) that can be created in Viqeo Editor

How to install Media Editor library

Here you can find a file with the instructions

Interaction with the API

The following entry points are used to interact with the API:

Production: https://api.viqeo.tv/media-platform/v1/
Stage: https://stage.api.viqeo.tv/media-platform/v1/

Interaction is carried out using HTTP methods GET, POST, PUT, PATCH, DELETE. The body for the POST, PUT, PATCH methods should be formatted as a json data structure and have the appropriate value for the Content-Type header. The response to the operation is also sent in the form of a JSON structure.

Authorisation

Authorisation to use the Media Platform API is carried out using a token previously received from the Viqeo administrator. The token should be transmitted at each interaction with the API using Bearer authorization (HTTP header Authorization: Bearer TOKEN). In case of an incorrect token, or an attempt to interact using an unauthorized IP address, a 403 error will occur with an indication of the reason.

API Response structure

Successful response:

A typical successful response with data is a structure:

Errors:

A typical error turns into a standard structure:

This structure is typical for all errors that occur when working with the API.

Methods of Interaction

Projects

Create a project

PUT /mediaplatform/v1/project

CODE

Request parameters:

id*	The unique identifier of the project being created is an arbitrary string (e.g. 1, 42, coca_cola)
title	Project name (optional)

Edit a project

POST  /mediaplatform/v1/project/coca_cola

CODE

Request parameters:

title

Project name (optional)

Get a list of projects

GET /mediaplatform/v1/project

CODE

Get Project data by id

GET /mediaplatform/v1/project/coca_cola

CODE

Delete a project

DELETE /mediaplatform/v1/project/coca_cola

CODE

Users

Create new user

PUT /mediaplatform/v1/project/coca_cola/user

CODE

Request parameters:

email*

The user's email address. If this user is not registered in Video, he or she will be registered and assigned. If such a user already exists, he will be assigned.

Attention! Such a user is prohibited from logging in in the traditional way using the Viqeo authorization page

locale*

User locale (en)

User authentification (Used to open a window with Viqeo Editor)

POST  /mediaplatform/v1/project/coca_cola/user/email@viqeo.tv/authenticate

CODE

In response to the authorization request, a temporary Token is given, which must be passed to the component of the story editor in the appropriate field.

Getting a list of project users

GET /mediaplatform/v1/project/coca_cola/user

CODE

Get user data by email

GET /mediaplatform/v1/project/coca_cola/user/email@viqeo.tv

CODE

Delete a user from a project

DELETE /mediaplatform/v1/project/coca_cola/user/email@viqeo.tv

CODE

Video (Story)

Stories are created videos in which it is possible to create content from slides (in Version 2.0 of the editor), all videos (even just upload-able ones) open the story editor, so here and further, video content is meant by stories.

Create a video (story)

PUT /mediaplatform/v1/project/coca_cola/story

CODE

Request parameters:

id*	The unique identifier of the created video (story) is an arbitrary string (e.g. 1, 42, coca_cola_lift_camplagn_17)
title	Video (story) title (optional)

Edit a story

POST  /mediaplatform/v1/project/coca_cola/story/42

CODE

Request parameters:

title

Project name (optional)

Get a list of videos (stories) in a project

GET /mediaplatform/v1/project/coca_cola/story

CODE

Get Story data by id

GET /mediaplatform/v1/project/coca_cola/story/42

CODE

Delete a video (story)

DELETE /mediaplatform/v1/project/coca_cola/story/42

CODE