ChatMinder API Documentation
Welcome to the ChatMinder API! This comprehensive guide helps you integrate with our supervised communication platform designed for protected users (such as minors or individuals requiring supervision).
Core Platform Philosophy
ChatMinder is built with a "supervision without obstruction" approach:
- Immediate Capability: When users receive permission, they can communicate right away
- Natural Flow: System behavior matches real-world permission models
- Personal Address Books: Users can organize their network with meaningful contact names
- Safety First: Comprehensive supervision without hindering legitimate communication
Quick Start
- Authentication: Set up JWT or cookie-based authentication
- Protection Levels: Configure appropriate supervision levels for your users
- API Integration: Start with basic endpoints for users and channels
- Real-time Features: Integrate SignalR for live messaging
What's in This Documentation
- Core Concepts: Understanding protection levels and user types
- Authentication Guide: Setting up secure API access
- Protected User Management: Guardian relationships and supervision workflows
- Real-time Features: SignalR and event-driven architecture
- Error Handling: Comprehensive error codes and recovery patterns
- Walkthroughs: Complete scenarios with protection level workflows
- Architecture Guide: Understanding the modular design
Key Features
🛡️ Protection System
Three configurable protection levels that determine supervision requirements for channel creation, membership, and messaging.
🔄 Real-time Communication
Built on SignalR with comprehensive event-driven architecture for instant updates.
🏗️ Modular Architecture
Clean separation of concerns with domain-specific modules and cross-cutting services.
📱 Flexible Client Support
REST APIs with optional real-time features that work with any client technology.
Getting Help
- API Explorer: Use the built-in Swagger documentation for interactive testing
- GitHub Issues: Report bugs or request features
- Documentation: Comprehensive guides for all aspects of the platform