Platform API (2)

Download OpenAPI specification:Download

Access Platform API for create, update, list and delete Videos, & Categories.

We have a newer API version available here and support Livestreaming and Live Sources as well.

Authentication

You'll need both API key and site/workspace id in most of the API call. You can find your API key and siteid (workspaceid) under workspace/settings.

Requesting the API

Base url for the API is:

  https://api.flowplayer.com/ovp/

Depending on what type of request you want to make you will have to add the API key differently. In get-endpoints the API key is added as an query-param named api-key and for post, put and delete it's added in the request body.

For example, a get video is requested as below:

  https://api.flowplayer.com/ovp/web/video/v2/{video_id}.json?api_key={your_api_key}

Content Type

The format, XML or Json, is determined by both Content-Type-header and the end of the request path. For Json-requests you'll need to end the request with .json and for XML with .xml.

Example of a Create video request with Json:

  --header: Content-Type: application/json

  https://api.flowplayer.com/ovp/web/video/v2/create.json

Example of a Create video request with XML:

  --header: Content-Type: application/xml

  https://api.flowplayer.com/ovp/web/video/v2/create.xml

Category

Get Category

This private request returns data for a single category.

path Parameters
id
required
string
Example: your_category_id

Id of the category

query Parameters
api_key
required
string
Example: api_key=your_api_key

API-key for the workspace which the category belongs to.

Responses

Response samples

Content type
{
  • "id": "category_id",
  • "name": "category name",
  • "description": "category description",
  • "hidden": false,
  • "parentid": "1743542c-2fa6-4de3-b902-2c67253a7be7",
  • "noads": true
}

Create Category

Creates a category and returns data for the created category.

Request Body schema: application/json
api_key
required
string

API-key for the site.

siteid
required
string

Site id for the site which the category should be added to.

name
required
string
description
string

The category descript