Платформа разработчиков CHI

v1.0.0 • OAS 3.0 • Staging

Начало работы

Этот API предоставляет эндпоинты для управления мероприятиями, билетами, организациями, платежами и аккаунтами пользователей. Интегрируй сервисы CHI в свои приложения и строй на основе экосистемы CHI.

Тестовая среда

Base URL: https://api.staging.chi.app

Pagination

GET /events?page=1&limit=20

{
  "data": [...],
  "total": 156,
  "page": 1,
  "lastPage": 8
}

Аутентификация

Большинство эндпоинтов требуют Bearer-токен аутентификации. Включи JWT-токен в заголовок Authorization:

Authentication

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"

Webhooks

Зарегистрируйте webhook-эндпоинты через API для получения уведомлений в реальном времени о сканировании билетов, платежах и регистрациях.

Webhook Payload

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"
  }
}

SDK

Используйте наши официальные пакеты для интеграции платформы CHI на вашем предпочтительном языке.

MCP Сервер

npm

npx @chi-app/mcp-server connect

REST API

OpenAPI 3.0

https://api.staging.chi.app/docs-json

Ошибки

Ошибки возвращают JSON-объект с полями statusCode, message и error. Обрабатывайте 401 (токен истёк), 403 (запрещено) и 429 (ограничение частоты).

Error Response

{
  "statusCode": 401,
  "message": "Unauthorized",
  "error": "Token expired"
}

Код	Значение	Действие
400	Неверный запрос	Проверьте тело запроса и параметры
401	Не авторизован	Токен истёк — обновите и повторите
403	Запрещено	Недостаточно прав для этого ресурса
429	Ограничение частоты	Отступите с экспоненциальной задержкой
500	Ошибка сервера	Повторите позже или обратитесь в поддержку

Лимиты запросов

100 запросов в минуту на один API-ключ. Используйте экспоненциальный backoff при ответах 429.

Уровень	Частота	Пиковая нагрузка
Стандартный	100 req/min	20 req/s
Корпоративный	1000 req/min	100 req/s

Интеграция LLM и агентов

Стандартные контекстные файлы

Мы предоставляем стандартизированные контекстные файлы в соответствии со спецификацией llms.txt. Направьте ваших AI-агентов на эти URL для мгновенной загрузки полного контекста экосистемы CHI.

Системный промпт агента (agent.md)

Чтобы дать вашему помощнику по программированию (Cursor, Windsurf, Copilot) полное представление о платформе CHI, создайте файл agent.md в корне проекта и вставьте следующий блок. Это гарантирует, что ИИ будет следовать нашим дизайн-токенам и шаблонам API.

agent.md

# 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 для отображения на вашей платформе. Мы предоставляем несколько форматов фидов и специальный файл контекста ИИ для агрегаторов.

JSON-фид

GET /feeds/events.json

Структурированный JSON для современных приложений и API

https://api.chi.app/feeds/events.json

Example

fetch('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')

LLMs.txt для агрегаторов

/llms-aggregators.txt

Специальный контекстный файл для агрегаторов на базе ИИ для понимания структур данных мероприятий CHI

Партнёрство агрегаторов

Зарабатывайте комиссионные с каждой продажи билетов, пришедшей с вашего приложения или платформы. Свяжитесь с нами, чтобы присоединиться к нашей партнёрской программе для агрегаторов.

Связаться с нами

API Access — Invite Only

Our API is currently available by invitation only. We're working to open access to everyone in the near future.