settings(各種設定) – millvi

共通の出力要素
GET : /settings/get_external_block　（国外アクセス設定を取得）
POST : /settings/set_external_block　（国外アクセスの設定）
GET : /settings/list_domain_block　（ドメイン指定の一覧を取得）
POST : /settings/set_domain_block　（ドメイン指定を追加/編集）
POST : /settings/delete_domain_block　（ドメイン指定を削除）
GET : /settings/list_allowed_ip　（IPアドレス指定の一覧を取得）
POST : /settings/set_allowed_ip　（IPアドレス指定を追加/編集）
POST : /settings/delete_allowed_ip　（IPアドレス指定を削除）
GET : /settings/list_metatag　（メタタグの一覧を取得）
POST : /settings/add_metatag　（メタタグを追加）
POST : /settings/delete_metatag　（メタタグの削除）
GET : /settings/get_youtube　（YouTubeの情報を取得）
GET : /settings/get_youtube_auth_url　（YouTube連携用Googleアカウント認証URLを取得）
POST : /settings/deauthorize_youtube_api　（Youtube連携用Googleアカウントの認証を解除）
GET : /settings/get_mail　（メール情報を取得）
POST : /settings/set_mail　（メール情報を設定）
POST : /settings/change_password　（パスワードを変更）
GET : /settings/list_recipe　（レシピ一覧を取得）
POST : /settings/set_default_recipe　（デフォルトのレシピを設定）
GET : /settings/get_plconfig　（PC再生時の初期画質設定を取得）
POST : /settings/set_plconfig　（PC再生時の初期画質設定を設定）
POST : /settings/add_recipe　（トランスコード設定にレシピを追加）
POST : /settings/delete_recipe　（トランスコード設定からレシピを削除。
ただし一度でも使用したレシピは削除できません）
POST : /settings/modify_recipe　（トランスコード設定からレシピを編集。
ただし一度でも使用したレシピは編集できません）
GET : /settings/get_recipe_template_config　（レシピのテンプレートを取得）
GET : /settings/get_transferconfig　（配信設定情報を取得）
GET : /settings/get_deliverymatrix　（詳細な配信設定情報を取得）
GET : /settings/get_playbackrateconfig　（倍速の設定値を取得）
POST : /settings/set_playbackrateconfig　（倍速の設定値を追加）
POST : /settings/create_unique_accesskey　（accesskeyを発行）

共通の出力要素

playbackrateconfig形式(JSON)

名前(要素名)	値(要素の内容)
rate	倍速の設定値(JSON形式) 例:`{"rate":[0.5, 1, 1.5, 2]}`(JSON)

plconfig形式(JSON)

名前(要素名)	値(要素の内容)
id_recipe	エンコード設定のID /settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。動画登録には動画用の、音声登録には音声用のレシピを設定頂く必要があります。
default	初期選択される画質です

例:

{"1":{"default":0},"2":{"default":1},"3":{"default":1},"4":{"default":1},"5":{"default":1},"1001":{"default": 0}}

(JSON)

`GET` : `/settings/get_external_block`

概要

国外アクセス設定を取得。

カテゴリ

設定

レポート

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

レスポンス内容

名前(要素名)	値
type	タイプ・`0` : 許可・`1` : 全ての埋め込みコードに対して禁止・`2` : 個別の埋め込みコードに対して禁止
denytags	埋め込み禁止コード
tag	タグ
id_tag	埋め込みコードID
name	埋め込みコード名
blocked	ブロック・`0` : 許可・`1` : 禁止

ステータス

有効

`POST` : `/settings/set_external_block`

概要

国外アクセスの設定。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
type (required)	タイプ・`0` : なし・`1` : 全ての埋め込みコードに対して禁止・`2` : 個別の埋め込みコードに対して禁止
denytags	`type=2`の場合の、禁止する埋め込みコードのIDをカンマ区切りで指定

ステータス

有効

`GET` : `/settings/list_domain_block`

概要

ドメイン指定の一覧を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
mode (required)	モード・`exists` : 登録済みの埋め込みコード一覧・`noexists` : 登録されてない埋め込みコード一覧

出力

レスポンス内容

