To work with specific individual video settings profiles

Collection /setting

To work with specific individual video settings profiles

GET, PUT and POST fields

The following fields can be GET'd via POST'd and PUT'd, all other fields will be denied.
Please note that not all players support or honour all settings.

Current


  • title - string: the name of the profile in the control panel| limit 50
  • allow_sharing - int: 0|1 | DEFAULT 0
  • allow_download - int: 0|1 | DEFAULT 0
  • lowest_quality_version - int: min 100 | DEFAULT 100
  • highest_quality_version - int: max 6000 | DEFAULT 1200
  • rolls - string: json string with config of pre and post rolls
  • logo_asset_id string: internal buto asset_id of logo
  • logo_destination_url string | where clicking on the logo will take you to
  • captions_default_on int: 0|1 captions display on by default | DEFAULT 0
  • ga_tracker_id string | Your Google Analytics Id
  • ga_tracker_domain string | your Google Analytics tracking domain
  • ga_library string | 'legacy' | 'universal' | DEFAULT 'legacy'
  • password_protected int: 0|1
  • password string | bycrpted hash of the password you wish to use. DO NOT store a raw password, that's just plain silly | limit 40
  • monetization string: json string with monetization profile on it
  • use_https_embed int: 0|1 captions on by default | DEFAULT 1

Legacy

The following settings are deemed legacy and mostly used for older players but can still be get/set via the api
- show_title_bar - int: 0|1 used by flash players | DEFAULT 0
- sharing_open_link_in_new_window int: 0|1 used by flash based players for sharing | DEFAULT 0
- show_other_videos int: 0|1 used by flash based players| DEFAULT 1
- is_auto_play int: 0|1 used by flash based players| DEFAULT 0
- pre_buffer int: 0|1 used by flash based players| DEFAULT 0
- show_controls int: 0|1 used by flash based players| DEFAULT 1
- autohide_controls int: 0|1 used by flash based players| DEFAULT 1
- show_rss int: 0|1 used by flash based players| DEFAULT 0
- monetization_id int: monetization_id used by flash players
- embed_wmode string: used by flash based players to determine z order | DEFAULT 'direct'
- use_javascript_api int: 0|1 used by flash based players| DEFAULT 1
- javascript_api_allowed_domains string: used by flash based players to determine which domains to allow scripting on

GET /setting/:id

to get a specific setting by ID

item value
Access system, user
Full url https://api.buto.tv/v2/setting/{id}
verb GET
params string:id:the specific setting id

Example

api_key=<your api key>
curl --include -X GET -u ${api_key}:x http://api.buto.tv/v2/setting/G4Pvw2g

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"id":"G4Pvw2g", ...}

POST /setting/:organisation_id

Create a brand new player settings profile

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

Data


  • organisation_id - string: the organisation_id you want to create a profile for : REQUIRED
item value
Access system, user
Full url https://api.buto.tv/v2/setting/{organisation_id}
verb POST
params string:organisation_id, The rest of the data should be POST'ed in as described above

Example

api_key=<your api key>
data="title=Chuck Norris Videos&ga_tracker_id=UA-Zid92x"
org_id="Bbgwg"
curl --include -X POST -u ${api_key}:x --data-binary ${data} --include https://api.buto.tv/v2/setting/${org_id}

returns

HTTP/1.1 201 OK
...
Content-Type: application/json

{"status":"Created","message":{"created":"G4Pvw2g"}}

PUT /setting/:setting_id

Update an existing setting profile

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

Data


  • setting - string: the setting_id you wish to update : REQUIRED
item value
Access system, user
Full url https://api.buto.tv/v2/setting/{setting_id}
verb PUT
params string:setting_id, The rest of the data should be sent in, as described above

Example

api_key=<your api key>
data="title=Jackie Chan Videos"
setting_id="G4Pvw2g"
curl --include -X PUT -u ${api_key}:x --data-binary ${data} --include https://api.buto.tv/v2/setting/${setting_id}

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"status":"OK","message":{"updated":"G4Pvw2g"}}

DELETE /setting/:setting_id

Remove existing setting profile

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

Data


  • setting - string: the setting_id you wish to update : REQUIRED
item value
Access system, user
Full url https://api.buto.tv/v2/setting/{setting_id}
verb DELETE
params string:setting_id

Example


api_key=<your api key> setting_id="G4Pvw2g" curl --include -X DELETE -u ${api_key}:x --include https://api.buto.tv/v2/setting/${setting_id}

returns

HTTP/1.1 200 OK
...
Content-Type: application/json

{"status":"OK","message":{"deleted":"G4Pvw2g"}}

Collection /setting/organisation

To work with video settings profiles for a particular organisation

GET /setting/organisation/:organisation_id

Get all the settings profiles for a particular organisation

Notes


  • This endpoint is protected with an API key, SYSTEM and USER ONLY

  • string:organisation_id The organisation_id you want the all settings for

item value
Access system, user
Full url https://api.buto.tv/v2/setting/organisation/${organisation_id}
verb GET
params string:organisation_id

Example


api_key=<your api key> organisation_id=<your org id> curl -u ${api_key}:x --include https://api.buto.tv/v2/setting/organisation/${organisation_id}

returns


HTTP/1.1 200 OK ... Content-Type: application/json { "s2yc8y4": { "allow_download": "0", "allow_sharing": "0", "autohide_controls": "1", "captions_default_on": "0", "created_by_user_id": "2t25d", "embed_wmode": "direct", "ga_library": "legacy", "ga_tracker_domain": "", "ga_tracker_id": "", "highest_quality_version": "3500", "is_auto_play": "0", "javascript_api_allowed_domains": "", "last_modified_by_user_id": "aWzQw", "logo_asset_id": "", "logo_destination_url": "", "lowest_quality_version": "100", "monetization": "", "monetization_id": "0", "organisation_id": "Bbgwg", "password": null, "password_protected": "0", "players": null, "post_roll_asset_id": "", "pre_buffer": "0", "pre_roll_asset_id": "", "pre_roll_id": "", "pre_roll_quality": "1200", "rolls": "{\"pre\":[\"CS19d\"],\"post\":[\"MnQrb\"],\"show_timer\":false}", "settings_id": "s2yc8y4", "sharing_open_link_in_new_window": "0", "show_controls": "1", "show_other_videos": "0", "show_rss": "0", "show_title_bar": "0", "time_created": "2015-03-24 10:07:49", "time_last_modified": "2015-04-13 12:15:49", "title": "5 - no pre and post rolls", "use_https_embed": "1", "use_javascript_api": "0" }, "s2yv9dp": { "allow_download": "0", ... "use_https_embed": "1", }, "s2zYDwt": {...} }