Skip to main content
开放 API 用于创建活动、配置票种与价格、查询剩余票量、录入参会者、审批报名、生成兑换码、记录签到。与控制台读写同一份数据、遵守同一套规则。容量、生命周期、审批，从任一入口进入，行为都一致。
API 的作用域是单个业务单元。密钥在某个业务单元内生成，只能读写该单元的活动，不能访问其他单元或其他组织。见 API 密钥。
无需自建后端的买家网站使用 Storefront API：前端持有的公开密钥、从浏览器直读的目录，以及把买家交给 orriven 托管页面的结账会话。本页描述 Secret 密钥的服务端形态。

​
能做什么

自动化对 API 操作与控制台操作同等生效：通过 API 录入的报名会触发「新增参会人」自动化，审批通过触发确认流程，到场签到触发欢迎流程。

​
基础地址与交互式文档

本文所有端点都挂在 orriven API 主机的 /v1 下。示例中主机写作 $BASE：
GET $BASE/openapi.json 返回完整的 OpenAPI 3.1 规范，可用于生成客户端。$BASE/docs 是交互式文档页，可用密钥试调每个端点。

​
请求与响应约定

  • 请求与响应均为 JSON;写操作请带 Content-Type: application/json。
  • 时间戳一律是带时区偏移的 ISO 8601(2026-09-01T09:00:00+08:00)。
  • 金额是活动币种最小货币单位的整数(¥120.00 → 12000),含税——与控制台同一约定。
  • 每个请求都携带密钥:Authorization: Bearer <secret>。
  • API 采用日期版本：密钥在创建时绑定版本，每个响应以 Orriven-Version 头回显生效版本。

​
下一步

API 密钥

在控制台生成密钥——Secret 只显示一次。

快速上手

活动 → 票种 → 报名 → 签到，七条 curl 请求。

端点参考

每个资源、方法与状态码。

票种

API 所映射的控制台概念。

命令行工具

在终端里管理密钥、Webhook 与日志。

Agent

面向自动化流程的 MCP 服务与 Developer API 访问集成。

Storefront API

无需自建后端的活动网站：公开密钥、浏览器直读目录、托管结账。