プロトコル

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になります。

 

ticket

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

 

全API共通の入力

クエリー

名前
ticket loginメソッドで取得できるチケット文字列。(loginメソッドを除く)
(callback) callbackを指定するとAPIからのレスポンスがJSONP形式になります。callbackにはJS関数名を指定して下さい。
limit ※「limit対応」しているAPIのみ。結果の一部を取得できます。
(offset),(limit) 例) 0,10 => 1行目から10行分取得
limitを指定すると結果にresult要素が付きます。

result  
 offset (offset)の値
 limit (limit)の値
 found 全行数
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”:”DESC”}

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リクエストヘッダでの指定

 

全API共通の出力

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

共通の構造 – レスポンス内容

名前(要素名) 値(要素の内容)
status 成功するとtrue、失敗するとfalse。
reason 失敗理由の情報。(status=false時のみ)
  code エラーコード
  message エラーメッセージ(日本語)

共通code – レスポンス内容

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

 

API利用における注意事項

  • レポート情報はAPIサーバーのデータベースに60分程度の間隔で更新されます。(サーバーの稼働状況により反映までの時間は異なります。)
  • 短時間でのループ処理で負荷をかけるようなタスクはご遠慮ください。
    弊社側で高負荷の検知があった場合、利用方法についてご相談させていただく場合があります。
  • 本APIドキュメントに記載されている仕様以外の設定では正しく動作しないことがあります。
この記事は役に立ちましたか?
1人中1人がこの記事が役に立ったと言っています