API 的作用域是单个业务单元。密钥在某个业务单元内生成,只能读写该单元的活动——碰不到其他单元,更碰不到其他组织。见 API 密钥。
能做什么
自动化对 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 所映射的控制台概念。