名前(要素名)	値
tag	埋め込みコード
id_tag	埋め込みコードID `0`で「全ての埋め込みコード」
name	埋め込みコード名
domain	指定されたドメインカンマ区切りのドメイン

ステータス

有効

`POST` : `/settings/set_domain_block`

概要

ドメイン指定を追加/編集

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_tag (required)	埋め込みコードID
domain (required)	アクセス禁止ドメインカンマ区切りで複数指定可能

説明

指定されたid_tagが登録されていなかったら追加、されていたら編集。

ステータス

有効

`POST` : `/settings/delete_domain_block`

概要

ドメイン指定を削除。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_tag (required)	埋め込みコードID `0`で全ての埋め込みコード削除

ステータス

有効

`GET` : `/settings/list_allowed_ip`

概要

IPアドレス指定の一覧を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
mode (required)	モード・`exists` : 登録済みの埋め込みコード一覧・`noexists` : 登録されてない埋め込みコード一覧

出力

名前(要素名)	値
tag	埋め込みコード
id_tag	埋め込みコードID `0`で「全ての埋め込みコード」
name	埋め込みコード名
ip	指定されたIPアドレスカンマ区切りのIPアドレス

ステータス

有効

`POST` : `/settings/set_allowed_ip`

概要

IPアドレス指定を追加/編集。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_tag (required)	埋め込みコードID
ip (required)	カンマ区切りのIPアドレス

説明

指定されたid_tagが登録されていなかったら追加、されていたら編集。
指定できるIPアドレスの形式はIPv4（xxx.xxx.xxx.xxx）。

ステータス

有効

`POST` : `/settings/delete_allowed_ip`

概要

IPアドレス指定を削除。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_tag (required)	埋め込みコードID

ステータス

有効

`GET` : `/settings/list_metatag`

概要

メタタグの一覧を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

レスポンス内容

名前(要素名)	値
metatag	メタタグ名(※リスト)

ステータス

有効

`POST` : `/settings/add_metatag`

概要

メタタグを追加。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
metatag (required)	追加するメタタグ名

ステータス

有効

`POST` : `/settings/delete_metatag`

概要

メタタグの削除。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
metatag (required)	削除するメタタグ名

ステータス

有効

`GET` : `/settings/get_youtube`

概要

YouTubeの情報を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

レスポンス内容

名前(要素名)	値
authorized	アカウント認証・`0` : 無効・`1` : 有効
acount	YouTubeアカウント(リスト)
userid	ユーザーID

ステータス

有効

`GET` : `/settings/get_youtube_auth_url`

概要

YouTube連携用Googleアカウント認証URLを取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
redirect_uri (required)	認証後にリダイレクトされるURI

出力

レスポンス内容

名前(要素名)	値
url	Googleアカウント認証URL

ステータス

有効

`POST` : `/settings/deauthorize_youtube_api`

概要

Youtube連携用Googleアカウントの認証を解除

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

ステータス

有効

`GET` : `/settings/get_mail`

概要

メール情報を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

レスポンス内容

名前(要素名)	値
enable_mail	メールが有効か・`0` : 無効・`1` : 有効
mail_address	メールアドレス
mail_encode	変換完了時通知・`0` : 無効・`1` : 有効
mail_keitai	携帯用変換完了時通知・`0` : 無効・`1` : 有効
mail_youtube	YouTube投稿時通知・`0` : 無効・`1` : 有効
mail_locked	アカウントロック時通知・`0` : 無効・`1` : 有効
mail_error	エラー時通知・`0` : 無効・`1` : 有効

ステータス

有効

`POST` : `/settings/set_mail`

概要

メール情報を設定。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
mail_address (required)	メールアドレス
enable_mail (required)	メールが有効か・`0` : 無効・`1` : 有効
mail_encode (required)	変換完了時通知・`0` : 無効・`1` : 有効
mail_error (required)	エラー時通知・`0` : 無効・`1` : 有効
mail_locked (required)	アカウントロックの通知・`0` : 無効・`1` : 有効

ステータス

有効

`POST` : `/settings/change_password`

概要

パスワードを変更。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
password_current (required)	現在のパスワード
password_new (required)	新しいパスワード

