Plataforma de desarrolladores CHI

v1.0.0 • OAS 3.0 • Staging

Primeros pasos

Esta API proporciona endpoints para gestionar eventos, entradas, organizaciones, pagos y cuentas de usuario. Integra los servicios de CHI en tus apps y construye sobre el ecosistema CHI.

Entorno de staging

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

Pagination

GET /events?page=1&limit=20

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

Autenticacion

La mayoria de los endpoints requieren autenticacion Bearer token. Incluye el token JWT en el header de autorizacion:

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

Registre endpoints de webhook a través de la API para recibir notificaciones en tiempo real de escaneos de tickets, pagos y check-ins.

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

SDKs

Use nuestros paquetes oficiales para integrar la plataforma CHI en su lenguaje preferido.

Servidor MCP

npm

npx @chi-app/mcp-server connect

REST API

OpenAPI 3.0

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

Errores

Los errores devuelven un objeto JSON con campos statusCode, message y error. Maneje 401 (token expirado), 403 (prohibido) y 429 (límite de tasa).

Error Response

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

Código	Significado	Acción
400	Solicitud Incorrecta	Verifique el cuerpo de la solicitud y los parámetros
401	No Autorizado	Token expirado — actualice y reintente
403	Prohibido	Permisos insuficientes para este recurso
429	Límite de Tasa	Retroceda con retraso exponencial
500	Error del Servidor	Reintente más tarde o contacte soporte

Limites de solicitudes

100 solicitudes por minuto por clave de API. Use backoff exponencial en respuestas 429.

Nivel	Tasa	Ráfaga
Estándar	100 req/min	20 req/s
Enterprise	1000 req/min	100 req/s

Integración de LLM y Agentes

Archivos de Contexto Estándar

Proporcionamos archivos de contexto estandarizados conforme a la especificación llms.txt. Apunte sus agentes de IA a estas URLs para cargar instantáneamente el contexto completo del ecosistema CHI.

Prompt del Sistema del Agente (agent.md)

Para dar a su asistente de codificación (Cursor, Windsurf, Copilot) conocimiento completo de la plataforma CHI, cree un archivo agent.md en la raíz de su proyecto y pegue el siguiente bloque. Esto asegura que la IA siga nuestros tokens de diseño y patrones de 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.

Agregadores de Eventos

Obtén eventos de CHI para mostrarlos en tu plataforma. Proporcionamos múltiples formatos de feed y un archivo de contexto IA dedicado para agregadores.

Feed JSON

GET /feeds/events.json

JSON estructurado para aplicaciones y APIs modernas

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 para Agregadores

/llms-aggregators.txt

Archivo de contexto dedicado para agregadores con IA para comprender las estructuras de datos de eventos CHI

Programa de Socios Agregadores

Gana comisiones por cada venta de entradas que provenga de tu app o plataforma. Contáctanos para unirte a nuestro programa de socios agregadores y ser recompensado por impulsar ventas.

Contáctanos

API Access — Invite Only

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