CHI Developer Platform

v1.0.0 • OAS 3.0 • Staging

Mulai

API ini menyediakan endpoint untuk mengelola event, tiket, organisasi, pembayaran, dan akun pengguna. Integrasikan layanan CHI ke dalam aplikasi Anda dan bangun di atas ekosistem CHI.

Lingkungan Staging

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

Pagination

GET /events?page=1&limit=20

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

Autentikasi

Sebagian besar endpoint memerlukan autentikasi Bearer token. Sertakan token JWT di header 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

Daftarkan endpoint webhook melalui API untuk menerima notifikasi event real-time untuk pemindaian tiket, pembayaran, dan check-in.

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

Gunakan paket resmi kami untuk mengintegrasikan platform CHI dalam bahasa pilihan Anda.

Server MCP

npm

npx @chi-app/mcp-server connect

REST API

OpenAPI 3.0

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

Error

Error mengembalikan objek JSON dengan field statusCode, message, dan error. Tangani 401 (token kedaluwarsa), 403 (dilarang), dan 429 (batas laju).

Error Response

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

Kode	Arti	Tindakan
400	Permintaan Buruk	Periksa body permintaan dan parameter
401	Tidak Terotorisasi	Token kedaluwarsa — perbarui dan coba lagi
403	Dilarang	Izin tidak mencukupi untuk sumber daya ini
429	Batas Laju	Mundur dengan penundaan eksponensial
500	Error Server	Coba lagi nanti atau hubungi dukungan

Rate Limits

100 permintaan per menit per kunci API. Gunakan backoff eksponensial pada respons 429.

Tingkat	Laju	Burst
Standar	100 req/min	20 req/s
Enterprise	1000 req/min	100 req/s

Integrasi LLM & Agen

File Konteks Standar

Kami menyediakan file konteks terstandarisasi yang sesuai dengan spesifikasi llms.txt. Arahkan agen AI Anda ke URL ini untuk memuat konteks lengkap ekosistem CHI secara instan.

Prompt Sistem Agen (agent.md)

Untuk memberikan asisten pengkodean Anda (Cursor, Windsurf, Copilot) kesadaran penuh tentang platform CHI, buat file agent.md di root proyek Anda dan tempel blok berikut. Ini memastikan AI mengikuti token desain dan pola API kami.

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.

Agregator Event

Ambil event CHI untuk ditampilkan di platform Anda. Kami menyediakan beberapa format feed dan file konteks AI khusus untuk agregator.

Feed JSON

GET /feeds/events.json

JSON terstruktur untuk aplikasi dan API modern

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 Agregator

/llms-aggregators.txt

File konteks khusus untuk agregator bertenaga AI untuk memahami struktur data event CHI

Kemitraan Agregator

Dapatkan komisi untuk setiap penjualan tiket yang datang dari aplikasi atau platform Anda. Hubungi kami untuk bergabung dengan program kemitraan agregator dan dapatkan imbalan.

Hubungi Kami

API Access — Invite Only

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