CS2VIEW开发者文档
查看 Markdown

五分钟接入

让用户在你的页面内检视 CS2 物品。JS SDK 负责嵌入查看器和事件通信;厂商后端负责保管应用密钥、申请进入凭证。

正式嵌入入口统一为 https://www.cs2view.com/embed,与主站共用域名。SDK 默认使用此地址,无需单独配置 embed 子域名。

开始之前

请联系 business@cs2deck.com 开通厂商账户、应用和允许接入的来源域名。获取应用 ID 与应用密钥,并为容器设置明确高度。浏览器需要支持 WebGPU;不支持时请展示设备提示。

接入服务包含 JS SDK、文档、控制台和真实商业检视入口。请先开通厂商账户,再使用下方 SDK 地址接入。

在网页中创建查看器

可直接从下方文档站 CDN 地址加载 SDK。npm 包尚未发布;需要私有包源安装时,请联系平台获取构建产物。

html
<div id="viewer" style="height:560px"></div>
<script type="module">
  import {createViewer} from 'https://docs.cs2view.com/sdk/0.1.0/index.js';
  const viewer=createViewer({
    container:'#viewer',
    tier:'inspect',
    item:{inspect:'<包含物品数据的 Steam 检视链接>'},
    getGrant:async({signal,...request})=>{
      const r=await fetch('/api/cs2view/grant',{
        method:'POST',headers:{'Content-Type':'application/json'},
        body:JSON.stringify(request),signal
      });
      if(!r.ok)throw Error('当前无法进入检视,请稍后重试');
      return r.json();
    }
  });
  viewer.on('loaded',event=>console.log('检视已显示',event.visitId));
  viewer.on('error',event=>console.warn(event.code,event.message));
  // 页面组件卸载时:await viewer.destroy();
</script>

普通 script 标签可加载 /sdk/0.1.0/cs2view.js,通过 CS2View.createViewer() 使用相同接口。模块包提供完整 TypeScript 类型。

接上你的后端

/api/cs2view/grant 是厂商自己的接口,不是可直接照抄调用的 CS2View 地址。请先实现「服务端接入」中的鉴权逻辑。不要将长期应用密钥写入 JS、HTML、小程序或 App。

一次访问如何计量

首次成功兑换进入凭证即产生计费用量,不等待加载完成。刷新、关闭后重开、调用 load() 都是新的访问;同一次进入的网络重试不重复计费。旋转和切换已授权视角不重复计费。修改物品参数需要单独开通 editor;编辑器内部编辑不创建新访问。

计费明细以控制台为准;loaded 是客户端体验事件,不是扣费依据。