KyaniteAPI Overview
Summary
Section titled “Summary”KyaniteAPI is an event ingestion and processing API. It accepts events over HTTPS, validates requests, and queues accepted events for downstream processing so client interactions can remain responsive under load.
The big picture
Section titled “The big picture”In a typical setup, a client sends an event to KyaniteAPI instead of writing directly to a primary database or triggering expensive work inline. KyaniteAPI acknowledges accepted events (commonly with 202 Accepted) and processes them asynchronously.
This pattern helps you:
- decouple client requests from backend work
- smooth traffic spikes
- standardize validation and delivery behavior
Core capabilities
Section titled “Core capabilities”- Schema validation: Validate incoming payloads against JSON schemas (if configured).
- Asynchronous ingestion: Accept events quickly and process them outside the request/response cycle.
- Queued processing: Buffer events for downstream workers and delivery mechanisms (for example, internal processors or webhooks).
High-level architecture
Section titled “High-level architecture”| Component | Role | Description |
|---|---|---|
| Edge gateway | Security | Terminates TLS, authenticates requests, and applies basic request checks. |
| Ingest API | Ingestion | Receives events and performs request-level validation. |
| Queue | Buffering | Stores accepted events for asynchronous processing. |
| Workers | Processing | Consumes queued events, applies business rules, and triggers downstream actions. |
| Delivery (optional) | Integration | Sends events to external systems (for example, webhooks) when enabled. |
Typical request flow
Section titled “Typical request flow”- Client sends an event to
POST /v1/eventswithAuthorization: Bearer <API_KEY>. - KyaniteAPI validates the request (and schema, if configured).
- If accepted, KyaniteAPI acknowledges the request and queues the event.
- Workers process the event asynchronously and optionally deliver it to downstream systems.