CHI þróunarvettvangur

v1.0.0 • OAS 3.0 • Staging

Fyrstu skref

Þetta API veitir endapunkta til að stýra viðburðum, miðum, fyrirtækjum, greiðslum og notandareikningum. Samþættu CHI þjónustur í forritin þín og byggðu ofan á CHI vistkerfið.

Staging umhverfi

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

Pagination

GET /events?page=1&limit=20

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

Auðkenning

Flestir endapunktar krefjast auðkenningar með Bearer token. Settu JWT tókann í Authorization hausinn:

Authentication

Authorization: Bearer <your-token>

# Example request
curl -X GET https://api.chi.app/events \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json"

Webhooks

Skráðu webhook endapunkta í gegnum API-ið til að fá rauntímatilkynningar um miðaskannanir, greiðslur og innritun.

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

Notaðu opinberu pakkana okkar til að samþætta við CHI vettvanginn á því forritunarmáli sem þú kýst.

MCP Server

Væntanlegt

Ekki tiltækt enn — CHI MCP-þjónninn er enn í þróun.

REST API

OpenAPI 3.0

Ekki birt enn — aðgangur að API er eingöngu með boði eins og er.

React Storefront SDK

Beta · @chi-ecosystem/storefront-react

Build a full event storefront — live ticket pricing, cart and checkout — without touching REST endpoints, auth, retries, rate limits or data normalization. CHI owns the commerce behavior; you own the visual experience. Ships as headless React hooks plus optional components with zero CSS, so your design system stays yours. Lineup hooks arrive together with the public lineup API.

Install (GitHub Packages registry required for the @chi-ecosystem scope)

npm install @chi-ecosystem/storefront-react @tanstack/react-query

# .npmrc - GitHub Packages auth for the @chi-ecosystem scope
@chi-ecosystem:registry=https://npm.pkg.github.com

Lineup + live tickets in ~20 lines

import {
  ChiStorefrontProvider,
  useTicketDefinitions,
  useQuote,
  formatMoney,
  money,
} from '@chi-ecosystem/storefront-react';

// Once, at the root - CHI handles auth, caching, retries,
// outage healing and quote rate-limit budgets from here on.
<ChiStorefrontProvider eventSlug="your-festival" baseUrl="production">
  <App />
</ChiStorefrontProvider>;

function Tickets() {
  const { definitions } = useTicketDefinitions();   // live prices + stock
  const [lines, setLines] = useState([]);           // your cart UI state
  const { quote } = useQuote({ lines });            // debounced + deduped

  return (
    <div className="my-tickets">                    {/* your CSS, your rules */}
      {definitions.map((d) => (
        <button key={d.id} onClick={() => addLine(setLines, d)}>
          {d.name} - {formatMoney(money(d.priceMinor, d.currency))}
        </button>
      ))}
      <Total>{formatMoney(money(quote?.pricing.totalMinor ?? 0, quote?.pricing.currency ?? 'USD'))}</Total>
    </div>
  );
}

Villur

Villur skila JSON hlut með statusCode, message og error reitum. Meðhöndlaðu 401 (tóki útrunninn), 403 (ekki heimilt) og 429 (of margar fyrirspurnir).

Error Response

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

Kóði	Merking	Aðgerð
400	Ógild beiðni	Athugaðu meginmál beiðni og færibreytur
401	Óheimilt	Tóki útrunninn — endurnýjaðu og reyndu aftur
403	Bannað	Ófullnægjandi heimildir fyrir þessa auðlind
429	Fjöldatakmörkun	Dragðu úr tíðni með veldisvaxandi töf
500	Vefþjónsvilla	Reyndu aftur síðar eða hafðu samband við þjónustuver

Hraðatakmörk

100 fyrirspurnir á mínútu fyrir hvern API lykil. Notaðu veldisvaxandi töf við 429 svörun.

Þrep	Tíðni	Álagstoppur
Staðlað	100 req/min	20 req/s
Fyrirtæki	1000 req/min	100 req/s

Samþætting LLM og gervigreindarumboðsmanna

Staðlaðar samhengisskrár

Við bjóðum upp á staðlaðar samhengisskrár í samræmi við llms.txt staðalinn. Vísaðu gervigreindarumboðsmönnum þínum á þessar vefslóðir til að hlaða strax inn öllu samhengi CHI vistkerfisins.

Færni fyrir umboðsmenn

Kerfisskipun fyrir umboðsmann (agent.md)

Til að gefa kóðunaraðstoðarmanninum þínum (Cursor, Windsurf, Copilot) fulla vitneskju um CHI vettvanginn skaltu búa til agent.md skrá í rót verkefnisins og líma eftirfarandi blokk inn. Þetta tryggir að gervigreindin fylgi hönnunartáknum okkar og API mynstrum.

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://api.staging.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
- Yfirlit fyrir forritara: https://chi.app/is/developers
- Samhengi fyrir miðlunaraðila: https://chi.app/llms-aggregators.txt
- Ekki birt enn — aðgangur að API er eingöngu með boði eins og er.
- MCP Server: Ekki tiltækt enn — CHI MCP-þjónninn er enn í þróun.

## 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.

Viðburðasafnarar

Sæktu CHI viðburði til að birta á þínum vettvangi. Við bjóðum upp á mörg straumsnið og sérstaka AI samhengisskrá fyrir söfnunarþjónustur.

JSON straumur

GET /feeds/events.json

Skipulagt JSON fyrir nútímaleg forrit og 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 fyrir miðlunaraðila

/llms-aggregators.txt

Sérstök samhengisskrá sem hjálpar AI-drifnum miðlunaraðilum að skilja gagnaskipulag CHI viðburða

Samstarf við miðlunaraðila

Fáðu þóknun fyrir hverja miðasölu sem kemur frá appinu þínu eða vettvangi. Hafðu samband við okkur til að taka þátt í samstarfsáætlun okkar fyrir miðlunaraðila og fáðu umbun fyrir að auka sölu.

Hafa samband

API aðgangur — Aðeins með boði

API-ið okkar er sem stendur eingöngu aðgengilegt með boði. Við vinnum að því að opna aðgang fyrir alla á næstunni.