VCMS 视频系统 · 对接文档
VCMS 通过 iframe 嵌入到你的平台页面(和嵌入 YouTube 一样)。本文档讲两件事:
- 嵌入 —— 把"推荐横条 / 完整视频页 / 单个视频播放页"放进你的页面。
- 事件对接(postMessage) —— 用户在组件里的交互(点「更多」、点视频)如何通知你的平台,让你的平台来处理(开新窗口、走自家路由、做埋点统计等)。
三种嵌入
| 用途 | 地址 | 说明 |
|---|---|---|
| 推荐横条 | {BASE}/strip?platform={平台ID} | 平台首页的横向推荐条,点「更多」进完整门户 |
| 完整视频页(去 header) | {BASE}/embed | 完整视频网格,去掉顶部导航,整页嵌入 |
| 单个视频播放页 | {BASE}/watch/{视频ID} | 某个视频的播放页(自动播放) |
{BASE}是门户域名(例如https://vcms-qa.acorners.com)。平台 ID 在后台「平台对接」每个平台的「嵌入代码」里获取。
可选参数 · 用户标识 uid
三种嵌入都支持一个可选参数 uid,用来标识你平台上的这个用户:
| 用途 | 带 uid 的地址 |
|---|---|
| 推荐横条 | {BASE}/strip?platform={平台ID}&uid={用户ID} |
| 完整视频页 | {BASE}/embed?platform={平台ID}&uid={用户ID} |
| 单个视频播放页 | {BASE}/watch/{视频ID}?platform={平台ID}&uid={用户ID} |
带上之后,点赞 / 不喜欢与搜索历史会按这个用户记录,而不是按浏览器记录 —— 同一台设备上 换一个用户,看到的就是各自的数据。
几条规则:
- 必须与
platform同时出现才生效。身份是「平台 + 用户」的组合 —— 不同平台的同名用户是 两个不同的人,只有uid无法构成身份,系统会按未带处理。 - 不带
uid时行为与以前完全一致:按浏览器记录(清掉浏览器数据即重置)。 - 只能包含 英文字母、数字、
-、_,长度 1–64 字符。&、#、空格、中文等字符在 网址里会把值截断或需要转义,一律不接受。 - 为空、超长或含其他字符时不会报错,自动按未带处理。
- 值由你决定,但建议填你们内部用户 ID 的哈希值(例如
a3f8c91e4b7d2065f1c8e93a4d6b0271)。 不要直接填手机号、邮箱或用户名 ——uid明文出现在网址里,会进浏览器历史与访问日志。 也不要填1001这类连号:别人把网址里的数字改一位,就能顶着另一个用户的身份点赞。 - 同一个用户每次必须填同一个值(换了值,他的点赞与搜索历史就归零), 且一个值只能对应一个人。
⚠️
uid是明文参数,可以被任何人在地址栏里改写,因此它不是认证凭据。 请不要用它承载 登录态或任何需要保密的信息。它能影响的范围仅限该用户自己在某个视频上的点赞状态与搜索历史。
注意事项
- 防盗链:你的域名需先加入允许 referrer 白名单(请联系我们开通),否则视频会 403。
- 响应式:宽度用
100%自适应容器,高度按需调整 ;单个视频播放页建议用 16:9 包裹。 - 配色:推荐横条 / 完整页的背景、标题·内容、「更多」颜色可按平台定制(由我方在后台配置,你无需改嵌入代码)。
- 用户标识:如需按你平台的用户区分点赞与搜索历史,在嵌入地址上加
&uid=,见上一节。 - 后台「教学」页有所有嵌入方式的实时预览 + 可复制代码(含
uid的模拟输入)。
下一节:事件对接 API →