SEAM API provides a secure, modular backend service that handles user authentication, fine-grained role and permission management, and real-time progress notifications via Socket.IO. It is designed to serve as the backend for web applications that require per-user authorization and live UI updates.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/TheSerchCp/SEAM-API/llms.txt
Use this file to discover all available pages before exploring further.
Quickstart
Set up and make your first authenticated API call in minutes.
Configuration
Configure environment variables, database, JWT, and CORS settings.
Authentication
Learn how JWT tokens are issued, verified, and used across every request.
API Reference
Explore every endpoint with request schemas, response shapes, and examples.
What SEAM API Provides
SEAM API ships with five resource modules and a Socket.IO integration out of the box:Auth
Register and log in users, issuing signed JWTs with embedded role data.
Users
List, fetch, update, and delete user accounts with role-based guard middleware.
Roles
Create and manage roles that control which actions a user can perform.
Permissions
Define URI-based permissions and assign them to roles with precision.
Sidebar
Manage dynamic navigation items scoped per role — returned at login.
Real-Time Events
Receive live operation progress and data change events via Socket.IO.
Get Started
Configure your environment
Create a
.env file with your database credentials, JWT secret, and port. See Configuration for all available variables.Start the server
Run
npm run dev for development or npm start for production. The API is available at http://localhost:{PORT}/api/v1.