millvi Web API クイックスタートガイド

この記事ではmilviのWebAPIを利用し、ログイン、動画投稿、レポート確認をAPI上で行う方法について説明します。

目次

1. チケットを発行する
2. APIの使用例1.動画のアップロード
3. APIの使用例2.レポート情報の取得

認証用チケットを発行する

まず、チケット発行API/loginを利用して認証を行います。

リクエスト

curl "https://capi.miovp.com/login" -X POST -d host=(クライアントid) -d userid=(ユーザーid) -d password=(パスワード)" 

クライアントid、ユーザーid、パスワードはそれぞれログイン時に入力するものを指定してください。

認証に成功した場合、以下の様な応答を返します

レスポンス例(成功時)

{
  "ticket": "(チケット文字列)",
  "type": "normal",
  "vhost_name": "group1",
  "permissions": {
    "contents": "1",
    "report": "1"
  },
  "accountinfo": {
    "keitai": 0,
    "admin_recipe": 1,
    "use_chapter": 1,
    "use_playbackrate": 1,
    "use_broadcast": 1,
    "use_broadcast_archive": 1,
    "use_broadcast_transcode": 0,
    "uploader_plan": "free"
  },
  "status": true
}

以降、チケット文字列をトークンとしてクエリに入れてWebAPIを利用します。

なお、認証に失敗した場合は、statusキーの値がfalseとなります。

APIの使用例1.動画のアップロード

動画のアップロードには以下の手順でWebAPIを使用します。

1. /file/uploadでmillviサーバーに動画をアップロード
2. /contents/create_videoでお使いのmillviアカウントに動画を登録

/file/uploadでは動画をサーバーにアップロードします。

リクエスト

curl "https://capi.miovp.com/report/file/upload " -F "ticket=(チケット文字列)" -F "filename=(ファイル名.mp4)" -F "file=@(ローカルのファイルフルパス.mp4)"

レスポンス例(成功時)

レスポンスは1行のCSV形式になります。

（ファイル名）,(ファイルキー),(ファイルタイプ)

次に、/contents/create_videoでファイルキーを渡し、millviアカウントに動画を登録します。

リクエスト

curl "https://capi.miovp.com/contents/create_video" -X POST -d "ticket=(チケット文字列)" -d "name=testmovie" -d "autocommit=1" -d "filekey=(ファイルキー)"

レスポンス例(成功時)

{
　　"id_contents":23,
  "status":true
}

APIの使用例2.レポート情報の取得

動画のレポート情報を確認するには/report/video_summaryを利用します。

リクエスト

curl "https://capi.miovp.com/report/video_summary?ticket=（チケット文字列）"

レスポンス例(成功時)

{
  "status": true,
  "data": [
    {
      "id_vhost": "1",
      "id_contents": "12",
      "show": "44",
      "play": "22",
      "play_average": "0.5000",
      "viewtime_average": "4.0000",
      "achieve25": "100",
      "achieve50": "100",
      "achieve75": "0",
      "achieve100": "0",
      "contents_name": "samplemovie",
      "parent_id_contents": "",
      "create_date": "2022-05-24 14:22:01"
    },
    { ... }, ...,
    { ... }
  ]
}