ステータス

有効

`GET` : `/settings/list_recipe`

概要

レシピ一覧を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
type	タイプ・`video` : 動画・`audio` : 音声

出力

クエリー

名前(要素名)	値
recipe	リスト
id_recipe	エンコード設定のID
id_host	ホストのID
name	レシピ名
default	デフォルト設定・`0` : それ以外・`1` : デフォルト
config	リスト
format	フォーマット
codec	映像コーデック
bitrate	映像ビットレート
width	幅
height	高さ
fps	フレームレート
audiocodec	音声コーデック
audiobitrate	音声ビットレート
pixel	解像度

ステータス

有効

`POST` : `/settings/set_default_recipe`

概要

デフォルトのレシピを設定。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_recipe (required)	エンコード設定のID settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。動画登録には動画用の、音声登録には音声用のレシピを設定頂く必要があります。
type	タイプ・`video` : 動画・`audio` : 音声

ステータス

有効

`GET` : `/settings/get_plconfig`

概要

PC再生時の初期画質設定を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

クエリー

名前(要素名)	値
plconfig	PLCONFIG
id_recipe	エンコード設定のID settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
default	初期選択される画質・`0` : 最低画質・`index` : 最高画質のindexはレシピによって変わります

ステータス

有効

`POST` : `/settings/set_plconfig`

概要

PC再生時の初期画質設定を設定。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
plconfig (required)	PLCONFIG(JSON) plconfigをご参照ください

ステータス

有効

`POST` : `/settings/add_recipe`

概要

トランスコード設定にレシピを追加。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
config (required)	レシピ設定でjson形式による指定が必須。内容はsettings/get_recipe_template_configを参考にしてください。
name (required)	レシピ名で必須
subtype	コンテンツの種類・`video` : 動画・`audio` : 音声・`pdf` : PDF ・`image` : 画像・`folder` : フォルダ

エラー

config の形式が不正な場合

ステータス

有効

`POST` : `/settings/delete_recipe`

概要

トランスコード設定からレシピを削除。
ただし一度でも使用したレシピは削除できません。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_recipe (required)	レシピIDで必須。エンコード設定のID。 settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。

エラー

id_recipe が存在しない場合
id_recipe がデフォルト設定されている場合
id_recipe が既に利用されている場合

ステータス

有効

`POST` : `/settings/modify_recipe`

概要

トランスコード設定からレシピを編集。
ただし一度でも使用したレシピは編集できません。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_recipe (required)	エンコード設定のID settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
config (required)	レシピ設定(jsno)
name	レシピ名

エラー

id_recipe が存在しない場合
id_recipe が既に利用されている場合
config の形式が不正な場合

ステータス

有効

`GET` : `/settings/get_recipe_template_config`

概要

レシピのテンプレートを取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
subtype	コンテンツの種類・`video` : 動画・`audio` : 音声・`pdf` : PDF ・`image` : 画像・`folder` : フォルダ

出力

クエリー

名前(要素名)	値
config	レシピ設定
format	フォーマット
codec	映像コーデック
width	幅
height	高さ
audiocodec	音声コーデック
audiobitrate	音声ビットレート
bitrate	映像ビットレート
fps	フレームレート

ステータス

有効

`GET` : `/settings/get_transferconfig`

概要

配信設定情報を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

クエリー

名前(要素名)	値
transferconfig	配信設定情報
secure	暗号化・`0` : 無効・`1` : 有効
onetime	ワンタイム機能・`0` : 無効・`1` : 有効
rtmp	RTMP(Flash) ・`0` : 無効・`1` : 有効
hls	HTTP Live Streaming ・`0` : 無効・`1` : 有効
http	HTTP Progressive ・`0` : 無効・`1` : 有効

説明

現状、hds(HTTP dynamic Streaming)の項目はありません。
また、デバイス環境（PC/iOS/Android）の区別はありません。

ステータス

有効

`GET` : `/settings/get_deliverymatrix`

概要

詳細な配信設定情報を取得

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

クエリー

