Control Panel — API documentation

Please provide a valid credit card using the credit card form on the billing page. Update Card Details

Players

Player object

The Player object controls the various settings for generating embed code. Once created the Player will contain an UUID that is used to as the identifier for the embed endpoint.

player_version can be a version number, such as 0.3.8 which will cause the version of the player being loaded to never change, or a string such as stable or latest. Stable will always point to the latest well tested version we carry. Latest will point to the latest version, regardless of any issues it may have. A good system is to point your production players at stable, but point any testing or admin players at latest, so you get a heads up of any changes.

Descriptions

id Integer Autogenerated

Unique identifier for this object.

Sample value:N/A

cdn_id Integer Autogenerated

The CDN ID that owns this object.

Sample value:8123

uuid String Autogenerated

Universally Unique Identifier

Sample value:ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

name String Normal Required

Player Name

May only contain alpha numerical characters, dashes (-), underscores (_), and spaces( )

Sample value:My Player Name

app String Normal

Application Name

The application name must begin with "username-"

Sample value:username-origin

stream String Normal

Stream Name

May only contain alpha numerical characters, dashes (-), and underscores (_)

Sample value:mystreamname

Only for: embed_type: live

play_path String Normal

Path to the Video-on-Demand file

Must begin with "sestore(#)/username/" and may only contain alpha numeric characters, dashes (-), underscores (_), slashes (/), and decimals (.)

Sample value:sestore1/username/play_this_file.mp4

is_smil Boolean Normal

Multibitrate stream or file

Boolean

Default:

Sample value:false

embed_type String Normal Required

Player Type

Enum:live, vod, vod-playlist

Sample value:vod

protocol String Normal Required

Player Protocol

Enum:auto, hls, rtmp, dash

Sample value:hls

player String Normal Required

Player software to use

Enum:clappr, jwplayer

Sample value:clappr

player_version String Normal Required

Player Version

May only contain alpha numerical characters and decimals (.)

Default:stable

Sample value:0.3.8

width Integer Normal Required

Player Width

Integer

Default:1280

Sample value:1280

height Integer Normal Required

Player Height

Integer

Default:720

Sample value:720

aspect_ratio String Normal

Player Aspect Ratio

String

Sample value:16/9

watermark_image String Normal

Watermark Image

RFC 2396 compliant URL

Sample value:https://my.domain.com/watermark.jpg

watermark_position String Normal

Watermark Position on the Player

Enum:bottom-left, bottom-right, top-left, top-right

Default:top-left

Sample value:bottom-right

watermark_url String Normal

Watermark Link URL

RFC 2396 compliant URL

Sample value:https://my.domain.com/

poster_url String Normal

Poster Image URL

String

Sample value:https://my.domain.com/poster.jpg

ga_key String Normal

Google Analytics

String

Sample value:UA-123456-1

vast_url String Normal

Vast URL

RFC 2396 compliant URL

Sample value:https://path/to/vast.xml

domain_lock String Normal

[Not Implemented]Locks the player to one or more domains

RFC 2396 compliant URL

Sample value:

limit_resolution Boolean Normal

Limits the Resolution to the height and width provided

Boolean

Default:

Sample value:true

auto_play Boolean Normal

Start playing when page loads

Boolean

Default:

Sample value:false

sevu Boolean Normal

SEVU Enabled

Boolean

Default:

Sample value:false

responsive Boolean Normal

Enables response sizing for the Player

Boolean

Default:

Sample value:false

bif Boolean Normal

Enables BIF usage for the Player

Boolean

Default:

Sample value:false

last_updated String Autogenerated

Date and time of last update

Sample value:2019-12-17 12:14:00

option:related String

Include related object in results

Default:none

Sample value:embeds

None

Related endpoints

Embeds

Embed players on a website

Examples

Get the Players object with id ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7.

Example URL

https://api.scaleengine.net/v2/players/ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

Example cURL

curl --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/players/ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

Example request body

None

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "uuid": "ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7",
    "name": "My Player Name",
    "app": "username-origin",
    "stream": "mystreamname",
    "play_path": "sestore1/username/play_this_file.mp4",
    "is_smil": "false",
    "embed_type": "vod",
    "protocol": "hls",
    "player": "clappr",
    "player_version": "0.3.8",
    "width": 1280,
    "height": 720,
    "aspect_ratio": "16/9",
    "watermark_image": "https://my.domain.com/watermark.jpg",
    "watermark_position": "bottom-right",
    "watermark_url": "https://my.domain.com/",
    "poster_url": "https://my.domain.com/poster.jpg",
    "ga_key": "UA-123456-1",
    "vast_url": "https://path/to/vast.xml",
    "domain_lock": "",
    "limit_resolution": "true",
    "auto_play": "false",
    "sevu": "false",
    "responsive": "false",
    "bif": "false",
    "last_updated": "2019-12-17 12:14:00"
}

Create a new Players object.

Example URL

https://api.scaleengine.net/v2/players

Example cURL

curl -X PUT --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/players

Example request body

