上线所需的一切
现代化的 API 接口和工具,助你将 vcity 集成到自己的技术栈中。
REST API
用于组织、商品、活动、订单、预订和报价的读取端点。版本为 /api/v1。OpenAPI 3.1。
使用 API 密钥进行 Bearer 认证
在你的组织管理面板中生成按组织划分的密钥。仅限单个组织使用。可随时轮换或撤销。
官方 TypeScript SDK
@vcityio/api-client —— 基于 OpenAPI 规范生成的类型化响应。ESM,支持 Node 20+ 及现代浏览器。
vcity CLI
通过设备流进行身份验证、列出你的组织、切换上下文,并从终端浏览商品。
Webhook
即将推出在你自己的服务中响应订单、报名、支付等事件。
OpenAPI 浏览器
在 /docs/api 浏览每个端点及示例。可直接在页面上测试请求。
两分钟获取 API 密钥
密钥位于组织控制台内。每个密钥仅限单个组织使用,可随时轮换或撤销。
- 1
创建或选择一个组织
进入组织管理面板。
- 2
打开 API 密钥选项卡
位于组织管理设置下的 /orgs/<id>/admin/api-keys。
- 3
生成并复制
完整密钥仅显示一次——请妥善保管。在 Authorization 请求头中将其作为 Bearer token 使用。
Authorization header
Authorization: Bearer vck_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json安装 CLI
一行命令安装。通过设备流认证——无需密码,无需复制 token。
安装
curl -fsSL https://vcity.io/cli/install.sh | bash登录
vcity login运行命令
vcity orgs list调用 API
直接使用 curl 或官方 TypeScript SDK。
bash
curl https://vcity.io/api/v1/orgs/your-org/products \
-H "Authorization: Bearer $VCITY_API_KEY" \
-H "Content-Type: application/json"你可以构建什么
任何涉及组织的商务、内容或 3D 呈现的应用。
同步库存
将产品从 ERP 或 PIM 推送到 vcity 商店。让库存和价格保持同步。
自动化活动
创建活动、管理参与者,并从自己的工具中获取分析数据。
自定义结账
在你的网站上构建嵌入式购买流程,在 vcity 内完成结算。
无头 3D
按需启动品牌化的 3D 空间,嵌入到任何地方。
webhook 驱动的工作流
即将推出当发生销售或 RSVP 时,触发 Slack 提醒、CRM 更新或履约流程。
内部工具
即将推出基于组织数据搭建管理后台,无需重建 UI。
在 GitHub 上开源
CLI 和 TypeScript 客户端均已开源,并通过 npm 进行版本管理。
