Getting Started
Learn how Seuraa connects your backend and application users.
Introduction
Seuraa delivers application events to connected users over channels.
Your backend controls identity and access. It authenticates users, chooses the channels they may access, and issues short-lived channel tokens. Client applications use those tokens to subscribe and, when permitted, publish events.
Core Concepts
| Concept | Description |
|---|---|
| App | An isolated Seuraa tenant identified by an app key. |
| Channel | A named stream of events within an app. |
| Event | A named JSON payload published to a channel. |
| Channel token | A short-lived credential granting a user specific channel permissions. |
| Presence | Live membership information for a presence:* channel. |
Application Flow
- A user signs in to your application.
- The browser subscribes to a channel.
- The Seuraa client requests a channel token from your backend.
- Your backend authorizes the user and signs the token.
- Seuraa validates the token and connects the user to the channel.
- Events published to the channel are delivered to its subscribers.
Install
Seuraa SDK packages are available to early-access accounts. Use the package version supplied with your account.
pnpm add @seuraa/edgeThe package provides separate browser and backend entrypoints:
import { Client } from "@seuraa/edge/browser";
import { Client } from "@seuraa/edge/backend";Keep the backend entrypoint and your app secret in trusted code.