{
    "name": "My Player Name",
    "app": "username-origin",
    "play_path": "sestore1/username/play_this_file.mp4",
    "is_smil": "false",
    "embed_type": "vod",
    "protocol": "hls",
    "player": "clappr",
    "player_version": "0.3.8",
    "width": 1280,
    "height": 720,
    "aspect_ratio": "16/9",
    "watermark_image": "https://my.domain.com/watermark.jpg",
    "watermark_position": "bottom-right",
    "watermark_url": "https://my.domain.com/",
    "poster_url": "https://my.domain.com/poster.jpg",
    "ga_key": "UA-123456-1",
    "vast_url": "https://path/to/vast.xml",
    "domain_lock": "",
    "limit_resolution": "true",
    "auto_play": "false",
    "sevu": "false",
    "responsive": "false",
    "bif": "false"
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "uuid": "ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7",
    "name": "My Player Name",
    "app": "username-origin",
    "stream": "mystreamname",
    "play_path": "sestore1/username/play_this_file.mp4",
    "is_smil": "false",
    "embed_type": "vod",
    "protocol": "hls",
    "player": "clappr",
    "player_version": "0.3.8",
    "width": 1280,
    "height": 720,
    "aspect_ratio": "16/9",
    "watermark_image": "https://my.domain.com/watermark.jpg",
    "watermark_position": "bottom-right",
    "watermark_url": "https://my.domain.com/",
    "poster_url": "https://my.domain.com/poster.jpg",
    "ga_key": "UA-123456-1",
    "vast_url": "https://path/to/vast.xml",
    "domain_lock": "",
    "limit_resolution": "true",
    "auto_play": "false",
    "sevu": "false",
    "responsive": "false",
    "bif": "false",
    "last_updated": "2019-12-17 12:14:00"
}

Update the Players object with id ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7.

Example URL

https://api.scaleengine.net/v2/players/ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

Example cURL

curl -X POST --data-binary @/path/to/request/body --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/players/ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

Example request body

{
    "name": "My Player Name",
    "app": "username-origin",
    "play_path": "sestore1/username/play_this_file.mp4",
    "is_smil": "false",
    "embed_type": "vod",
    "protocol": "hls",
    "player": "clappr",
    "player_version": "0.3.8",
    "width": 1280,
    "height": 720,
    "aspect_ratio": "16/9",
    "watermark_image": "https://my.domain.com/watermark.jpg",
    "watermark_position": "bottom-right",
    "watermark_url": "https://my.domain.com/",
    "poster_url": "https://my.domain.com/poster.jpg",
    "ga_key": "UA-123456-1",
    "vast_url": "https://path/to/vast.xml",
    "domain_lock": "",
    "limit_resolution": "true",
    "auto_play": "false",
    "sevu": "false",
    "responsive": "false",
    "bif": "false"
}

Example response data

{
    "id": "N/A",
    "cdn_id": "8123",
    "uuid": "ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7",
    "name": "My Player Name",
    "app": "username-origin",
    "stream": "mystreamname",
    "play_path": "sestore1/username/play_this_file.mp4",
    "is_smil": "false",
    "embed_type": "vod",
    "protocol": "hls",
    "player": "clappr",
    "player_version": "0.3.8",
    "width": 1280,
    "height": 720,
    "aspect_ratio": "16/9",
    "watermark_image": "https://my.domain.com/watermark.jpg",
    "watermark_position": "bottom-right",
    "watermark_url": "https://my.domain.com/",
    "poster_url": "https://my.domain.com/poster.jpg",
    "ga_key": "UA-123456-1",
    "vast_url": "https://path/to/vast.xml",
    "domain_lock": "",
    "limit_resolution": "true",
    "auto_play": "false",
    "sevu": "false",
    "responsive": "false",
    "bif": "false",
    "last_updated": "2019-12-17 12:14:00"
}

Delete the Players object with id ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7.

Example URL

https://api.scaleengine.net/v2/players/ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

Example cURL

curl -X DELETE --user 158:8fc8c48da81e6a2a06a9556379bf798af508dc0792497c678b4c3532ba8b637f https://api.scaleengine.net/v2/players/ed6c1e8b-4c13-41dc-b065-34cbffcdc1c7

Example request body


			
			

Example response data

None

Errors

ACCESS_VIOLATION

You do not have access to modify this field

REQUIRED_FIELD

Missing one or more required fields

TYPE_MISMATCH

Data type does not conform to required field type

MAX_LENGTH_EXCEEDED

The value exceeded maximum length allowed

PLAYER_NAME_INVALID

May only contain alpha numerical characters, dashes (-), underscores (_), and spaces( )

APP_INVALID

The application name must begin with "username-"

ONLY_FOR

This field is only valid when used with another field

STREAM_INVALID

May only contain alpha numerical characters, dashes (-), and underscores (_)

PLAY_PATH_INVALID

Must begin with "sestore(#)/username/" and may only contain alpha numeric characters, dashes (-), underscores (_), slashes (/), and decimals (.)

INVALID_ENUM

The value must match one of the predefined values

PLAYER_VERSION_INVALID

May only contain alpha numerical characters and decimals (.)

URL_INVALID

RFC 2396 compliant URL