名前	値
matrix	配信設定情報
http/hls/hds	配信設定情報・`http` : HTTP Progressive ・`hls` : HTTP Live Streaming ・`hds` : HTTP dynamic Streaming
pc	PC ・`0` : 無効・`1` : 有効
android4	Android4(Android4系) ・`0` : 無効・`1` : 有効
ios	iOS ・`0` : 無効・`1` : 有効
secure	セキュア機能・`0` : 無効・`1` : 有効
onetime	ワンタイム・`0` : 無効・`1` : 有効

ステータス

有効

`GET` : `/settings/get_playbackrateconfig`

概要

倍速の設定値を取得。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。

出力

クエリー

名前	値
playbackrateconfig	playbackrateconfig 倍速の設定でjson形式

ステータス

有効

`POST` : `/settings/set_playbackrateconfig`

概要

倍速の設定値を追加。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
playbackrateconfig (required)	倍速の設定(json)

ステータス

有効

`POST` : `/settings/create_unique_accesskey`

概要

accesskeyを発行。

カテゴリ

設定

入力

クエリー

名前	値
ticket (required)	loginメソッドで取得できるチケット文字列。
id_user	対象ユーザーID ※1

出力

クエリー

名前(要素名)	値
accesskey	アクセスキー

備考

※1 対象となるユーザーを指定しない場合はticketのユーザーに対して作成されます。
対象となるユーザーを指定するにはticketのユーザーが管理者（typeがadmin）である必要があります。
管理者ユーザーを利用して一般ユーザーのaccesskeyを発行できます。

accesskeyを発行した際には最新のaccesskeyのみ有効となります。
accesskeyの発行に必要なsecretkeyは事前に発行された署名用秘密キーで、契約書類のみに記載されております。

ステータス

有効

目次

共通の出力要素

playbackrateconfig形式(JSON)

plconfig形式(JSON)

GET : /settings/get_external_block

概要

カテゴリ

入力

出力

ステータス

POST : /settings/set_external_block

概要

カテゴリ

入力

ステータス

GET : /settings/list_domain_block

概要

カテゴリ

入力

出力

ステータス

POST : /settings/set_domain_block

概要

カテゴリ

入力

説明

ステータス

POST : /settings/delete_domain_block

概要

カテゴリ

入力

ステータス

GET : /settings/list_allowed_ip

概要

カテゴリ

入力

出力

ステータス

POST : /settings/set_allowed_ip

概要

カテゴリ

入力

説明

ステータス

POST : /settings/delete_allowed_ip

概要

カテゴリ

入力

ステータス

GET : /settings/list_metatag

概要

カテゴリ

入力

出力

ステータス

POST : /settings/add_metatag

概要

カテゴリ

入力

ステータス

POST : /settings/delete_metatag

概要

カテゴリ

入力

ステータス

GET : /settings/get_youtube

概要

カテゴリ

入力

出力

ステータス

GET : /settings/get_youtube_auth_url

概要

カテゴリ

入力

出力

ステータス

POST : /settings/deauthorize_youtube_api

概要

カテゴリ

`GET` : `/settings/get_external_block`

`POST` : `/settings/set_external_block`

`GET` : `/settings/list_domain_block`

`POST` : `/settings/set_domain_block`

`POST` : `/settings/delete_domain_block`

`GET` : `/settings/list_allowed_ip`

`POST` : `/settings/set_allowed_ip`

`POST` : `/settings/delete_allowed_ip`

`GET` : `/settings/list_metatag`

`POST` : `/settings/add_metatag`

`POST` : `/settings/delete_metatag`

`GET` : `/settings/get_youtube`

`GET` : `/settings/get_youtube_auth_url`

`POST` : `/settings/deauthorize_youtube_api`

`GET` : `/settings/get_mail`

`POST` : `/settings/set_mail`

`POST` : `/settings/change_password`

`GET` : `/settings/list_recipe`

`POST` : `/settings/set_default_recipe`

`GET` : `/settings/get_plconfig`

`POST` : `/settings/set_plconfig`

`POST` : `/settings/add_recipe`

`POST` : `/settings/delete_recipe`

`POST` : `/settings/modify_recipe`

`GET` : `/settings/get_recipe_template_config`

`GET` : `/settings/get_transferconfig`