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 right in the editor, 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
Interaction with the API
The following entry points are used to interact with the API:
Production: https://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.
Methods
Projects
Create a project
PUT /mediaplatform/v1/project
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
Request parameters:
title | Project name (optional) |
Get a list of projects
GET /mediaplatform/v1/project
Get Project data by id
GET /mediaplatform/v1/project/coca_cola
Delete a project
DELETE /mediaplatform/v1/project/coca_cola
Users
Create a new user
PUT /mediaplatform/v1/project/coca_cola/user
Request parameters:
email* | The user's email address. If this user is not registered in Viqeo, he or she will be registered and assigned. If such user already exists, it will be assigned. ⚠️ Attention! Such user is prohibited from logging in the traditional way using the Viqeo authorisation page |
locale* | User locale (en) |
User authentication (Used to open a window with a Viqeo Editor)
POST /mediaplatform/v1/project/coca_cola/user/[email protected]/authenticate
In response to an authorisation request, a temporary Token will be given, which must be passed to a component of the story editor in the appropriate field.
Getting the list of project users
GET /mediaplatform/v1/project/coca_cola/user
Get user data by email
GET /mediaplatform/v1/project/coca_cola/user/[email protected]
Delete a user from a project
DELETE /mediaplatform/v1/project/coca_cola/user/[email protected]
Videos (Stories)
Stories are composed videos (Created with the Viqeo Studio Editor 2.0) in which it is possible to create content from slides (scenes), all videos (even just uploaded ones) open in the story editor, so here and further, all video content is meant are stories.
⚠️ Viqeo Studio Editor 1.0 (Which is used in Viqeo Studio when 'Upload video' is pressed, is not supported in the Media Platform API. To use direct upload in the app you can choose an appropriate template for Viqeo Studio Editor 2.0.
Create a video (story)
PUT /mediaplatform/v1/project/coca_cola/story
Request parameters:
id* | The unique identifier of the created video (story) is an arbitrary string (e.g. 1, 42, coca_cola_lift_campaign_17) |
title | Video (story) title (optional) |
Edit a story
POST /mediaplatform/v1/project/coca_cola/story/42
Request parameters:
title | Project name (optional) |
Get a list of videos (stories) in a project
GET /mediaplatform/v1/project/coca_cola/story
Get Story data by id
GET /mediaplatform/v1/project/coca_cola/story/42
Delete a video (story)
DELETE /mediaplatform/v1/project/coca_cola/story/42