ミルビィWebAPI概要 – millvi

API利用における注意事項

HTTP 1.1 (GET/POST)

https://（ミルビィAPIドメイン）/（メソッド名）
例） https://capi.miovp.com/login
GETの場合、”?”付きで入力クエリーを指定できます。
例） https://capi.miovp.com/login?host=demo&userid=demo&password=demo
POSTの場合、file/upload以外のAPIは Conotent-Type:application/x-www-form-urlencoded 形式で呼び出して下さい。
文字コードはUTF-8になります。

API利用の際には login メソッドによる ticket の発行が必要です。チケット文字列は24時間有効です。

名前

値

ticket

loginメソッドで取得できるチケット文字列。（loginメソッドを除く）

(callback)

callbackを指定するとAPIからのレスポンスがJSONP形式になります。callbackにはJS関数名を指定して下さい。

limit

※「limit対応」しているAPIのみ。結果の一部を取得できます。
(offset),(limit) 例） 0,10 => 1行目から10行分取得
limitを指定すると結果にresult要素が付きます。

filters

※「filters対応」しているAPIのみ。結果をフィルタリングできます。
項目別でAND検索、同じ項目を指定することでOR検索になります。
例）filters=[{"name":"name","value":"millvi"}]

filters	フィルタリング項目（複数）
name	フィルタ項目名 name, description, metatag, usermeta, id_contents, type, contents_visible, create_date, process_status, video_keitai_process_status, video_youtube_process_statusのうちのどれか
value	フィルタ値

order

※「order対応」しているAPIのみ。結果をフィルタリングできます。
項目別でAND検索、同じ項目を指定することでOR検索になります。
例）order={"by":"id_contents","sort":"ASC"}

order	並び替え要素
by	並び替え項目 name, description, id_contents, type, duration, contents_visible, create_date, process_status, video_keitai_process_status, video_youtube_process_statusのうちのどれか
sort	並び替え順 ASC, DESCのうちのどれか

xml

xml=1を指定するとレスポンスがXML形式になります。

commited

commited=1を指定すると「公開」済みのデータのみ取得します。省略時は全てのデータを取得します。

X_MV2_ACCESSKEY

ticketの代わりに、settings/create_unique_accesskeyで作成されたaccesskeyを指定することもできます。
※HTTPリクエストヘッダでの指定

デフォルトでJSON形式で出力されます。（他形式でも出力可。「全API共通の入力」を参照）

名前	値（要素の内容）
sessionerror	チケットが入力されていないか、チケットが無効。