v1.0.0 • OAS 3.0 • Staging
此 API 提供用于管理活动、门票、组织、支付和用户账户的端点。将 CHI 服务集成到您的应用中，在 CHI 生态系统之上构建。
Base URL: https://api.staging.chi.app
GET /events?page=1&limit=20
{
"data": [...],
"total": 156,
"page": 1,
"lastPage": 8
}大多数端点需要 Bearer 令牌认证。请在 Authorization 请求头中包含 JWT 令牌：
Authorization: Bearer <your-token> # Example request curl -X GET https://api.staging.chi.app/events \ -H "Authorization: Bearer <your-token>" \ -H "Content-Type: application/json"
通过API注册webhook端点，接收票据扫描、支付和签到的实时事件通知。
POST https://your-server.com/webhook
{
"event": "ticket.scanned",
"timestamp": "2025-06-15T14:30:00Z",
"data": {
"ticketId": "tkt_abc123",
"eventId": "evt_xyz789",
"visitorId": "vis_456def"
}
}使用我们的官方包，以您首选的语言集成CHI平台。
错误返回包含 statusCode、message 和 error 字段的JSON对象。处理 401（令牌过期）、403（禁止）和 429（速率限制）。
{
"statusCode": 401,
"message": "Unauthorized",
"error": "Token expired"
}| 状态码 | 含义 | 操作 |
|---|---|---|
| 400 | 错误请求 | 检查请求体和参数 |
| 401 | 未授权 | 令牌过期 — 刷新并重试 |
| 403 | 禁止访问 | 对此资源权限不足 |
| 429 | 速率限制 | 使用指数退避延迟 |
| 500 | 服务器错误 | 稍后重试或联系支持 |
每个API密钥每分钟100个请求。对429响应使用指数退避。
| 等级 | 速率 | 突发 |
|---|---|---|
| 标准 | 100 req/min | 20 req/s |
| 企业版 | 1000 req/min | 100 req/s |
我们提供符合 llms.txt 规范的标准化上下文文件。将您的AI代理指向这些URL，即可立即加载完整的CHI生态系统上下文。
要让您的编码助手（Cursor、Windsurf、Copilot）全面了解CHI平台，请在项目根目录创建 agent.md 文件并粘贴以下内容块。这确保AI遵循我们的设计令牌和API模式。
# CHI Ecosystem API Context for AI Agents
You are integrating with the CHI Ecosystem (EventCHI) REST API.
Base URL: https://api.chi.app (production) | https://staging-api.chi.app (staging)
Auth: Bearer token via Authorization header.
## Resources
- Full Context: https://chi.app/llms-full.txt
- Minimal Context: https://chi.app/llms-minimal.txt
- API Docs (Swagger): https://chi.app/docs
- MCP Server: npx @chi-app/mcp-server connect
## API Guidelines
1. **Authentication**: All requests require a Bearer token. Obtain tokens via POST /auth/login.
2. **REST Patterns**: Use strict RESTful conventions — resource-based URLs, proper HTTP methods, JSON request/response bodies.
3. **Pagination**: List endpoints support `?page=` and `?limit=` query params. Responses include `total`, `page`, and `lastPage`.
4. **Error Handling**: Errors return `{ statusCode, message, error }`. Handle 401 (token expired), 403 (forbidden), 429 (rate limited).
5. **Webhooks**: Register webhook endpoints via the API to receive real-time event notifications (ticket scans, payments, check-ins).
6. **Rate Limits**: 100 req/min per API key. Use exponential backoff on 429 responses.
## Key Resources
- **Events**: /events — create, manage, and query events.
- **Tickets**: /tickets — issue, validate, and scan tickets.
- **Payments**: /payments — process and track transactions.
- **Visitors**: /visitors — attendee profiles and wallet data.
- **Coupons**: /coupons — create and redeem discount codes.
- **Organizations**: /organizations — manage org settings and team members.
## Key Terminology
- **Visitor App**: The mobile wallet for attendees.
- **Crew App**: POS and access control for staff.
- **Backstage**: The organizer dashboard.获取 CHI 活动以在您的平台上展示。我们提供多种 Feed 格式和专用的 AI 上下文文件供聚合器使用。
适用于现代应用和 API 的结构化 JSON
https://api.chi.app/feeds/events.jsonfetch('https://api.chi.app/feeds/events.json')
.then(res => res.json())
.then(data => {
console.log(data.items);
});
// Organization-scoped
fetch('https://api.chi.app/feeds/organizations/{orgId}/events.json')
// Single event JSON-LD
fetch('https://api.chi.app/feeds/events/{eventId}.json')Our API is currently available by invitation only. We're working to open access to everyone in the near future.