云 视 频 开 放 API 开 发 指 南 版 本 :V1.0 乐 视 网 乐 视 云 视 频 www.letvcloud.com 第 1 页 共 15 页
目 录 API 接 口..3 相 关 说 明...3 系 统 参 数 说 明..3 返 回 参 数 说 明...3 接 口 说 明...4 视 频 管 理...4 1. 视 频 上 传 初 始 化 (Web 方 式 ) 4 2. 视 频 上 传 (Web 方 式 ) 4 3. 视 频 断 点 续 传 (Web 方 式 ) 5 4. 视 频 上 传 进 度 查 询 (Web 方 式 )...5 5. 视 频 上 传 (Flash 方 式 )..5 6. 视 频 信 息 更 新....6 7. 获 取 视 频 列 表...6 8. 获 取 单 个 视 频 信 息.7 9. 视 频 删 除.8 10. 视 频 批 量 删 除.8 11. 视 频 暂 停...8 12. 视 频 恢 复...8 截 图 管 理...9 1. 获 取 视 频 截 图...9 数 据 统 计...9 1. 视 频 小 时 数 据...9 2. 视 频 天 数 据...10 3. 所 有 数 据...10 使 用 示 例 11 播 放 接 口 12 调 用 参 数 说 明..12 接 口 说 明..12 1. URL 方 式.12 2. JS 代 码.13 3. Flash 地 址 13 4. HTML 代 码.13 回 调 接 口 13 相 关 说 明....13 系 统 参 数 说 明 14 接 口 说 明 14 1. 视 频 状 态 回 调 接 口...14 2. 收 费 视 频 用 户 鉴 权 回 调 接 口...14 第 2 页 共 15 页
API 接 口 相 关 说 明 1) 使 用 HTTP 协 议 进 行 信 息 交 互, 字 符 编 码 统 一 采 用 UTF-8 2) 除 非 特 殊 说 明, 接 口 地 址 统 一 为 :http://api.letvcloud.com/open.php 3) 除 非 特 殊 说 明, 同 时 支 持 GET 和 POST 两 种 参 数 传 递 方 式 4) 除 非 特 殊 说 明, 返 回 信 息 支 持 JSON 和 XML 两 种 方 式 5) 除 了 sign 外, 其 余 所 有 请 求 参 数 值 都 需 要 进 行 URL 编 码 6) 参 数 表 中, 类 型 一 栏 声 明 的 定 义 为 :int 代 表 整 数 类 型 ;string 代 表 字 符 串 类 型, 如 果 后 面 有 括 号, 括 号 中 的 数 字 代 表 该 参 数 的 最 大 长 度 ;array 表 示 数 组 类 型 系 统 参 数 说 明 user_unique string Y 用 户 唯 一 标 识 码, 由 乐 视 网 统 一 分 配 并 提 供 timestamp int Y 当 前 Unix 时 间 戳, 请 保 证 请 求 服 务 器 时 间 正 确, 有 些 API 接 口 是 有 时 效 性 要 求 的 api string Y 调 用 API 接 口 的 名 称 format string Y 返 回 参 数 格 式 : 支 持 json 和 xml 两 种 方 式 ver string Y 协 议 版 本 号, 统 一 取 值 为 2.0 sign string Y 验 证 码, 生 成 规 则 详 见 下 面 的 说 明, 其 中 secretkey 是 sign 生 成 规 则 可 以 分 为 4 个 步 骤 : 1) 把 其 它 所 有 参 数 按 key 升 序 排 序 由 乐 视 网 统 一 分 配 并 提 供 的 用 户 密 钥 2) 把 key 和 它 对 应 的 value 拼 接 成 一 个 字 符 串 按 步 骤 1 中 顺 序, 把 所 有 键 值 对 字 符 串 拼 接 成 一 个 字 符 串 3) 把 分 配 给 的 secretkey 拼 接 在 第 2 步 骤 得 到 的 字 符 串 后 面 4) 计 算 第 3 步 骤 字 符 串 的 md5 值, 使 用 md5 值 的 16 进 制 字 符 串 作 为 sign 的 值 返 回 参 数 说 明 code int 状 态 值 :0 表 示 操 作 成 功 ; 其 它 值 表 示 失 败, 具 体 含 义 见 message 说 明 message string 状 态 说 明 total int 符 合 条 件 的 记 录 数 量 第 3 页 共 15 页
data array 返 回 具 体 信 息 接 口 说 明 视 频 管 理 1. 视 频 上 传 初 始 化 (Web 方 式 ) api 名 称 :video.upload.init 功 能 描 述 : 视 频 上 传 前 调 用, 获 取 正 式 上 传 时 需 要 的 一 些 信 息 video_name string(200) Y 视 频 名 称 client_ip string(15) N 用 户 IP 地 址 为 了 保 证 用 户 上 传 的 速 度, 建 议 将 用 户 公 网 IP 地 址 写 入 该 参 数 file_size int N 文 件 大 小, 单 位 为 字 节 video_id int 视 频 ID video_unique string 视 频 唯 一 标 识 码 upload_url string 视 频 上 传 地 址, 视 频 上 传 时 提 交 地 址 progress_url string 视 频 上 传 进 度 查 询 地 址 token string 视 频 上 传 标 识, 用 于 断 点 续 传 和 上 传 进 度 查 询 2. 视 频 上 传 (Web 方 式 ) 接 口 地 址 : 由 video.upload.init 返 回 的 upload_url 确 定 功 能 描 述 : 视 频 上 传 请 求 参 数 : 由 video.upload.init 返 回 的 upload_url 确 定, 请 不 要 进 行 任 何 修 改 注 意 事 项 : 1 该 接 口 只 支 持 POST 参 数 传 递 方 式 2 上 传 时 form 表 单 提 交 地 址 由 video.uploadinit 返 回 的 upload_url 确 定, 需 要 添 加 参 数 enctype="multipart/form-data",form 表 单 中 上 传 文 件 的 参 数 名 称 为 video_file 示 例 如 下 : <form method="post" enctype="multipart/form-data" action="upload_url"> <input type="file" name="video_file"> 第 4 页 共 15 页
</form> 3 支 持 以 下 视 频 格 式, 请 上 传 时 做 一 下 后 缀 名 校 验 : 微 软 视 频 :.wmv.avi.dat.asf Real Player:.rm.rmvb.ram MPEG 视 频 :.mpg.mpeg 手 机 视 频 :.3gp Apple 视 频 :.mov Sony 视 频 :.mp4.m4v DV 视 频 :.dvix.dv 其 他 常 见 视 频 :.mkv.flv.vob.qt.divx.cpk.fli.flc.mod 3. 视 频 断 点 续 传 (Web 方 式 ) api 名 称 :video.upload.resume 功 能 描 述 : 视 频 文 件 断 点 续 传 token string(500) Y 视 频 上 传 标 识 upload_url string 视 频 续 传 地 址, 视 频 续 传 时 提 交 地 址 progress_url string 视 频 上 传 进 度 查 询 地 址 upload_size int 已 经 上 传 的 文 件 大 小, 单 位 为 字 节 4. 视 频 上 传 进 度 查 询 (Web 方 式 ) 接 口 地 址 : 由 video.upload.init 或 video.upload.resume 返 回 的 progress_url 确 定 功 能 描 述 : 视 频 上 传 进 度 查 询, 只 有 文 件 在 上 传 过 程 中 调 用 才 有 意 义 请 求 参 数 : 由 video.upload.init 或 video.upload.resume 返 回 的 progress_url 确 定, 请 不 要 进 行 任 何 修 改 total_size int 视 频 文 件 总 大 小, 单 位 为 字 节 upload_size int 已 经 上 传 的 数 据 大 小, 单 位 为 字 节 5. 视 频 上 传 (Flash 方 式 ) api 名 称 :video.upload.flash 第 5 页 共 15 页
功 能 描 述 : 通 过 Flash 插 件 方 式 进 行 视 频 上 传 video_name string(200) Y 视 频 名 称 js_callback string(50) N Javascript 回 调 函 数, 视 频 上 传 完 毕 后 调 用 flash_width int N Flash 宽 度, 默 认 值 为 600 flash_height int N Flash 高 度, 默 认 值 为 450 client_ip string(15) N 用 户 IP 地 址 为 了 保 证 用 户 上 传 的 速 度, 建 议 将 用 户 公 网 IP 地 址 写 入 该 参 数 video_id int 视 频 ID video_unique string 视 频 唯 一 标 识 码 flash_upload string flash 上 传 html 代 码 6. 视 频 信 息 更 新 api 名 称 :video.update 功 能 描 述 : 编 辑 单 个 视 频 的 相 关 信 息 video_name string(200) N 视 频 名 称 video_desc string(500) N 视 频 简 介 tag string(200) N 标 签 is_pay int N 视 频 是 否 收 费 :0 表 示 不 收 费 ;1 表 示 收 费 ( 收 费 视 频 播 放 时 会 进 行 用 户 鉴 权, 请 不 要 随 便 设 置 ) 7. 获 取 视 频 列 表 api 名 称 :video.list 功 能 描 述 : 获 取 视 频 列 表 信 息 index int N 开 始 页 索 引, 默 认 值 为 1 size int N 分 页 大 小, 默 认 值 为 10, 最 大 值 为 100 status int N 视 频 状 态 :0 表 示 全 部 ;10 表 示 可 以 正 常 播 放 ;20 表 第 6 页 共 15 页
示 处 理 失 败 ;30 表 示 正 在 处 理 过 程 中 默 认 值 为 0 video_id int 视 频 ID video_unique string 视 频 唯 一 标 识 码 video_name string 视 频 名 称 status int 视 频 状 态 :10 表 示 可 以 正 常 播 放 ;20 表 示 处 理 失 败 ;30 表 示 正 在 处 理 过 程 中 video_desc string 视 频 简 介 tag string 标 签 is_pay int 视 频 是 否 收 费 :0 表 示 不 收 费 ;1 表 示 收 费 img string 视 频 截 图 URL 地 址 video_duration int 播 放 时 长, 单 位 为 秒 initial_size int 上 传 文 件 原 始 大 小, 单 位 为 字 节 error_desc string 错 误 描 述, 视 频 处 理 失 败 的 具 体 原 因 描 述 add_time string 视 频 添 加 时 间, 格 式 为 :yyyy-mm-dd hh:ii:ss complete_time string 上 传 完 毕 时 间, 格 式 为 :yyyy-mm-dd hh:ii:ss file_md5 string 视 频 源 文 件 的 MD5 值 8. 获 取 单 个 视 频 信 息 api 名 称 :video.get 功 能 描 述 : 获 取 单 个 视 频 的 详 细 信 息 video_id int 视 频 ID video_unique string 视 频 唯 一 标 识 码 video_name string 视 频 名 称 status int 视 频 状 态 :10 表 示 可 以 正 常 播 放 ;20 表 示 处 理 失 败 ;30 表 示 正 在 处 理 过 程 中 video_desc string 视 频 简 介 tag string 标 签 is_pay int 视 频 是 否 收 费 :0 表 示 不 收 费 ;1 表 示 收 费 img string 视 频 截 图 URL 地 址 video_duration int 播 放 时 长, 单 位 为 秒 initial_size int 上 传 文 件 原 始 大 小, 单 位 为 字 节 error_desc string 错 误 描 述, 视 频 处 理 失 败 的 具 体 原 因 描 述 add_time string 视 频 添 加 时 间, 格 式 为 :yyyy-mm-dd hh:ii:ss 第 7 页 共 15 页
complete_time string 上 传 完 毕 时 间, 格 式 为 :yyyy-mm-dd hh:ii:ss file_md5 string 视 频 源 文 件 的 MD5 值 9. 视 频 删 除 api 名 称 :video.del 功 能 描 述 : 删 除 视 频 10. 视 频 批 量 删 除 api 名 称 :video.del.batch 功 能 描 述 : 批 量 删 除 视 频 video_id_list string Y 视 频 ID 列 表, 使 用 符 号 - 作 为 间 隔 符, 每 次 最 多 操 作 50 条 记 录 11. 视 频 暂 停 api 名 称 :video.pause 功 能 描 述 : 对 播 放 正 常 的 视 频 进 行 暂 停 操 作 第 8 页 共 15 页
12. 视 频 恢 复 api 名 称 :video.restore 功 能 描 述 : 对 暂 停 的 视 频 进 行 恢 复 操 作 截 图 管 理 1. 获 取 视 频 截 图 api 名 称 :image.get 功 能 描 述 : 获 取 视 频 截 图 size string Y 截 图 尺 寸, 每 种 尺 寸 各 有 8 张 图 有 以 下 尺 寸 供 选 择 :100_100 200_200 300_300 120_90 128_96 132_99 160_120 200_150 400_300 160_90 320_180 640_360 90_120 120_160 150_200 300_400 img1 string 截 图 地 址 1 img8 string 截 图 地 址 8 数 据 统 计 1. 视 频 小 时 数 据 api 名 称 :data.video.hour 功 能 描 述 : 获 取 以 小 时 为 单 位 的 视 频 数 据 第 9 页 共 15 页
date string(10) Y 日 期, 格 式 为 :yyyy-mm-dd hour int N 小 时,0-23 之 间 video_id int N 视 频 ID index int N 开 始 页 索 引, 默 认 值 为 1 size int N 分 页 大 小, 默 认 值 为 10, 最 大 值 为 100 hour int 小 时,0-23 之 间 video_id int 视 频 ID video_view int 视 频 展 示 量 2. 视 频 天 数 据 api 名 称 :data.video.date 功 能 描 述 : 获 取 以 天 为 单 位 的 视 频 数 据 start_date string(10) Y 开 始 日 期, 格 式 为 :yyyy-mm-dd end_date string(10) Y 结 束 日 期, 格 式 为 :yyyy-mm-dd video_id int N 视 频 ID, 不 输 入 该 参 数 将 返 回 所 有 视 频 的 数 据 index int N 开 始 页 索 引, 默 认 值 为 1 size int N 分 页 大 小, 默 认 值 为 10, 最 大 值 为 100 date string 日 期 video_id int 视 频 ID video_view int 视 频 展 示 量 3. 所 有 数 据 api 名 称 :data.total.date 功 能 描 述 : 获 取 以 天 为 单 位 的 所 有 数 据 start_date string(10) Y 开 始 日 期, 格 式 为 :yyyy-mm-dd end_date string(10) Y 结 束 日 期, 格 式 为 :yyyy-mm-dd index int N 开 始 页 索 引, 默 认 值 为 1 第 10 页 共 15 页
size int N 分 页 大 小, 默 认 值 为 10, 最 大 值 为 100 date string 日 期 total_view int 视 频 展 示 量 使 用 示 例 用 户 密 钥 : secretkey=900150983cd24fb0d6963f7d28e17f72 系 统 参 数 : user_unique=abcde12345 timestamp=1347091285 api=video.list format=json ver=2.0 应 用 参 数 : index=1 size=50 步 骤 一 : 将 所 有 参 数 按 照 字 典 顺 序 ( 英 文 字 母 ) 排 序, 如 下 api=video.list format=json index=1 size=50 timestamp=1347091285 user_unique=abcde12345 ver=2.0 步 骤 二 : 按 照 步 骤 一 排 序 好 的 顺 序, 把 key 和 它 对 应 的 value 拼 接 成 一 个 字 符 串 apivideo.listformatjsonindex1size50timestamp1347091285user_uniqueabcde12345ver2.0 步 骤 三 : 把 secretkey 拼 接 到 步 骤 二 得 到 的 字 符 串 后 面 apivideo. listformatjsonindex1size50timestamp1347091285user_uniqueabc de12345ver2.09001509 83cd24fb0d6963f7d28e17f72 步 骤 四 : 生 成 验 证 码 sign 第 11 页 共 15 页
md5(apivideo.listformatjsonindex1s ize50timestamp1347091285user_uniqueabcde12345ver2.0900 150983cd24fb0d6963f7d28e17f72) sign=fb3bd36b3383691b9e4f55b1dd452133 步 骤 五 : 除 了 sign 外, 其 余 所 有 参 数 值 都 需 要 进 行 URL 编 码 user_unique=urlencode(abcde12345)=abcde12345 timestamp=urlencode(1347091285)=1347091285 api=urlencode(video.list)=video.list format=urlencode(json)=json ver=urlencode(2.0)=2.0 index=urlencode(1)=1 size=urlencode(50)=50 步 骤 六 : 组 成 最 终 访 问 URL http://api.letvcloud.com/open.php?user_unique=abcde12345×tamp=1347091285&api=video.list&format=json&ver=2.0&index=1&size=50&sign=fb3bd36b3383691b9e4f55b1dd452133 播 放 接 口 调 用 参 数 说 明 uu string Y 用 户 唯 一 标 识 码, 由 乐 视 网 统 一 分 配 并 提 供 vu string Y 视 频 唯 一 标 识 码 pu string N 播 放 器 唯 一 标 识 码 auto_play int N 是 否 自 动 播 放 :1 表 示 自 动 播 放 ;0 表 示 不 自 动 播 放 默 认 值 由 双 方 事 先 约 定 width int N 播 放 器 宽 度 height int N 播 放 器 高 度 payer_name string N 收 费 用 户 名 称, 由 合 伙 伙 伴 提 供 check_code string N 收 费 验 证 码, 由 合 伙 伙 伴 提 供, 具 体 含 义 由 双 方 约 定 第 12 页 共 15 页
播 放 接 口 1. URL 方 式 http://yuntv.letv.com/bcloud.html?uu=abcde12345&vu=a1b2c3d4f5&pu=12345abcde&auto_play =1&width=800&height=450 2. JS 代 码 <script type="text/javascript"> var letvcloud_player_conf = {"uu":"abcde12345","vu":"a1b2c3d4f5","pu":"12345abcde","auto_play":1,"width":800,"height":4 50}; </script> <script type="text/javascript" src="http://yuntv.letv.com/bcloud.js"></script> 3. Flash 地 址 http://yuntv.letv.com/bcloud.swf?uu=abcde12345&vu=a1b2c3d4f5&pu=12345abcde&auto_play= 1&width=800&height=450 4. HTML 代 码 <embed src="http://yuntv.letv.com/bcloud.swf" allowfullscreen="true" quality="high" width="800" height="450" align="middle" allowscriptaccess="always" flashvars=" uu=abcde12345&vu=a1b2c3d4f5&pu=12345abcde&auto_play=1&width=800&height=450" type="application/x-shockwave-flash"></embed> 第 13 页 共 15 页
回 调 接 口 相 关 说 明 7) 回 调 接 口 是 指 由 合 作 伙 伴 提 供, 我 方 主 动 去 调 用 的 接 口 8) 接 口 地 址 由 合 作 伙 伴 提 供, 不 同 接 口 采 用 不 同 的 地 址 9) 使 用 HTTP 协 议 进 行 信 息 交 互, 参 数 传 递 采 用 get 方 式 10) 字 符 编 码 统 一 采 用 UTF-8 11) 返 回 信 息 支 持 JSON 和 XML 两 种 方 式 12) 除 了 sign 外, 其 余 所 有 请 求 参 数 值 都 需 要 进 行 URL 编 码 13) 参 数 表 中, 类 型 一 栏 声 明 的 定 义 为 :int 代 表 整 数 类 型 ;string 代 表 字 符 串 类 型, 如 果 后 面 有 括 号, 括 号 中 的 数 字 代 表 该 参 数 的 最 大 长 度 ;array 表 示 数 组 类 型 系 统 参 数 说 明 user_unique string Y 用 户 唯 一 标 识 码, 由 乐 视 网 统 一 分 配 并 提 供 timestamp int Y 当 前 Unix 时 间 戳, 请 保 证 服 务 器 时 间 正 确 format string Y 返 回 参 数 格 式 : 支 持 json 和 xml 两 种 方 式 ver string Y 协 议 版 本 号, 统 一 取 值 为 2.0 sign string Y 验 证 码, 生 成 规 则 详 见 下 面 的 说 明, 其 中 secretkey 是 sign 生 成 规 则 可 以 分 为 4 个 步 骤 : 5) 把 其 它 所 有 参 数 按 key 升 序 排 序 由 乐 视 网 统 一 分 配 并 提 供 的 用 户 密 钥 6) 把 key 和 它 对 应 的 value 拼 接 成 一 个 字 符 串 按 步 骤 1 中 顺 序, 把 所 有 键 值 对 字 符 串 拼 接 成 一 个 字 符 串 7) 把 分 配 给 的 secretkey 拼 接 在 第 2 步 骤 得 到 的 字 符 串 后 面 8) 计 算 第 3 步 骤 字 符 串 的 md5 值, 使 用 md5 值 的 16 进 制 字 符 串 作 为 sign 的 值 接 口 说 明 1. 视 频 状 态 回 调 接 口 功 能 描 述 : 视 频 状 态 存 在 变 化 时, 通 过 该 接 口 及 时 告 知 合 作 伙 伴 第 14 页 共 15 页
status string Y 视 频 状 态, 有 以 下 取 值 : 返 回 参 数 说 明 : UPLOAD_OVER: 上 传 完 毕 DEAL_FAILED: 转 码 失 败 CHECK_FAILED: 审 核 失 败 OK: 处 理 成 功, 可 以 正 常 播 放 PAUSE: 视 频 暂 停 code int 状 态 值 :0 表 示 操 作 成 功 ; 其 它 值 表 示 失 败, 具 体 含 义 写 入 下 面 的 message 字 段 message string 状 态 说 明 2. 收 费 视 频 用 户 鉴 权 回 调 接 口 功 能 描 述 : 对 于 收 费 类 视 频, 合 伙 伙 伴 提 供 该 接 口 用 于 判 断 用 户 是 否 收 看 视 频 的 权 限 video_unique string Y 视 频 唯 一 标 识 码 payer_name string Y 收 费 用 户 名 称, 由 合 伙 伙 伴 提 供 check_code string N 收 费 验 证 码, 由 合 伙 伙 伴 提 供, 具 体 含 义 由 双 方 约 定 返 回 参 数 说 明 : code int 状 态 值 :0 表 示 操 作 成 功 ; 其 它 值 表 示 失 败, 具 体 含 义 写 入 下 面 的 message 字 段 message string 状 态 说 明 payer_status int 收 费 用 户 状 态 :1 表 示 用 户 具 备 权 限 收 看 视 频 ;0 表 示 没 有 权 限 第 15 页 共 15 页